arm-resource-provisioning-state

Id

@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state

Check for properly configured provisioningState property.

-

@azure-tools/typespec-azure-resource-manager/arm-resource-provisioning-state

ProvisioningState property of ARM resource must be:

• optional
• readonly
• must at least contain Succeeded, Canceled, and Failed

Impact

• Area: API

A missing or invalid provisioning state violates the RPC and RPaaS contracts.

LintDiff Equivalent

This rule corresponds to the LintDiff rule ProvisioningStateValidation (also ProvisioningStateSpecifiedForLROPut, ProvisioningStateSpecifiedForLROPatch, and RpaaS_ResourceProvisioningState).

❌ Incorrect

model ResourceProperties {
  provisioningState: ResourceProvisioningState;
}

✅ Correct

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

Suppression

Suppress per the RPC guidelines; otherwise define a provisioning state property with Succeeded, Failed, and Canceled states.