Managed Services Swagger Consistency Fixes (#11471)

* Updated 2018-06-01-preview specs * Updated 2019-04-01-preview specs * Updated 2018-06-01-preview specs * Updated 2020-02-01-preview specs * Updated 2019-06-01 specs * Updated 2019-09-01 specs * Updated 2018-06-01-preview examples * Updated ErrorResponse model * Model validation fix * Removed readOnly=true for ErrorResponse * Updated type specification for error * Removed old type reference for ErrorResponse
Azure · Nov 20, 2020 · 32a5c42 · 32a5c42
1 parent 53ad4b5
commit 32a5c42
Show file tree

Hide file tree

Showing 34 changed files with 549 additions and 96 deletions.
diff --git a/...rosoft.ManagedServices/preview/2018-06-01-preview/examples/GetRegistrationAssignment.json b/...rosoft.ManagedServices/preview/2018-06-01-preview/examples/GetRegistrationAssignment.json
@@ -19,7 +19,16 @@
               "authorizations": [
                 {
                   "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+                  "principalIdDisplayName": "Support User",
                   "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+                },
+                {
+                  "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+                  "principalIdDisplayName": "User Access Administrator",
+                  "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+                  "delegatedRoleDefinitionIds": [
+                    "b24988ac-6180-42a0-ab88-20f7382dd24c"
+                  ]
                 }
               ],
               "provisioningState": "Succeeded",

diff --git a/...osoft.ManagedServices/preview/2018-06-01-preview/examples/GetRegistrationAssignments.json b/...osoft.ManagedServices/preview/2018-06-01-preview/examples/GetRegistrationAssignments.json
@@ -18,7 +18,16 @@
                   "authorizations": [
                     {
                       "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+                      "principalIdDisplayName": "Support User",
                       "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+                    },
+                    {
+                      "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+                      "principalIdDisplayName": "User Access Administrator",
+                      "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+                      "delegatedRoleDefinitionIds": [
+                        "b24988ac-6180-42a0-ab88-20f7382dd24c"
+                      ]
                     }
                   ],
                   "provisioningState": "Succeeded",

diff --git a/...rosoft.ManagedServices/preview/2018-06-01-preview/examples/GetRegistrationDefinition.json b/...rosoft.ManagedServices/preview/2018-06-01-preview/examples/GetRegistrationDefinition.json
@@ -14,7 +14,16 @@
           "authorizations": [
             {
               "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "Support User",
               "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+            },
+            {
+              "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "User Access Administrator",
+              "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+              "delegatedRoleDefinitionIds": [
+                "b24988ac-6180-42a0-ab88-20f7382dd24c"
+              ]
             }
           ],
           "provisioningState": "Succeeded",

diff --git a/...osoft.ManagedServices/preview/2018-06-01-preview/examples/GetRegistrationDefinitions.json b/...osoft.ManagedServices/preview/2018-06-01-preview/examples/GetRegistrationDefinitions.json
@@ -15,7 +15,16 @@
               "authorizations": [
                 {
                   "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
+                  "principalIdDisplayName": "Support User",
                   "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+                },
+                {
+                  "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+                  "principalIdDisplayName": "User Access Administrator",
+                  "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+                  "delegatedRoleDefinitionIds": [
+                    "b24988ac-6180-42a0-ab88-20f7382dd24c"
+                  ]
                 }
               ],
               "provisioningState": "Succeeded",

diff --git a/...rosoft.ManagedServices/preview/2018-06-01-preview/examples/PutRegistrationDefinition.json b/...rosoft.ManagedServices/preview/2018-06-01-preview/examples/PutRegistrationDefinition.json
@@ -6,12 +6,21 @@
     "requestBody": {
       "properties": {
         "registrationDefinitionName": "DefinitionName",
-        "description": "Tes1t",
+        "description": "Test",
         "managedByTenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc",
         "authorizations": [
           {
             "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+            "principalIdDisplayName": "Support User",
             "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+          },
+          {
+            "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+            "principalIdDisplayName": "User Access Administrator",
+            "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+            "delegatedRoleDefinitionIds": [
+              "b24988ac-6180-42a0-ab88-20f7382dd24c"
+            ]
           }
         ]
       },
@@ -33,7 +42,16 @@
           "authorizations": [
             {
               "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "Support User",
               "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+            },
+            {
+              "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "User Access Administrator",
+              "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+              "delegatedRoleDefinitionIds": [
+                "b24988ac-6180-42a0-ab88-20f7382dd24c"
+              ]
             }
           ],
           "provisioningState": "Succeeded",
@@ -59,7 +77,16 @@
           "authorizations": [
             {
               "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "Support User",
               "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+            },
+            {
+              "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "User Access Administrator",
+              "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+              "delegatedRoleDefinitionIds": [
+                "b24988ac-6180-42a0-ab88-20f7382dd24c"
+              ]
             }
           ],
           "provisioningState": "Succeeded",

diff --git a/...esource-manager/Microsoft.ManagedServices/preview/2018-06-01-preview/managedservices.json b/...esource-manager/Microsoft.ManagedServices/preview/2018-06-01-preview/managedservices.json
@@ -759,9 +759,21 @@
           "type": "string",
           "description": "Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription"
         },
+        "principalIdDisplayName": {
+          "type": "string",
+          "description": "Display name of the principal Id."
+        },
         "roleDefinitionId": {
           "type": "string",
           "description": "The role definition identifier. This role will define all the permissions that the security group/service principal/user must have on the projected subscription. This role cannot be an owner role."
+        },
+        "delegatedRoleDefinitionIds": {
+          "type": "array",
+          "description": "The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users.",
+          "items": {
+            "format": "uuid",
+            "type": "string"
+          }
         }
       },
       "required": [
@@ -771,29 +783,40 @@
       "type": "object",
       "description": "Authorization tuple containing principal Id (of user/service principal/security group) and role definition id."
     },
