< Back

Save-AzureRmResourceGroupDeploymentTemplate

Tue Jan 29, 2019 10:06 pm

NAME Save-AzureRmResourceGroupDeploymentTemplate



SYNOPSIS

Saves a resource group deployment template to a file.





SYNTAX

Save-AzureRmResourceGroupDeploymentTemplate [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] -DeploymentName <String> [-Force]

[-InformationAction <ActionPreference>] [-InformationVariable <String>] [-Path <String>] [-Pre] -ResourceGroupName <String> [-Confirm] [-WhatIf]

[<CommonParameters>]





DESCRIPTION

The Save-AzureRmResourceGroupDeploymentTemplate cmdlet saves a resource group deployment template to a JSON file.





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



-DeploymentName <String>

Specifies the name of the deployment.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

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



-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.



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: Save a deployment template



PS C:\\>Save-AzureRmResourceGroupDeploymentTemplate -DeploymentName "TestDeployment" -ResourceGroupName "TestGroup"



This command gets the deployment template from TestDeployment and saves it as a JSON file in the current directory.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... nttemplate