Skip to content

arm-custom-resource-no-key

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

Validate that custom resource contains a key property.

Without a key, operation paths may be duplicated.

Impact

Section titled “Impact”
  • Area: API, SDK

Mainly a correctness issue: the resource’s name property should be marked with @key.

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

Suppression

Section titled “Suppression”

Suppress only when required to match an existing API; otherwise add @key to the name parameter of the resource.