Add visibility and optionality for provisioning state & linting rules (…

…#323) Azure/typespec-azure-pr#2638 --------- Co-authored-by: Timothee Guerin <[email protected]>
Azure · Mar 4, 2024 · b6c3bf2 · b6c3bf2
1 parent c032b71
commit b6c3bf2
Show file tree

Hide file tree

Showing 14 changed files with 212 additions and 148 deletions.
diff --git a/.chronus/changes/azhang_provisioningState-2024-1-27-10-36-42.md b/.chronus/changes/azhang_provisioningState-2024-1-27-10-36-42.md
@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-azure-resource-manager"
+---
+
+Adding `@visibility("read")` & optional linting rules linting rules for ARM `provisioningState`
diff --git a/docs/libraries/azure-resource-manager/reference/data-types.md b/docs/libraries/azure-resource-manager/reference/data-types.md
@@ -417,9 +417,9 @@ model FooProperties {
 
 #### Properties
 
-| Name              | Type                                                                                           | Description                             |
-| ----------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------- |
-| provisioningState | [`ResourceProvisioningState`](./data-types.md#Azure.ResourceManager.ResourceProvisioningState) | The provisioning state of the resource. |
+| Name               | Type                                                                                           | Description                             |
+| ------------------ | ---------------------------------------------------------------------------------------------- | --------------------------------------- |
+| provisioningState? | [`ResourceProvisioningState`](./data-types.md#Azure.ResourceManager.ResourceProvisioningState) | The provisioning state of the resource. |
 
 ### `Encryption` {#Azure.ResourceManager.Encryption}
 

diff --git a/docs/libraries/azure-resource-manager/rules/arm-resource-provisioning-state.md b/docs/libraries/azure-resource-manager/rules/arm-resource-provisioning-state.md
@@ -0,0 +1,30 @@
+---
+title: arm-resource-provisioning-state
+---
+
+```text title=- Full name-
+@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 `Canceled`
+
+#### ❌ Incorrect
+
+```tsp
+model ResourceProperties {
+  provisioningState: ResourceProvisioningState;
+}
+```
+
+#### ✅ Correct
+
+```tsp
+model ResourceProperties {
+  @visibility("read")
+  provisioningState?: ResourceProvisioningState;
+}
+```
diff --git a/...est/output/azure/resource-manager/arm-library/@azure-tools/typespec-autorest/openapi.json b/...est/output/azure/resource-manager/arm-library/@azure-tools/typespec-autorest/openapi.json
@@ -1905,12 +1905,12 @@
         },
         "provisioningState": {
           "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
+          "description": "The provisioning state of the resource.",
+          "readOnly": true
         }
       },
       "required": [
-        "flavor",
-        "provisioningState"
+        "flavor"
       ]
     },
     "Microsoft.OperationsTest.TestTrackedProperties2": {

diff --git a/...tput/azure/resource-manager/discriminatortest/@azure-tools/typespec-autorest/openapi.json b/...tput/azure/resource-manager/discriminatortest/@azure-tools/typespec-autorest/openapi.json
@@ -528,13 +528,13 @@
         },
         "provisioningState": {
           "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
+          "description": "The provisioning state of the resource.",
+          "readOnly": true
         }
       },
       "required": [
         "role",
-        "employeeType",
-        "provisioningState"
+        "employeeType"
       ]
     },
     "EmployeeType": {
@@ -588,10 +588,6 @@
         "employeeType": {
           "$ref": "#/definitions/EmployeeType",
           "description": "The HR compensation type of the employee"
-        },
-        "provisioningState": {
-          "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
         }
       }
     },

diff --git a/...output/azure/resource-manager/liftr.confluent/@azure-tools/typespec-autorest/openapi.json b/...output/azure/resource-manager/liftr.confluent/@azure-tools/typespec-autorest/openapi.json
@@ -517,12 +517,10 @@
       "properties": {
         "provisioningState": {
           "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
+          "description": "The provisioning state of the resource.",
+          "readOnly": true
         }
-      },
-      "required": [
-        "provisioningState"
-      ]
+      }
     },
     "MediumString": {
       "type": "string",
@@ -749,15 +747,15 @@
         },
         "provisioningState": {
           "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
+          "description": "The provisioning state of the resource.",
+          "readOnly": true
         }
       },
       "required": [
         "organizationId",
         "ssoUrl",
         "offerDetail",
-        "userDetail",
-        "provisioningState"
+        "userDetail"
       ]
     },
     "OrganizationUpdate": {
@@ -788,10 +786,6 @@
         "userDetail": {
           "$ref": "#/definitions/UserDetailUpdate",
           "description": "Subscriber details."
-        },
-        "provisioningState": {
-          "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
         }
       }
     },

diff --git a/...t/output/azure/resource-manager/liftr.playfab/@azure-tools/typespec-autorest/openapi.json b/...t/output/azure/resource-manager/liftr.playfab/@azure-tools/typespec-autorest/openapi.json
@@ -736,12 +736,12 @@
         },
         "provisioningState": {
           "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
+          "description": "The provisioning state of the resource.",
+          "readOnly": true
         }
       },
       "required": [
-        "userId",
-        "provisioningState"
+        "userId"
       ]
     },
     "PlayerDatabaseReference": {
@@ -788,10 +788,6 @@
           "items": {
             "$ref": "#/definitions/TitleReference"
           }
-        },
-        "provisioningState": {
-          "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
         }
       }
     },
@@ -851,12 +847,12 @@
         },
         "provisioningState": {
           "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
+          "description": "The provisioning state of the resource.",
+          "readOnly": true
         }
       },
       "required": [
-        "parentDatabase",
-        "provisioningState"
+        "parentDatabase"
       ]
     },
     "TitleReference": {
@@ -882,20 +878,6 @@
           "additionalProperties": {
             "type": "string"
           }
-        },
-        "properties": {
-          "$ref": "#/definitions/TitleUpdateProperties",
-          "x-ms-client-flatten": true
-        }
-      }
-    },
-    "TitleUpdateProperties": {
-      "type": "object",
-      "description": "The updatable properties of the Title.",
-      "properties": {
-        "provisioningState": {
-          "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
         }
       }
     }

diff --git a/...mples/test/output/azure/resource-manager/logz/@azure-tools/typespec-autorest/openapi.json b/...mples/test/output/azure/resource-manager/logz/@azure-tools/typespec-autorest/openapi.json
@@ -2095,12 +2095,10 @@
       "properties": {
         "provisioningState": {
           "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
+          "description": "The provisioning state of the resource.",
+          "readOnly": true
         }
-      },
-      "required": [
-        "provisioningState"
-      ]
+      }
     },
     "SubAccountResource": {
       "type": "object",
@@ -2216,12 +2214,10 @@
       "properties": {
         "provisioningState": {
           "$ref": "#/definitions/Azure.ResourceManager.ResourceProvisioningState",
-          "description": "The provisioning state of the resource."
+          "description": "The provisioning state of the resource.",
+          "readOnly": true
         }
-      },
-      "required": [
-        "provisioningState"
-      ]
+      }
     },
     "TagRuleResource": {
       "type": "object",