Microsoft.Resources deployments 2015-11-01

• Latest
• 2025-04-01
• 2025-03-01
• 2024-11-01
• 2024-07-01
• 2024-03-01
• 2023-07-01
• 2022-09-01
• 2021-04-01
• 2021-01-01
• 2020-10-01
• 2020-08-01
• 2020-06-01
• 2019-10-01
• 2019-08-01
• 2019-07-01
• 2019-05-10
• 2019-05-01
• 2019-03-01
• 2018-05-01
• 2018-02-01
• 2017-05-10
• 2016-09-01
• 2016-07-01
• 2016-02-01
• 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(...)
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: any(...)
    templateLink: {
      contentVersion: 'string'
      uri: 'string'
    }
  }
}

Property Values

Microsoft.Resources/deployments

Name	Description	Value
name	The resource name	string (required)
properties	Gets or sets the deployment properties.	DeploymentPropertiesOrDeploymentPropertiesExtended

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

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

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'

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

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)

Usage Examples

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"
  parent_id = "string"
  body = {
    properties = {
      mode = "string"
      parameters = ?
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      template = ?
      templateLink = {
        contentVersion = "string"
        uri = "string"
      }
    }
  }
}

Property Values

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"

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

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)