Microsoft.Resources deployments 2015-11-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@2015-11-01' = {
name: 'string'
properties: {
mode: '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
DeploymentPropertiesOrDeploymentPropertiesExtended
| Name | Description | Value |
|---|---|---|
| mode | Gets or sets the deployment mode. | 'Complete' 'Incremental' |
| parameters | Deployment parameters. Use only one of Parameters or ParametersLink. | any |
| parametersLink | Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink. | ParametersLink |
| template | Gets or sets the template content. Use only one of Template or TemplateLink. | any |
| templateLink | Gets or sets the URI referencing the template. Use only one of Template or TemplateLink. | TemplateLink |
Microsoft.Resources/deployments
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Gets or sets the deployment properties. | DeploymentPropertiesOrDeploymentPropertiesExtended |
ParametersLink
| Name | Description | Value |
|---|---|---|
| contentVersion | If included it must match the ContentVersion in the template. | string |
| uri | URI referencing the template. | string (required) |
TemplateLink
| Name | Description | Value |
|---|---|---|
| contentVersion | If included it must match the ContentVersion in the template. | string |
| uri | URI referencing the template. | 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": "2015-11-01",
"name": "string",
"properties": {
"mode": "string",
"parameters": {},
"parametersLink": {
"contentVersion": "string",
"uri": "string"
},
"template": {},
"templateLink": {
"contentVersion": "string",
"uri": "string"
}
}
}
Property values
DeploymentPropertiesOrDeploymentPropertiesExtended
| Name | Description | Value |
|---|---|---|
| mode | Gets or sets the deployment mode. | 'Complete' 'Incremental' |
| parameters | Deployment parameters. Use only one of Parameters or ParametersLink. | any |
| parametersLink | Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink. | ParametersLink |
| template | Gets or sets the template content. Use only one of Template or TemplateLink. | any |
| templateLink | Gets or sets the URI referencing the template. Use only one of Template or TemplateLink. | TemplateLink |
Microsoft.Resources/deployments
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2015-11-01' |
| name | The resource name | string (required) |
| properties | Gets or sets the deployment properties. | DeploymentPropertiesOrDeploymentPropertiesExtended |
| type | The resource type | 'Microsoft.Resources/deployments' |
ParametersLink
| Name | Description | Value |
|---|---|---|
| contentVersion | If included it must match the ContentVersion in the template. | string |
| uri | URI referencing the template. | string (required) |
TemplateLink
| Name | Description | Value |
|---|---|---|
| contentVersion | If included it must match the ContentVersion in the template. | string |
| uri | URI referencing the template. | 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@2015-11-01"
name = "string"
body = jsonencode({
properties = {
mode = "string"
parameters = ?
parametersLink = {
contentVersion = "string"
uri = "string"
}
template = ?
templateLink = {
contentVersion = "string"
uri = "string"
}
}
})
}
Property values
DeploymentPropertiesOrDeploymentPropertiesExtended
| Name | Description | Value |
|---|---|---|
| mode | Gets or sets the deployment mode. | 'Complete' 'Incremental' |
| parameters | Deployment parameters. Use only one of Parameters or ParametersLink. | any |
| parametersLink | Gets or sets the URI referencing the parameters. Use only one of Parameters or ParametersLink. | ParametersLink |
| template | Gets or sets the template content. Use only one of Template or TemplateLink. | any |
| templateLink | Gets or sets the URI referencing the template. Use only one of Template or TemplateLink. | TemplateLink |
Microsoft.Resources/deployments
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| properties | Gets or sets the deployment properties. | DeploymentPropertiesOrDeploymentPropertiesExtended |
| type | The resource type | "Microsoft.Resources/deployments@2015-11-01" |
ParametersLink
| Name | Description | Value |
|---|---|---|
| contentVersion | If included it must match the ContentVersion in the template. | string |
| uri | URI referencing the template. | string (required) |
TemplateLink
| Name | Description | Value |
|---|---|---|
| contentVersion | If included it must match the ContentVersion in the template. | string |
| uri | URI referencing the template. | string (required) |