Edit

Get-AzSubDeployment

Get a single subscription-scope deployment by name, or list all deployments in a subscription.

Syntax

List (Default)

Get-AzSubDeployment
    [[-Name] <string>]
    [-SubscriptionId <string>]
    [-Profile <string>]
    [<CommonParameters>]

Get

Get-AzSubDeployment
    [-Name] <string>
    [-SubscriptionId <string>]
    [-Profile <string>]
    [<CommonParameters>]

GetByInputObject

Get-AzSubDeployment
    -InputObject <DeploymentExtended>
    [-Profile <string>]
    [<CommonParameters>]

Aliases

This cmdlet has the following aliases, Get-AzSubscriptionDeployment

Description

Retrieves Azure Resource Manager deployments scoped to a subscription. Supply -Name to get a single deployment; omit it to list every subscription-scope deployment. Pipe a deployment object to read it again from the subscription in its Id, for example to refresh its provisioning state. Resource group deployments are not included; use Get-AzResourceGroupDeployment for those. With -Name or no name, the subscription defaults to the active profile's subscription unless -SubscriptionId is supplied.

Examples

Get a single deployment

Retrieve the subscription-scope deployment named sub-infra-2026-06-18.

Get-AzSubDeployment -Name sub-infra-2026-06-18

List every deployment in a subscription

Omit -Name to enumerate all subscription-scope deployments.

Get-AzSubDeployment -SubscriptionId 00000000-0000-0000-0000-000000000000

Refresh a piped deployment

Read each listed deployment again from the subscription in its Id.

Get-AzSubDeployment -SubscriptionId 00000000-0000-0000-0000-000000000000 | Get-AzSubDeployment

Parameters

-InputObject

A deployment object returned by Get-AzSubDeployment. Its Id identifies the subscription and deployment to retrieve. Accepts pipeline input.

Parameter properties

Type:Microsoft.Azure.Azclips.Extensions.Resources.Models.DeploymentExtended
Supports wildcards:False
DontShow:False

Parameter sets

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

-Name

The name of the deployment to retrieve. When supplied the cmdlet gets that single deployment; when omitted it lists every subscription-scope deployment.

Parameter properties

Type:String
Supports wildcards:False
DontShow:False
Aliases:DeploymentName

Parameter sets

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

-Profile

Name of a saved profile to use for this call instead of the currently-active one. Manage profiles with Set-AzProfile / Get-AzProfile.

Parameter properties

Type:String
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

-SubscriptionId

The Azure subscription that owns the deployment. Defaults to the active profile's subscription when omitted.

Parameter properties

Type:String
Supports wildcards:False
DontShow:False

Parameter sets

Get
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
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

Microsoft.Azure.Azclips.Extensions.Resources.Models.DeploymentExtended

Accepts a subscription deployment object from the pipeline, for example the output of Get-AzSubDeployment.

Outputs

Microsoft.Azure.Azclips.Extensions.Resources.Models.DeploymentExtended

A DeploymentExtended for each matching deployment. The Get and GetByInputObject parameter sets emit exactly one object per deployment; the List parameter set emits one object per deployment, following paged results automatically.

Notes

This is a read-only operation. The legacy Az.Resources name Get-AzSubscriptionDeployment is accepted as an alias.