Skip to content

arm-resource-key-invalid-chars

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

ARM resource key must contain only alphanumeric characters or dashes, starting with a lowercase letter.

❌ 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>;
}

Reviewer advice

Section titled “Reviewer advice”

Impacts generated SDKs: invalid resource key characters can produce invalid keys in SDKs. Ask the author to use the correct name in @key or the ResourceNameParameter template. Do not accept a suppression.