Make Resource Properties Bag Updatable (#979)

Azure · Jun 12, 2024 · d30db5b · d30db5b
1 parent fe90e20
commit d30db5b
Show file tree

Hide file tree

Showing 18 changed files with 38 additions and 129 deletions.
diff --git a/.chronus/changes/res-vis-2024-5-12-4-34-46.md b/.chronus/changes/res-vis-2024-5-12-4-34-46.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-azure-resource-manager"
+---
+
+Make Resource Properties Bag Updatable
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
@@ -1660,11 +1660,7 @@
         "properties": {
           "$ref": "#/definitions/AllPropertiesProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         },
         "eTag": {
           "type": "string",
@@ -1822,11 +1818,7 @@
         "properties": {
           "$ref": "#/definitions/Microsoft.InterfacesTest.TestExtensionProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [
@@ -1858,11 +1850,7 @@
         "properties": {
           "$ref": "#/definitions/Microsoft.InterfacesTest.TestTenantProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [
@@ -1878,11 +1866,7 @@
         "properties": {
           "$ref": "#/definitions/Microsoft.InterfacesTest.TrackedChildProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [
@@ -1918,11 +1902,7 @@
         "properties": {
           "$ref": "#/definitions/Microsoft.InterfacesTest.TestTrackedProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [
@@ -1972,11 +1952,7 @@
         "properties": {
           "$ref": "#/definitions/Microsoft.OperationsTest.TestTrackedProperties2",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...es/test/output/azure/resource-manager/contoso/@azure-tools/typespec-autorest/openapi.json b/...es/test/output/azure/resource-manager/contoso/@azure-tools/typespec-autorest/openapi.json
@@ -377,11 +377,7 @@
         "properties": {
           "$ref": "#/definitions/EmployeeProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...r/operations/nobody-action/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...r/operations/nobody-action/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -588,11 +588,7 @@
         "properties": {
           "$ref": "#/definitions/EmployeeProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...operties/common-properties/@azure-tools/typespec-autorest/2023-03-01-preview/openapi.json b/...operties/common-properties/@azure-tools/typespec-autorest/2023-03-01-preview/openapi.json
@@ -447,11 +447,7 @@
         "properties": {
           "$ref": "#/definitions/WidgetResourceProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         },
         "extendedLocation": {
           "$ref": "#/definitions/Azure.ResourceManager.CommonTypes.ExtendedLocation",

diff --git a/...mmon-properties/encryption/@azure-tools/typespec-autorest/2023-03-01-preview/openapi.json b/...mmon-properties/encryption/@azure-tools/typespec-autorest/2023-03-01-preview/openapi.json
@@ -405,11 +405,7 @@
         "properties": {
           "$ref": "#/definitions/WidgetResourceProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...roperties/managed-identity/@azure-tools/typespec-autorest/2023-03-01-preview/openapi.json b/...roperties/managed-identity/@azure-tools/typespec-autorest/2023-03-01-preview/openapi.json
@@ -405,11 +405,7 @@
         "properties": {
           "$ref": "#/definitions/WidgetResourceProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         },
         "identity": {
           "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/managedidentity.json#/definitions/ManagedServiceIdentity",

diff --git a/...n-properties/private-links/@azure-tools/typespec-autorest/2023-08-01-preview/openapi.json b/...n-properties/private-links/@azure-tools/typespec-autorest/2023-08-01-preview/openapi.json
@@ -649,11 +649,7 @@
         "properties": {
           "$ref": "../../../../../../../../../specs/resource-manager/common-types/v4/privatelinks.json#/definitions/PrivateEndpointConnectionProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [
@@ -690,11 +686,7 @@
         "properties": {
           "$ref": "../../../../../../../../../specs/resource-manager/common-types/v4/privatelinks.json#/definitions/PrivateLinkResourceProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [
@@ -759,11 +751,7 @@
         "properties": {
           "$ref": "#/definitions/TestTrackedProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...n-properties/private-links/@azure-tools/typespec-autorest/2023-11-01-preview/openapi.json b/...n-properties/private-links/@azure-tools/typespec-autorest/2023-11-01-preview/openapi.json
@@ -649,11 +649,7 @@
         "properties": {
           "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/privatelinks.json#/definitions/PrivateEndpointConnectionProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [
@@ -690,11 +686,7 @@
         "properties": {
           "$ref": "../../../../../../../../../specs/resource-manager/common-types/v5/privatelinks.json#/definitions/PrivateLinkResourceProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [
@@ -759,11 +751,7 @@
         "properties": {
           "$ref": "#/definitions/TestTrackedProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...r/resource-types/extension/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...r/resource-types/extension/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -402,11 +402,7 @@
         "properties": {
           "$ref": "#/definitions/RoleAssignmentProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...er/resource-types/location/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...er/resource-types/location/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -437,11 +437,7 @@
         "properties": {
           "$ref": "#/definitions/EmployeeProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...nager/resource-types/proxy/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...nager/resource-types/proxy/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -731,11 +731,7 @@
         "properties": {
           "$ref": "#/definitions/DependentProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [
@@ -821,11 +817,7 @@
         "properties": {
           "$ref": "#/definitions/EmployeeProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...r/resource-types/singleton/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...r/resource-types/singleton/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -336,11 +336,7 @@
         "properties": {
           "$ref": "#/definitions/EmployeeProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...ager/resource-types/tenant/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...ager/resource-types/tenant/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -374,11 +374,7 @@
         "properties": {
           "$ref": "#/definitions/EmployeeProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...ger/resource-types/tracked/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...ger/resource-types/tracked/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -450,11 +450,7 @@
         "properties": {
           "$ref": "#/definitions/EmployeeProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/...rce-types/virtual-resource/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json b/...rce-types/virtual-resource/@azure-tools/typespec-autorest/2021-10-01-preview/openapi.json
@@ -542,11 +542,7 @@
         "properties": {
           "$ref": "#/definitions/EmployeeProperties",
           "description": "The resource-specific properties for this resource.",
-          "x-ms-client-flatten": true,
-          "x-ms-mutability": [
-            "read",
-            "create"
-          ]
+          "x-ms-client-flatten": true
         }
       },
       "allOf": [

diff --git a/packages/typespec-azure-resource-manager/lib/foundations/arm.foundations.tsp b/packages/typespec-azure-resource-manager/lib/foundations/arm.foundations.tsp
@@ -115,7 +115,11 @@ model ResourceUpdateModelProperties<
 model ResourceUpdateModel<
   Resource extends Foundations.Resource,
   Properties extends TypeSpec.Reflection.Model
-> is OptionalProperties<UpdateableProperties<OmitProperties<Resource, "Name" | "name">>> {
+>
+  is OptionalProperties<UpdateableProperties<OmitProperties<
+    Resource,
+    "Name" | "name" | "properties"
+  >>> {
   @extension("x-ms-client-flatten", true)
   properties?: ResourceUpdateModelProperties<Resource, Properties>;
 }

diff --git a/packages/typespec-azure-resource-manager/lib/models.tsp b/packages/typespec-azure-resource-manager/lib/models.tsp
@@ -46,7 +46,6 @@ model ResourceNameParameter<
 @includeInapplicableMetadataInPayload(false)
 model TrackedResource<Properties extends {}> extends Foundations.TrackedResource {
   @doc("The resource-specific properties for this resource.")
-  @visibility("read", "create")
   @extension("x-ms-client-flatten", true)
   properties?: Properties;
 }
@@ -62,7 +61,6 @@ model TrackedResource<Properties extends {}> extends Foundations.TrackedResource
 @includeInapplicableMetadataInPayload(false)
 model ProxyResource<Properties extends {}> extends Foundations.ProxyResource {
   @doc("The resource-specific properties for this resource.")
-  @visibility("read", "create")
   @extension("x-ms-client-flatten", true)
   properties?: Properties;
 }
@@ -79,7 +77,6 @@ model ProxyResource<Properties extends {}> extends Foundations.ProxyResource {
 @includeInapplicableMetadataInPayload(false)
 model ExtensionResource<Properties extends {}> extends Foundations.ExtensionResource {
   @doc("The resource-specific properties for this resource.")
-  @visibility("read", "create")
   @extension("x-ms-client-flatten", true)
   properties?: Properties;
 }