Skip to content

resource-name

Full name
@azure-tools/typespec-azure-resource-manager/resource-name

Check the resource name. ARM resource model names must contain only alphanumeric characters (starting with an uppercase letter), and the name property must be a read-only @path parameter.

Missing @path decorator on name:

model FooResource is TrackedResource<{}> {
@key("foo")
@segment("foo")
name: string;
}

Underscore in model name:

model Foo_Resource is TrackedResource<{}> {
...ResourceNameParameter<Foo_Resource>;
}
model FooResource is TrackedResource<{}> {
...ResourceNameParameter<FooResource>;
}

Impacts the API and generated SDKs: invalid characters in a resource name violate RPC guidance and can produce invalid client parameter names that block SDK generation. Ask the author to use only valid characters in the resource name. Treat suppressions like any invalid resource name and do not accept them lightly.