Test commit - adding error schema

Azure · May 23, 2023 · 02a0c4d · 02a0c4d
1 parent 1f965c5
commit 02a0c4d
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 2 deletions.
diff --git a/...ation/sql/resource-manager/Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json b/...ation/sql/resource-manager/Microsoft.Sql/preview/2023-02-01-preview/ManagedInstances.json
@@ -502,10 +502,18 @@
             }
           },
           "default": {
-            "description": "*** Error Responses: ***\n\n * 400 SubnetMissingRequiredDelegation - Selected subnet is not delegated for SQL Managed Instance.\n\n * 404 ManagedInstanceNotInSubscriptionResourceGroup - Specified managed instance does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "../../../common/v2/types.json#/definitions/CloudError"
+            }
           },
           "202": {
-            "description": "Refreshing external governance enablement status."
+            "description": "Refreshing external governance enablement status.",
+            "headers": {
+              "Location": {
+                "type": "string"
+              }
+            }
           }
         },
         "x-ms-long-running-operation": true,

diff --git a/specification/sql/resource-manager/common/v2/types.json b/specification/sql/resource-manager/common/v2/types.json
@@ -24,6 +24,34 @@
         }
       }
     },
+    "CloudError": {
+      "description": "Error response structure.",
+      "x-ms-external": true,
+      "properties": {
+        "error": {
+          "$ref": "#/definitions/CloudErrorBody",
+          "description": "Error data"
+        }
+      },
+      "type": "object"
+    },
+    "CloudErrorBody": {
+      "x-ms-external": true,
+      "description": "Error details.",
+      "properties": {
+        "code": {
+          "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.",
+          "readOnly": true,
+          "type": "string"
+        },
+        "message": {
+          "description": "A message describing the error, intended to be suitable for display in a user interface.",
+          "readOnly": true,
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "ResourceIdentity": {
       "description": "Azure Active Directory identity configuration for a resource.",
       "type": "object",