Skip to content

no-reserved-resource-property

Id
@azure-tools/typespec-azure-resource-manager/no-reserved-resource-property

Reserved property names (for example ‘billingData’) must not be present in a resource’s property bag. The property name is matched case-insensitively.

Reserved names are used by the ARM platform and common types; declaring them in RP-specific properties can conflict with standardized behavior.

The property name is matched case-insensitively (billingData, BillingData, billingdata, etc.) and is disallowed regardless of its type (named model reference, inline model, or primitive). The set of reserved names is maintained by the rule.

❌ Incorrect

Section titled “❌ Incorrect”
@armProviderNamespace
namespace MyService;


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


model FooProperties {
  @visibility(Lifecycle.Read)
  provisioningState?: ResourceProvisioningState;


  billingData?: string; // "billingData" is reserved and not allowed in the property bag
}

✅ Correct

Section titled “✅ Correct”
@armProviderNamespace
namespace MyService;


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


model FooProperties {
  @visibility(Lifecycle.Read)
  provisioningState?: ResourceProvisioningState;


  billingInfo?: string;
}