Get-AzResourceGroupDeploymentStack

Module:

Az.Resources Module

Gets Resource Group scoped Deployment Stacks.

Syntax

ListByResourceGroupName (Default)

Get-AzResourceGroupDeploymentStack
    [-ResourceGroupName] <String>
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetByResourceId

Get-AzResourceGroupDeploymentStack
    -ResourceId <String>
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

GetByName

Get-AzResourceGroupDeploymentStack
    [-ResourceGroupName] <String>
    [-Name] <String>
    [-Pre]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Retrieve a resource group scoped deployment stack.

Examples

Example 1: Retrieve a stack named MyRGStack from the resource group MyResourceGroup

Get-AzResourceGroupDeploymentStack -ResourceGroupName MyResourceGroup -Name MyRGStack

Get a deployment stack named 'MyRGStack' under an RG named 'MyResourceGroup'.

Parameters

-DefaultProfile

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

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

The name of the DeploymentStack to get

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	StackName

Parameter sets

GetByName

Position:	1
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-Pre

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

The id of the ResourceGroup where the DeploymentStack is deployed

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ListByResourceGroupName

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

GetByName

Position:	0
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

-ResourceId

ResourceId of the DeploymentStack to get

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Id

Parameter sets

GetByResourceId

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

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.

Inputs

String

Outputs

PSDeploymentStack