Microsoft Azure · Schema

Azure Error Response

The common error response schema for all Azure Resource Manager APIs. This follows the Azure REST API guidelines for error handling, providing structured error information including error codes, messages, targets, and nested details for comprehensive error diagnostics.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name Type Description
error object
View JSON Schema on GitHub

JSON Schema

microsoft-azure-error-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://schema.api.gov/microsoft-azure/error-response",
  "title": "Azure Error Response",
  "description": "The common error response schema for all Azure Resource Manager APIs. This follows the Azure REST API guidelines for error handling, providing structured error information including error codes, messages, targets, and nested details for comprehensive error diagnostics.",
  "type": "object",
  "properties": {
    "error": {
      "$ref": "#/$defs/ErrorDetail"
    }
  },
  "$defs": {
    "ErrorDetail": {
      "type": "object",
      "description": "The error detail.",
      "properties": {
        "code": {
          "type": "string",
          "description": "The error code. This is a machine-readable identifier for the error that can be used for programmatic error handling.",
          "readOnly": true,
          "examples": [
            "ResourceNotFound",
            "InvalidRequestContent",
            "AuthorizationFailed",
            "ResourceGroupNotFound",
            "SubscriptionNotFound",
            "MissingSubscriptionRegistration",
            "InvalidParameter",
            "ConflictError",
            "OperationNotAllowed"
          ]
        },
        "message": {
          "type": "string",
          "description": "The error message. This is a human-readable description of the error intended for display in a user interface.",
          "readOnly": true
        },
        "target": {
          "type": "string",
          "description": "The error target. This identifies the specific element (property name, path, etc.) that is the source of the error.",
          "readOnly": true
        },
        "details": {
          "type": "array",
          "description": "The error details. A list of additional error objects providing more granular information about the error.",
          "readOnly": true,
          "items": {
            "$ref": "#/$defs/ErrorDetail"
          }
        },
        "additionalInfo": {
          "type": "array",
          "description": "The error additional info. Additional structured data about the error for programmatic consumption.",
          "readOnly": true,
          "items": {
            "$ref": "#/$defs/ErrorAdditionalInfo"
          }
        }
      }
    },
    "ErrorAdditionalInfo": {
      "type": "object",
      "description": "The resource management error additional info.",
      "properties": {
        "type": {
          "type": "string",
          "description": "The additional info type. Identifies the schema of the info property.",
          "readOnly": true
        },
        "info": {
          "type": "object",
          "description": "The additional info. Contains structured data specific to the error additional info type.",
          "readOnly": true
        }
      }
    }
  }
}