+    "ErrorDefinition": {
+      "properties": {
+        "code": {
+          "type": "string",
+          "description": "Error code."
+        },
+        "message": {
+          "type": "string",
+          "description": "Error message indicating why the operation failed."
+        },
+        "details": {
+          "description": "Internal error details.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ErrorDefinition"
+          }
+        }
+      },
+      "required": [
+        "code",
+        "message"
+      ],
+      "type": "object",
+      "description": "Error response indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message."
+    },
     "ErrorResponse": {
+      "description": "Error response.",
       "properties": {
         "error": {
-          "readOnly": true,
-          "properties": {
-            "code": {
-              "type": "string",
-              "description": "Error code."
-            },
-            "message": {
-              "type": "string",
-              "description": "Error message indicating why the operation failed."
-            }
-          },
-          "required": [
-            "code",
-            "message"
-          ],
-          "type": "object",
-          "description": "Error response indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message."
+          "$ref": "#/definitions/ErrorDefinition",
+          "description": "The error details.",
+          "type": "object"
         }
-      },
-      "description": "Error response."
+      }
     }
   },
   "parameters": {

diff --git a/...rosoft.ManagedServices/preview/2019-04-01-preview/examples/GetRegistrationAssignment.json b/...rosoft.ManagedServices/preview/2019-04-01-preview/examples/GetRegistrationAssignment.json
@@ -19,7 +19,16 @@
               "authorizations": [
                 {
                   "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+                  "principalIdDisplayName": "Support User",
                   "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+                },
+                {
+                  "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+                  "principalIdDisplayName": "User Access Administrator",
+                  "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+                  "delegatedRoleDefinitionIds": [
+                    "b24988ac-6180-42a0-ab88-20f7382dd24c"
+                  ]
                 }
               ],
               "provisioningState": "Succeeded",

diff --git a/...osoft.ManagedServices/preview/2019-04-01-preview/examples/GetRegistrationAssignments.json b/...osoft.ManagedServices/preview/2019-04-01-preview/examples/GetRegistrationAssignments.json
@@ -18,7 +18,16 @@
                   "authorizations": [
                     {
                       "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+                      "principalIdDisplayName": "Support User",
                       "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+                    },
+                    {
+                      "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+                      "principalIdDisplayName": "User Access Administrator",
+                      "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+                      "delegatedRoleDefinitionIds": [
+                        "b24988ac-6180-42a0-ab88-20f7382dd24c"
+                      ]
                     }
                   ],
                   "provisioningState": "Succeeded",

diff --git a/...rosoft.ManagedServices/preview/2019-04-01-preview/examples/GetRegistrationDefinition.json b/...rosoft.ManagedServices/preview/2019-04-01-preview/examples/GetRegistrationDefinition.json
@@ -14,7 +14,16 @@
           "authorizations": [
             {
               "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "Support User",
               "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+            },
+            {
+              "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "User Access Administrator",
+              "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+              "delegatedRoleDefinitionIds": [
+                "b24988ac-6180-42a0-ab88-20f7382dd24c"
+              ]
             }
           ],
           "provisioningState": "Succeeded",

diff --git a/...osoft.ManagedServices/preview/2019-04-01-preview/examples/GetRegistrationDefinitions.json b/...osoft.ManagedServices/preview/2019-04-01-preview/examples/GetRegistrationDefinitions.json
@@ -15,7 +15,16 @@
               "authorizations": [
                 {
                   "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
+                  "principalIdDisplayName": "Support User",
                   "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+                },
+                {
+                  "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+                  "principalIdDisplayName": "User Access Administrator",
+                  "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+                  "delegatedRoleDefinitionIds": [
+                    "b24988ac-6180-42a0-ab88-20f7382dd24c"
+                  ]
                 }
               ],
               "provisioningState": "Succeeded",

diff --git a/...rosoft.ManagedServices/preview/2019-04-01-preview/examples/PutRegistrationDefinition.json b/...rosoft.ManagedServices/preview/2019-04-01-preview/examples/PutRegistrationDefinition.json
@@ -11,7 +11,15 @@
         "authorizations": [
           {
             "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+            "principalIdDisplayName": "Support User",
             "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+          },
+          {
+            "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+            "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+            "delegatedRoleDefinitionIds": [
+              "b24988ac-6180-42a0-ab88-20f7382dd24c"
+            ]
           }
         ]
       },
@@ -33,7 +41,16 @@
           "authorizations": [
             {
               "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "Support User",
               "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+            },
+            {
+              "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "User Access Administrator",
+              "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+              "delegatedRoleDefinitionIds": [
+                "b24988ac-6180-42a0-ab88-20f7382dd24c"
+              ]
             }
           ],
           "provisioningState": "Succeeded",
@@ -59,7 +76,16 @@
           "authorizations": [
             {
               "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "Support User",
               "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7"
+            },
+            {
+              "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc",
+              "principalIdDisplayName": "User Access Administrator",
+              "roleDefinitionId": "18d7d88d-d35e-4fb5-a5c3-7773c20a72d9",
+              "delegatedRoleDefinitionIds": [
+                "b24988ac-6180-42a0-ab88-20f7382dd24c"
+              ]
             }
           ],
           "provisioningState": "Succeeded",