Microsoft.Resources deployments 2018-02-01
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:
- Resource groups - See resource group deployment commands
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@2018-02-01' = {
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 |
|---|---|---|
| name | The resource name | string Constraints: Min length = 1 Max length = 1 Pattern = ^[-\w\._\(\)]+$ (required) |
| properties | The deployment properties. | DeploymentPropertiesOrDeploymentPropertiesExtended (required) |
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' |
ParametersLink
| Name | Description | Value |
|---|---|---|
| contentVersion | If included, must match the ContentVersion in the template. | string |
| uri | The URI of the parameters file. | string (required) |
TemplateLink
| 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:
- Resource groups - See resource group deployment commands
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": "2018-02-01",
"name": "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 | '2018-02-01' |
| 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' |
ParametersLink
| Name | Description | Value |
|---|---|---|
| contentVersion | If included, must match the ContentVersion in the template. | string |
| uri | The URI of the parameters file. | string (required) |
TemplateLink
| 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:
- Resource groups
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@2018-02-01"
name = "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 |
|---|---|---|
| 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@2018-02-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' |
ParametersLink
| Name | Description | Value |
|---|---|---|
| contentVersion | If included, must match the ContentVersion in the template. | string |
| uri | The URI of the parameters file. | string (required) |
TemplateLink
| Name | Description | Value |
|---|---|---|
| contentVersion | If included, must match the ContentVersion in the template. | string |
| uri | The URI of the template to deploy. | string (required) |