{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://schema.api.gov/microsoft-azure/deployment", "title": "Azure Resource Manager Deployment", "description": "An Azure Resource Manager deployment represents the process of deploying one or more resources to an Azure subscription, resource group, or management group. Deployments use ARM templates (JSON or Bicep) to define the resources to deploy, their configurations, and dependencies.", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the deployment.", "readOnly": true }, "name": { "type": "string", "description": "The name of the deployment.", "readOnly": true, "minLength": 1, "maxLength": 64, "pattern": "^[-\\w\\._\\(\\)]+$" }, "type": { "type": "string", "description": "The type of the deployment.", "readOnly": true, "const": "Microsoft.Resources/deployments" }, "location": { "type": "string", "description": "The location to store the deployment data." }, "properties": { "type": "object", "description": "Deployment properties.", "properties": { "provisioningState": { "type": "string", "description": "Denotes the state of provisioning.", "readOnly": true, "enum": [ "NotSpecified", "Accepted", "Running", "Ready", "Creating", "Created", "Deleting", "Deleted", "Canceled", "Failed", "Succeeded", "Updating" ] }, "correlationId": { "type": "string", "description": "The correlation ID of the deployment.", "readOnly": true }, "timestamp": { "type": "string", "format": "date-time", "description": "The timestamp of the template deployment.", "readOnly": true }, "duration": { "type": "string", "description": "The duration of the template deployment.", "readOnly": true }, "outputs": { "type": "object", "description": "Key/value pairs that represent deployment output.", "readOnly": true }, "template": { "type": "object", "description": "The template content. Use this element when you want to pass the template syntax directly in the request rather than link to an existing template." }, "templateLink": { "type": "object", "description": "The URI of the template. Use this element to link to an existing template rather than including the template in the request.", "properties": { "uri": { "type": "string", "format": "uri", "description": "The URI of the template to deploy." }, "contentVersion": { "type": "string", "description": "If included, must match the ContentVersion in the template.", "pattern": "^(\\d+\\.)(\\d+\\.)(\\d+\\.)(\\d+)$" }, "queryString": { "type": "string", "description": "The query string to use with the templateLink URI." } }, "required": [ "uri" ] }, "parameters": { "type": "object", "description": "Name and value pairs that define the deployment parameters. The parameters are passed directly to the template." }, "parametersLink": { "type": "object", "description": "The URI of parameters file. Use this element to link to an existing parameters file.", "properties": { "uri": { "type": "string", "format": "uri", "description": "The URI of the parameters file." }, "contentVersion": { "type": "string", "description": "If included, must match the ContentVersion in the parameters file." } }, "required": [ "uri" ] }, "mode": { "type": "string", "description": "The mode that is used to deploy resources. Incremental mode handles deployments as incremental updates. Complete mode deletes resources that exist in the resource group but are not specified in the template.", "enum": [ "Incremental", "Complete" ] }, "debugSetting": { "type": "object", "description": "The debug setting of the deployment.", "properties": { "detailLevel": { "type": "string", "description": "Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma." } } }, "onErrorDeployment": { "type": "object", "description": "The deployment on error behavior.", "properties": { "type": { "type": "string", "description": "The deployment on error behavior type.", "enum": [ "LastSuccessful", "SpecificDeployment" ] }, "deploymentName": { "type": "string", "description": "The deployment to be used on error case." } } } }, "required": [ "mode" ] }, "tags": { "type": "object", "description": "Deployment tags.", "additionalProperties": { "type": "string" } } }, "required": [ "properties" ] }