Skip to content

arm-custom-resource-no-key

-
@azure-tools/typespec-azure-resource-manager/arm-custom-resource-no-key

Custom Azure resource models must define a key property using the @key decorator, especially if the custom resource will be used in operations. Without a key, operation paths may be duplicated.

❌ Incorrect

Section titled “❌ Incorrect”
@Azure.ResourceManager.Legacy.customAzureResource
model CustomResource {
  someId: string;
}

✅ Correct

Section titled “✅ Correct”
@Azure.ResourceManager.Legacy.customAzureResource
model CustomResource {
  @key
  someId: string;
}

Reviewer advice

Section titled “Reviewer advice”

Impacts the API and generated SDKs: this is mainly a correctness concern because the resource name property should be marked with @key. Ask the author to add @key to the resource name parameter. Suppress only when needed to match an existing API.