Skip to content

Latest commit

 

History

History
103 lines (77 loc) · 3.7 KB

deployment-modes.md

File metadata and controls

103 lines (77 loc) · 3.7 KB
title description services documentationcenter author ms.service ms.devlang ms.topic ms.tgt_pltfrm ms.workload ms.date ms.author
Azure Resource Manager deployment modes | Microsoft Docs
Describes how to specify whether to use a complete or incremental deployment mode with Azure Resource Manager.
azure-resource-manager
na
tfitzmac
azure-resource-manager
na
conceptual
na
na
11/08/2018
tomfitz

Azure Resource Manager deployment modes

When deploying your resources, you specify that the deployment is either an incremental update or a complete update. The primary difference between these two modes is how Resource Manager handles existing resources in the resource group that aren't in the template. The default mode is incremental.

Incremental and complete deployments

When deploying resources:

  • In complete mode, Resource Manager deletes resources that exist in the resource group but aren't specified in the template.
  • In incremental mode, Resource Manager leaves unchanged resources that exist in the resource group but aren't specified in the template.

For both modes, Resource Manager tries to create all resources specified in the template. If the resource already exists in the resource group and its settings are unchanged, the operation results in no change. If you change the property values for a resource, the resource is updated with those new values. If you try to update the location or type of an existing resource, the deployment fails with an error. Instead, deploy a new resource with the location or type that you need.

When redeploying a resource in incremental mode, specify all property values for the resource, not just the ones you're updating. If you don't specify certain properties, Resource Manager interprets the update as overwriting those values.

Example result

To illustrate the difference between incremental and complete modes, consider the following scenario.

Resource Group contains:

  • Resource A
  • Resource B
  • Resource C

Template contains:

  • Resource A
  • Resource B
  • Resource D

When deployed in incremental mode, the resource group has:

  • Resource A
  • Resource B
  • Resource C
  • Resource D

When deployed in complete mode, Resource C is deleted. The resource group has:

  • Resource A
  • Resource B
  • Resource D

Set deployment mode

To set the deployment mode when deploying with PowerShell, use the Mode parameter.

New-AzureRmResourceGroupDeployment `
  -Mode Complete `
  -Name ExampleDeployment `
  -ResourceGroupName ExampleResourceGroup `
  -TemplateFile c:\MyTemplates\storage.json

To set the deployment mode when deploying with Azure CLI, use the mode parameter.

az group deployment create \
  --name ExampleDeployment \
  --mode Complete \
  --resource-group ExampleGroup \
  --template-file storage.json \
  --parameters storageAccountType=Standard_GRS

When using a linked or nested template, you must set the mode property to Incremental. Only root-level templates support the complete deployment mode.

"resources": [
  {
      "apiVersion": "2017-05-10",
      "name": "linkedTemplate",
      "type": "Microsoft.Resources/deployments",
      "properties": {
          "mode": "Incremental",
          <nested-template-or-external-template>
      }
  }
]

Next steps