Skip to content

arm-resource-path-segment-invalid-chars

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

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

❌ Incorrect

Section titled “❌ Incorrect”
model FooResource is TrackedResource<{}> {
  ...ResourceNameParameter<FooResource, SegmentName = "/foo/bar">;
}

✅ Correct

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

Reviewer advice

Section titled “Reviewer advice”

Impacts the API and generated SDKs: invalid segment characters produce invalid ARM API paths and invalid client parameter names. Ask the author to fix the segment or use the correct name in @key so the path segment uses only valid characters. Do not accept a suppression.