Skip to content

arm-resource-key-invalid-chars

Id
@azure-tools/typespec-azure-resource-manager/arm-resource-key-invalid-chars

Arm resource key must contain only alphanumeric characters.

Beyond alphanumeric characters, a resource key may also contain dashes, but it must start with a lowercase letter.

Impact

Section titled “Impact”
  • Area: SDK

Invalid characters in a resource key produce invalid parameter names in SDKs.

❌ Incorrect

Section titled “❌ Incorrect”
model Employee is TrackedResource<EmployeeProperties> {
  ...ResourceNameParameter<Employee, KeyName = "employee_name">;
}

✅ Correct

Section titled “✅ Correct”
model Employee is TrackedResource<EmployeeProperties> {
  ...ResourceNameParameter<Employee>;
}

Suppression

Section titled “Suppression”

Do not suppress. Use the correct name in @key or the ResourceNameParameter template.