Skip to content

empty-updateable-properties

Id
@azure-tools/typespec-azure-resource-manager/empty-updateable-properties

Should have updateable properties.

The RP-specific properties of the resource (as defined in the properties property) should have at least one updateable property. Properties are updateable if they do not have a @visibility decorator, or if they include Lifecycle.Update in the @visibility decorator arguments.

Impact

Section titled “Impact”
  • Area: API

Covered by the patch-specific rules; indicates the properties bag has no updateable properties.

❌ Incorrect

Section titled “❌ Incorrect”

All properties are read-only:

model FooResourceProperties {
  @visibility(Lifecycle.Read)
  bar?: string;
}

✅ Correct

Section titled “✅ Correct”

At least one property without read-only visibility:

model FooResourceProperties {
  @visibility(Lifecycle.Read)
  provisioningState?: string;


  displayName?: string;
}

Suppression

Section titled “Suppression”

Suppress when required to match an existing API, or when using the Tags patch; otherwise ensure not all properties in the properties bag are updateable.