Export-AzResourceGroup

Module:

Az.Resources Module

Captures a resource group as a template and saves it to a file.

Export-AzResourceGroup
 -ResourceGroupName <String>
 [-Path <String>]
 [-IncludeParameterDefaultValue]
 [-IncludeComments]
 [-SkipResourceNameParameterization]
 [-SkipAllParameterization]
 [-Resource <String[]>]
 [-Force]
 [-ApiVersion <String>]
 [-OutputFormat <String>]
 [-Pre]
 [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf]
 [-Confirm]
 [<CommonParameters>]

The Export-AzResourceGroup cmdlet captures the specified resource group as a template and saves it to a JSON or Bicep file.This can be useful in scenarios where you have already created some resources in your resource group, and then want to leverage the benefits of using template backed deployments. This cmdlet gives you an easy start by generating the template for your existing resources in the resource group. There might be some cases where this cmdlet fails to generate some parts of the template. Warning messages will inform you of the resources that failed. The template will still be generated for the parts that were successful.

Export-AzResourceGroup -ResourceGroupName "TestGroup"

This command captures the resource group named TestGroup as a template, and saves it to a JSON file in the current directory.

Export-AzResourceGroup -ResourceGroupName "TestGroup" -Resource "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVirtualMachine"

This command captures the Virtual Machine resource named "TestVirtualMachine" from the "TestGroup" resource group as a template, and saves it to a JSON file in the current directory.

Export-AzResourceGroup -ResourceGroupName "TestGroup" -SkipAllParameterization -Resource @(
 "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Compute/virtualMachines/TestVm",
 "/subscriptions/5f43547b-1d2d-4a3e-ace4-88d4b600d568/resourceGroups/TestGroup/providers/Microsoft.Network/networkInterfaces/TestNic"
)

This command captures two resources from the "TestGroup" resource group as a template, and saves it to a JSON file in the current directory. The generated template will not contain any generated parameters.

Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep

This command captures the resource group named TestGroup as a template, and saves it to a Bicep file in the current directory.

Export-AzResourceGroup -ResourceGroupName "TestGroup" -OutputFormat Bicep -Path "C:\Templates\MyResourceGroup.bicep"

This command captures the resource group named TestGroup as a template, and saves it to a Bicep file at the specified path.

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.