Share via

Microsoft.Resources deployments 2019-08-01

  • Article

Remarks

For Bicep, consider using modules instead of this resource type.

Bicep resource definition

The deployments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Resources/deployments resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Resources/deployments@2019-08-01' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    debugSetting: {
      detailLevel: 'string'
    }
    mode: 'string'
    onErrorDeployment: {
      deploymentName: 'string'
      type: 'string'
    }
    parameters: any(Azure.Bicep.Types.Concrete.AnyType)
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: any(Azure.Bicep.Types.Concrete.AnyType)
    templateLink: {
      contentVersion: 'string'
      uri: 'string'
    }
  }
}

Property values

DebugSetting

Name Description Value
detailLevel 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. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. string

DeploymentPropertiesOrDeploymentPropertiesExtended

Name Description Value
debugSetting The debug setting of the deployment. DebugSetting
mode The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. 'Complete'
'Incremental' (required)
onErrorDeployment The deployment on error behavior. OnErrorDeploymentOrOnErrorDeploymentExtended
parameters Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. any
parametersLink The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ParametersLink
template The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. any
templateLink The URI of the template. Use either the templateLink property or the template property, but not both. TemplateLink

Microsoft.Resources/deployments

Name Description Value
location The location to store the deployment data. string
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[-\w\._\(\)]+$ (required)
properties The deployment properties. DeploymentPropertiesOrDeploymentPropertiesExtended (required)
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.

OnErrorDeploymentOrOnErrorDeploymentExtended

Name Description Value
deploymentName The deployment to be used on error case. string
type The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Name Description Value
contentVersion If included, must match the ContentVersion in the template. string
uri The URI of the parameters file. string (required)
Name Description Value
contentVersion If included, must match the ContentVersion in the template. string
uri The URI of the template to deploy. string (required)

ARM template resource definition

The deployments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Resources/deployments resource, add the following JSON to your template.

{
  "type": "Microsoft.Resources/deployments",
  "apiVersion": "2019-08-01",
  "name": "string",
  "location": "string",
  "properties": {
    "debugSetting": {
      "detailLevel": "string"
    },
    "mode": "string",
    "onErrorDeployment": {
      "deploymentName": "string",
      "type": "string"
    },
    "parameters": {},
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {},
    "templateLink": {
      "contentVersion": "string",
      "uri": "string"
    }
  }
}

Property values

DebugSetting

Name Description Value
detailLevel 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. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. string

DeploymentPropertiesOrDeploymentPropertiesExtended

Name Description Value
debugSetting The debug setting of the deployment. DebugSetting
mode The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. 'Complete'
'Incremental' (required)
onErrorDeployment The deployment on error behavior. OnErrorDeploymentOrOnErrorDeploymentExtended
parameters Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. any
parametersLink The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ParametersLink
template The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. any
templateLink The URI of the template. Use either the templateLink property or the template property, but not both. TemplateLink

Microsoft.Resources/deployments

Name Description Value
apiVersion The api version '2019-08-01'
location The location to store the deployment data. string
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[-\w\._\(\)]+$ (required)
properties The deployment properties. DeploymentPropertiesOrDeploymentPropertiesExtended (required)
type The resource type 'Microsoft.Resources/deployments'

OnErrorDeploymentOrOnErrorDeploymentExtended

Name Description Value
deploymentName The deployment to be used on error case. string
type The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Name Description Value
contentVersion If included, must match the ContentVersion in the template. string
uri The URI of the parameters file. string (required)
Name Description Value
contentVersion If included, must match the ContentVersion in the template. string
uri The URI of the template to deploy. string (required)

Terraform (AzAPI provider) resource definition

The deployments resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Resources/deployments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/deployments@2019-08-01"
  name = "string"
  parent_id = "string"
  location = "string"
  body = jsonencode({
    properties = {
      debugSetting = {
        detailLevel = "string"
      }
      mode = "string"
      onErrorDeployment = {
        deploymentName = "string"
        type = "string"
      }
      parameters = ?
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      template = ?
      templateLink = {
        contentVersion = "string"
        uri = "string"
      }
    }
  })
}

Property values

DebugSetting

Name Description Value
detailLevel 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. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. string

DeploymentPropertiesOrDeploymentPropertiesExtended

Name Description Value
debugSetting The debug setting of the deployment. DebugSetting
mode The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources. 'Complete'
'Incremental' (required)
onErrorDeployment The deployment on error behavior. OnErrorDeploymentOrOnErrorDeploymentExtended
parameters Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string. any
parametersLink The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. ParametersLink
template The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both. any
templateLink The URI of the template. Use either the templateLink property or the template property, but not both. TemplateLink

Microsoft.Resources/deployments

Name Description Value
location The location to store the deployment data. string
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[-\w\._\(\)]+$ (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties The deployment properties. DeploymentPropertiesOrDeploymentPropertiesExtended (required)
type The resource type "Microsoft.Resources/deployments@2019-08-01"

OnErrorDeploymentOrOnErrorDeploymentExtended

Name Description Value
deploymentName The deployment to be used on error case. string
type The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. 'LastSuccessful'
'SpecificDeployment'
Name Description Value
contentVersion If included, must match the ContentVersion in the template. string
uri The URI of the parameters file. string (required)
Name Description Value
contentVersion If included, must match the ContentVersion in the template. string
uri The URI of the template to deploy. string (required)