Updating ProvisioningState from enum to union (#521)

1. Updated ARM lib default `ResourceProvisioningState` to union 2. Updated samples `enum ProvisioningState` to union 3. Updated @lroStatus to support nested union ProvisioningState
Azure · Apr 17, 2024 · 0162292 · 0162292
1 parent 6a59458
commit 0162292
Show file tree

Hide file tree

Showing 19 changed files with 550 additions and 139 deletions.
diff --git a/.chronus/changes/azhang_ProvisioningStateToUnion-2024-2-26-12-58-44.md b/.chronus/changes/azhang_ProvisioningStateToUnion-2024-2-26-12-58-44.md
@@ -0,0 +1,8 @@
+---
+changeKind: breaking
+packages:
+  - "@azure-tools/typespec-azure-core"
+  - "@azure-tools/typespec-azure-resource-manager"
+---
+
+Switching ProvisioningState from enum to Open union 
diff --git a/docs/getstarted/azure-resource-manager/step05.md b/docs/getstarted/azure-resource-manager/step05.md
@@ -39,12 +39,22 @@ namespace Microsoft.ContosoProviderHub;
 interface Operations extends Azure.ResourceManager.Operations {}
 
 @lroStatus
-enum ProvisioningState {
-  ...ResourceProvisioningState,
-  Provisioning,
-  Updating,
-  Deleting,
-  Accepted,
+union ProvisioningState {
+  ResourceProvisioningState,
+
+  /** The resource is being provisioned. */
+  Provisioning: "Provisioning",
+
+  /** The resource is being updated. */
+  Updating: "Updating",
+
+  /** The resource is being deleted. */
+  Deleting: "Deleting",
+
+  /** The resource provisioning request has been accepted. */
+  Accepted: "Accepted",
+
+  string,
 }
 
 @doc("The properties of UserResource")

diff --git a/docs/libraries/azure-resource-manager/reference/data-types.md b/docs/libraries/azure-resource-manager/reference/data-types.md
@@ -1074,65 +1074,65 @@ model Azure.ResourceManager.TrackedResource<Properties>
 | ----------- | ------------ | ----------- |
 | properties? | `Properties` |             |
 
-### `PrivateEndpointConnectionProvisioningState` {#Azure.ResourceManager.PrivateEndpointConnectionProvisioningState}
+### `Versions` {#Azure.ResourceManager.Versions}
 
-The provisioning state of the connection
+Supported versions of Azure.ResourceManager building blocks.
 
 ```typespec
-enum Azure.ResourceManager.PrivateEndpointConnectionProvisioningState
+enum Azure.ResourceManager.Versions
 ```
 
-### `PrivateEndpointServiceConnectionStatus` {#Azure.ResourceManager.PrivateEndpointServiceConnectionStatus}
+### `InfrastructureEncryption` {#Azure.ResourceManager.InfrastructureEncryption}
 
-The private endpoint connection status
+(Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled.
 
 ```typespec
-enum Azure.ResourceManager.PrivateEndpointServiceConnectionStatus
+union Azure.ResourceManager.InfrastructureEncryption
 ```
 
-### `ResourceProvisioningState` {#Azure.ResourceManager.ResourceProvisioningState}
+### `KeyEncryptionKeyIdentity` {#Azure.ResourceManager.KeyEncryptionKeyIdentity}
 
-Standard terminal provisioning state of resource type. You can spread into your
-custom provision state to avoid duplication and ensure consistency
+The type of identity to use.
 
 ```typespec
-enum Azure.ResourceManager.ResourceProvisioningState
+union Azure.ResourceManager.KeyEncryptionKeyIdentity
 ```
 
-#### Examples
+### `PrivateEndpointConnectionProvisioningState` {#Azure.ResourceManager.PrivateEndpointConnectionProvisioningState}
+
+The provisioning state of the connection
 
 ```typespec
-enum FooProvisioningState {
-  ...ResourceProvisioningState, // include standard provisioning states
-  starting,
-  started,
-  stopping,
-  stopped,
-}
+union Azure.ResourceManager.PrivateEndpointConnectionProvisioningState
 ```
 
-### `Versions` {#Azure.ResourceManager.Versions}
+### `PrivateEndpointServiceConnectionStatus` {#Azure.ResourceManager.PrivateEndpointServiceConnectionStatus}
 
-Supported versions of Azure.ResourceManager building blocks.
+The private endpoint connection status
 
 ```typespec
-enum Azure.ResourceManager.Versions
+union Azure.ResourceManager.PrivateEndpointServiceConnectionStatus
 ```
 
-### `InfrastructureEncryption` {#Azure.ResourceManager.InfrastructureEncryption}
+### `ResourceProvisioningState` {#Azure.ResourceManager.ResourceProvisioningState}
 
-(Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled.
+Standard terminal provisioning state of resource type. You can include in your
+custom provision state to avoid duplication and ensure consistency
 
 ```typespec
-union Azure.ResourceManager.InfrastructureEncryption
+union Azure.ResourceManager.ResourceProvisioningState
 ```
 
-### `KeyEncryptionKeyIdentity` {#Azure.ResourceManager.KeyEncryptionKeyIdentity}
-
-The type of identity to use.
+#### Examples
 
 ```typespec
-union Azure.ResourceManager.KeyEncryptionKeyIdentity
+union FooProvisioningState {
+  ResourceProvisioningState, // include standard provisioning states
+  starting: "starting",
+  started: "started",
+  stopping: "stopping",
+  stopped: "stopped",
+}
 ```
 
 ## Azure.ResourceManager.CommonTypes

diff --git a/eng/feeds/arm-canonical/employee.tsp b/eng/feeds/arm-canonical/employee.tsp
@@ -39,20 +39,22 @@ model EmployeeProperties {
 
 /** The resource provisioning state. */
 @lroStatus
-enum ProvisioningState {
-  ...ResourceProvisioningState,
+union ProvisioningState {
+  ResourceProvisioningState,
 
   /** The resource is being provisioned. */
-  Provisioning,
+  Provisioning: "Provisioning",
 
   /** The resource is being updated. */
-  Updating,
+  Updating: "Updating",
 
   /** The resource is being deleted. */
-  Deleting,
+  Deleting: "Deleting",
 
   /** The resource provisioning request has been accepted. */
-  Accepted,
+  Accepted: "Accepted",
+
+  string,
 }
 
 interface Operations extends Azure.ResourceManager.Operations {}

diff --git a/eng/feeds/arm/employee.tsp b/eng/feeds/arm/employee.tsp
@@ -39,20 +39,22 @@ model EmployeeProperties {
 
 /** The resource provisioning state. */
 @lroStatus
-enum ProvisioningState {
-  ...ResourceProvisioningState,
+union ProvisioningState {
+  ResourceProvisioningState,
 
-  /** The resource is being provisioned. */
-  Provisioning,
+  /** The resource is being provisioned */
+  Provisioning: "Provisioning",
 
-  /** The resource is being updated. */
-  Updating,
+  /** The resource is updating */
+  Updating: "Updating",
 
-  /** The resource is being deleted. */
-  Deleting,
+  /** The resource is being deleted */
+  Deleting: "Deleting",
 
-  /** The resource provisioning request has been accepted. */
-  Accepted,
+  /** The resource create request has been accepted */
+  Accepted: "Accepted",
+
+  string,
 }
 
 interface Operations extends Azure.ResourceManager.Operations {}

diff --git a/packages/samples/specs/resource-manager/arm-scenarios/extension-resource/main.tsp b/packages/samples/specs/resource-manager/arm-scenarios/extension-resource/main.tsp
@@ -49,20 +49,22 @@ model RoleAssignmentProperties {
 
 /** The provisioning state of a resource. */
 @lroStatus
-enum ProvisioningState {
-  ...ResourceProvisioningState,
+union ProvisioningState {
+  ResourceProvisioningState,
 
   /** The resource is being provisioned */
-  Provisioning,
+  Provisioning: "Provisioning",
 
   /** The resource is updating */
-  Updating,
+  Updating: "Updating",
 
   /** The resource is being deleted */
-  Deleting,
+  Deleting: "Deleting",
 
   /** The resource create request has been accepted */
-  Accepted,
+  Accepted: "Accepted",
+
+  string,
 }
 
 interface Operations extends Azure.ResourceManager.Operations {}

diff --git a/packages/samples/specs/resource-manager/arm-scenarios/location-resource/main.tsp b/packages/samples/specs/resource-manager/arm-scenarios/location-resource/main.tsp
@@ -56,20 +56,22 @@ model EmployeeProperties {
 
 /** The provisioning state of a resource. */
 @lroStatus
-enum ProvisioningState {
-  ...ResourceProvisioningState,
+union ProvisioningState {
+  ResourceProvisioningState,
 
   /** The resource is being provisioned */
-  Provisioning,
+  Provisioning: "Provisioning",
 
   /** The resource is updating */
-  Updating,
+  Updating: "Updating",
 
   /** The resource is being deleted */
-  Deleting,
+  Deleting: "Deleting",
 
   /** The resource create request has been accepted */
-  Accepted,
+  Accepted: "Accepted",
+
+  string,
 }
 
 interface Operations extends Azure.ResourceManager.Operations {}

diff --git a/packages/samples/specs/resource-manager/arm-scenarios/nobody-action/main.tsp b/packages/samples/specs/resource-manager/arm-scenarios/nobody-action/main.tsp
@@ -55,20 +55,22 @@ model EmployeeProperties {
 
 /** The provisioning state of a resource. */
 @lroStatus
-enum ProvisioningState {
-  ...ResourceProvisioningState,
+union ProvisioningState {
+  ResourceProvisioningState,
 
   /** The resource is being provisioned */
-  Provisioning,
+  Provisioning: "Provisioning",
 
   /** The resource is updating */
-  Updating,
+  Updating: "Updating",
 
   /** The resource is being deleted */
-  Deleting,
+  Deleting: "Deleting",
 
   /** The resource create request has been accepted */
-  Accepted,
+  Accepted: "Accepted",
+
+  string,
 }
 
 interface Operations extends Azure.ResourceManager.Operations {}

diff --git a/packages/samples/specs/resource-manager/arm-scenarios/proxy/main.tsp b/packages/samples/specs/resource-manager/arm-scenarios/proxy/main.tsp
@@ -57,20 +57,22 @@ model EmployeeProperties {
 
 /** The provisioning state of a resource. */
 @lroStatus
-enum ProvisioningState {
-  ...ResourceProvisioningState,
+union ProvisioningState {
+  ResourceProvisioningState,
 
   /** The resource is being provisioned */
-  Provisioning,
+  Provisioning: "Provisioning",
 
   /** The resource is updating */
-  Updating,
+  Updating: "Updating",
 
   /** The resource is being deleted */
-  Deleting,
+  Deleting: "Deleting",
 
   /** The resource create request has been accepted */
-  Accepted,
+  Accepted: "Accepted",
+
+  string,
 }
 
 interface Operations extends Azure.ResourceManager.Operations {}

diff --git a/packages/samples/specs/resource-manager/arm-scenarios/singleton/main.tsp b/packages/samples/specs/resource-manager/arm-scenarios/singleton/main.tsp
@@ -55,20 +55,22 @@ model EmployeeProperties {
 
 /** The provisioning state of a resource. */
 @lroStatus
-enum ProvisioningState {
-  ...ResourceProvisioningState,
+union ProvisioningState {
+  ResourceProvisioningState,
 
   /** The resource is being provisioned */
-  Provisioning,
+  Provisioning: "Provisioning",
 
   /** The resource is updating */
-  Updating,
+  Updating: "Updating",
 
   /** The resource is being deleted */
-  Deleting,
+  Deleting: "Deleting",
 
   /** The resource create request has been accepted */
-  Accepted,
+  Accepted: "Accepted",
+
+  string,
 }
 
 interface Operations extends Azure.ResourceManager.Operations {}

diff --git a/packages/samples/specs/resource-manager/arm-scenarios/tenant/main.tsp b/packages/samples/specs/resource-manager/arm-scenarios/tenant/main.tsp
@@ -56,20 +56,22 @@ model EmployeeProperties {
 
 /** The provisioning state of a resource. */
 @lroStatus
-enum ProvisioningState {
-  ...ResourceProvisioningState,
+union ProvisioningState {
+  ResourceProvisioningState,
 
   /** The resource is being provisioned */
-  Provisioning,
+  Provisioning: "Provisioning",
 
   /** The resource is updating */
-  Updating,
+  Updating: "Updating",
 
   /** The resource is being deleted */
-  Deleting,
+  Deleting: "Deleting",
 
   /** The resource create request has been accepted */
-  Accepted,
+  Accepted: "Accepted",
+
+  string,
 }
 
 interface Operations extends Azure.ResourceManager.Operations {}

diff --git a/packages/samples/specs/resource-manager/arm-scenarios/tracked/main.tsp b/packages/samples/specs/resource-manager/arm-scenarios/tracked/main.tsp
@@ -55,20 +55,22 @@ model EmployeeProperties {
 
 /** The provisioning state of a resource. */
 @lroStatus
-enum ProvisioningState {
-  ...ResourceProvisioningState,
+union ProvisioningState {
+  ResourceProvisioningState,
 
   /** The resource is being provisioned */
-  Provisioning,
+  Provisioning: "Provisioning",
 
   /** The resource is updating */
-  Updating,
+  Updating: "Updating",
 
   /** The resource is being deleted */
-  Deleting,
+  Deleting: "Deleting",
 
   /** The resource create request has been accepted */
-  Accepted,
+  Accepted: "Accepted",
+
+  string,
 }
 
 interface Operations extends Azure.ResourceManager.Operations {}