export-template-powershell.md

title	description	ms.topic	ms.custom	ms.date
Export template in Azure PowerShell	Use Azure PowerShell to export an Azure Resource Manager template from resources in your subscription.	conceptual	devx-track-azurepowershell, devx-track-arm-template	03/20/2024

Use Azure PowerShell to export a template

[!INCLUDE Export template intro]

This article shows how to export templates through Azure PowerShell. For other options, see:

• Export template with Azure CLI
• Export template with Azure portal
• REST API export from resource group and REST API export from deployment history.

[!INCLUDE Export template choose option]

[!INCLUDE Export template limitations]

Export template from a resource group

After setting up your resource group, you can export an Azure Resource Manager template for the resource group.

To export all resources in a resource group, use the Export-AzResourceGroup cmdlet and provide the resource group name.

Export-AzResourceGroup -ResourceGroupName demoGroup

It saves the template as a local file.

Instead of exporting all resources in the resource group, you can select which resources to export.

To export one resource, pass that resource ID.

$resource = Get-AzResource `
  -ResourceGroupName <resource-group-name> `
  -ResourceName <resource-name> `
  -ResourceType <resource-type>
Export-AzResourceGroup `
  -ResourceGroupName <resource-group-name> `
  -Resource $resource.ResourceId

To export more than one resource, pass the resource IDs in an array.

Export-AzResourceGroup `
  -ResourceGroupName <resource-group-name> `
  -Resource @($resource1.ResourceId, $resource2.ResourceId)

When exporting the template, you can specify whether parameters are used in the template. By default, parameters for resource names are included but they don't have a default value.

"parameters": {
  "serverfarms_demoHostPlan_name": {
    "type": "String"
  },
  "sites_webSite3bwt23ktvdo36_name": {
    "type": "String"
  }
}

If you use the -SkipResourceNameParameterization parameter when exporting the template, parameters for resource names aren't included in the template. Instead, the resource name is set directly on the resource to its current value. You can't customize the name during deployment.

"resources": [
  {
    "type": "Microsoft.Web/serverfarms",
    "apiVersion": "2022-09-01",
    "name": "demoHostPlan",
    ...
  }
]

If you use the -IncludeParameterDefaultValue parameter when exporting the template, the template parameter includes a default value that is set to the current value. You can either use that default value or overwrite the default value by passing in a different value.

"parameters": {
  "serverfarms_demoHostPlan_name": {
    "defaultValue": "demoHostPlan",
    "type": "String"
  },
  "sites_webSite3bwt23ktvdo36_name": {
    "defaultValue": "webSite3bwt23ktvdo36",
    "type": "String"
  }
}

Save template from deployment history

You can save a template from a deployment in the deployment history. The template you get is exactly the one that was used for deployment.

To get a template from a resource group deployment, use the Save-AzResourceGroupDeploymentTemplate cmdlet. You specify the name of the deployment to retrieve. For help with getting the name of a deployment, see View deployment history with Azure Resource Manager.

Save-AzResourceGroupDeploymentTemplate -ResourceGroupName demoGroup -DeploymentName demoDeployment

The template is saved as a local file with the name of the deployment.

To get templates deployed at other levels, use:

• Save-AzDeploymentTemplate for deployments to subscriptions
• Save-AzManagementGroupDeploymentTemplate for deployments to management groups
• Save-AzTenantDeploymentTemplate for deployments to tenants

Next steps

• Learn how to export templates with Azure CLI, Azure portal, or REST API.
• To learn the Resource Manager template syntax, see Understand the structure and syntax of Azure Resource Manager templates.
• To learn how to develop templates, see the step-by-step tutorials.