< Back
Export-AzureRmResourceGroup
Post
NAME Export-AzureRmResourceGroup
SYNOPSIS
Captures a resource group as a template and saves it to a file.
SYNTAX
Export-AzureRmResourceGroup [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-IncludeComments]
[-IncludeParameterDefaultValue] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-Path <String>] [-Pre] -ResourceGroupName
<String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Export-AzureRmResourceGroup cmdlet captures the specified resource group as a template and saves it to a JSON 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.
PARAMETERS
-ApiVersion <String>
Specifies the version of the resource provider API to use. If not specified, the latest API version is used.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-IncludeComments [<SwitchParameter>]
Indicates that this operation exports the template with comments.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-IncludeParameterDefaultValue [<SwitchParameter>]
Indicates that this operation exports the template parameter with the default value.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InformationAction <ActionPreference>
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Specifies an information variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Specifies the output path of the template file.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet use pre-release API versions when automatically determining which API version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group to export.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Management.Automation.PSObject
NOTES
Example 1: Export a resource group
PS C:\\>Export-AzureRmResourceGroup -ResourceGroupName "TestGroup"
This command captures the resource group named TestGroup as a template, and saves it to a JSON file in the current directory.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ourcegroup
Find-AzureRmResourceGroup
SYNOPSIS
Captures a resource group as a template and saves it to a file.
SYNTAX
Export-AzureRmResourceGroup [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] [-Force] [-IncludeComments]
[-IncludeParameterDefaultValue] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [-Path <String>] [-Pre] -ResourceGroupName
<String> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Export-AzureRmResourceGroup cmdlet captures the specified resource group as a template and saves it to a JSON 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.
PARAMETERS
-ApiVersion <String>
Specifies the version of the resource provider API to use. If not specified, the latest API version is used.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-IncludeComments [<SwitchParameter>]
Indicates that this operation exports the template with comments.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-IncludeParameterDefaultValue [<SwitchParameter>]
Indicates that this operation exports the template parameter with the default value.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-InformationAction <ActionPreference>
Specifies how this cmdlet responds to an information event.
The acceptable values for this parameter are:
- Continue
- Ignore
- Inquire
- SilentlyContinue
- Stop
- Suspend
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InformationVariable <String>
Specifies an information variable.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Path <String>
Specifies the output path of the template file.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet use pre-release API versions when automatically determining which API version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of the resource group to export.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
System.Management.Automation.PSObject
NOTES
Example 1: Export a resource group
PS C:\\>Export-AzureRmResourceGroup -ResourceGroupName "TestGroup"
This command captures the resource group named TestGroup as a template, and saves it to a JSON file in the current directory.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... ourcegroup
Find-AzureRmResourceGroup