Save-AzDeploymentTemplate

Reference

Module:: Az.Resources

Saves a deployment template to a file.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Save-AzDeploymentTemplate
    -DeploymentName <String>
    [-Path <String>]
    [-Force]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Save-AzDeploymentTemplate
    -DeploymentObject <PSDeployment>
    [-Path <String>]
    [-Force]
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Save-AzDeploymentTemplate cmdlet saves a deployment template to a JSON file.

Examples

Example 1

PS C:\> Save-AzDeploymentTemplate -DeploymentName "TestDeployment"

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

Example 2: Get a deployment and save its template

PS C:\>Get-AzDeployment -Name "RolesDeployment" | Save-AzDeploymentTemplate

This command gets the deployment "RolesDeployment" at the current subscription scope and saves its template.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DeploymentName

The deployment name.

Type:	String
Aliases:	Name
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-DeploymentObject

The deployment object.

Type:	PSDeployment
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-Force

Do not ask for confirmation.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

The output path of the template file.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Pre

When set, indicates that the cmdlet should use pre-release API versions when automatically determining which version to use.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSDeployment

Outputs

PSTemplatePath