Edit

Get-AzResourceGroupDeployment

Get a single resource group deployment by name, or list all deployments in a resource group.

Syntax

List

Get-AzResourceGroupDeployment
    [-ResourceGroupName] <string>
    [-SubscriptionId <string>]
    [-Profile <string>]
    [<CommonParameters>]

Get

Get-AzResourceGroupDeployment
    [-ResourceGroupName] <string>
    [-Name] <string>
    [-SubscriptionId <string>]
    [-Profile <string>]
    [<CommonParameters>]

GetById

Get-AzResourceGroupDeployment
    -Id <string>
    [-Profile <string>]
    [<CommonParameters>]

Description

Retrieves Azure Resource Manager deployments scoped to a resource group. Supply -Name to get a single deployment, or -Id with the deployment's fully qualified resource id; omit both to list every deployment in the resource group. The returned DeploymentExtended objects carry the ARM shape (Name, Properties.*) plus top-level DeploymentName, ResourceGroupName, ProvisioningState, Timestamp, Mode, CorrelationId, Parameters, Outputs, TemplateLink, and OnErrorDeployment properties for compatibility with Az.Resources scripts. The subscription defaults to the active profile's subscription unless -SubscriptionId is supplied.

Examples

Get a single deployment

Retrieve the deployment named infra-prod-2026-06-18 from resource group myrg.

Get-AzResourceGroupDeployment -ResourceGroupName myrg -Name infra-prod-2026-06-18

List every deployment in a resource group

Omit -Name to enumerate all deployments in myrg.

Get-AzResourceGroupDeployment -ResourceGroupName myrg

Read the outputs of a deployment

Retrieve a deployment and inspect the values its template returned.

$deployment = Get-AzResourceGroupDeployment -ResourceGroupName myrg -Name infra-prod-2026-06-18
$deployment.Outputs

Get a deployment by resource id

Get-AzResourceGroupDeployment -Id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.Resources/deployments/infra-prod-2026-06-18

Parameters

-Id

The fully qualified resource id of the deployment, in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}.

Parameter properties

Type:String
Supports wildcards:False
DontShow:False
Aliases:DeploymentId, ResourceId

Parameter sets

GetById
Position:Named
Mandatory:True
Value from pipeline:False
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 deployment in the resource group.

Parameter properties

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

Parameter sets

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

-Profile

Use the named profile for this command, overriding the active profile.

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

-ResourceGroupName

The name of the resource group that contains the deployments.

Parameter properties

Type:String
Supports wildcards:False
DontShow:False

Parameter sets

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

-SubscriptionId

Azure subscription id. Defaults to the active profile's subscription.

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

String

You can pipe the ResourceGroupName and Name values to this cmdlet by property name, for example the output of Get-AzResourceGroupDeployment.

Outputs

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

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

Notes

This is a read-only operation. Use New-AzResourceGroupDeployment to create a deployment and New-AzResourceGroupDeploymentWhatIf to preview one.