Edit

Get-AzTenantDeployment

Get deployments at tenant scope.

Syntax

GetByDeploymentName (Default)

Get-AzTenantDeployment
    [[-Name] <string>]
    [-Profile <string>]
    [<CommonParameters>]

ListByFilter

Get-AzTenantDeployment
    -Filter <string>
    [-Profile <string>]
    [<CommonParameters>]

Aliases

This cmdlet has no aliases.

Description

Without -Name, lists every deployment at tenant scope, following all pages of results. With -Name, gets that deployment and fails if it does not exist. With -Filter, lists the deployments that match an OData filter, for example by provisioning state.

Examples

List all tenant deployments

Get-AzTenantDeployment

Get a deployment by name

Get-AzTenantDeployment -Name tenant-infra

List succeeded deployments

Get-AzTenantDeployment -Filter "provisioningState eq 'Succeeded'"

Parameters

-Filter

An OData filter sent to the tenant deployment list API, for example "provisioningState eq 'Succeeded'".

Parameter properties

Type:String
Supports wildcards:False
DontShow:False

Parameter sets

ListByFilter
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. Lists every tenant deployment when omitted.

Parameter properties

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

Parameter sets

GetByDeploymentName
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

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

None

This cmdlet does not accept pipeline input.

Outputs

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

One DeploymentExtended object per deployment.

Notes

Differences from Az.Resources: the cmdlet returns the DeploymentExtended model instead of PSDeployment. -Id and -Pre are not supported. -Filter is an Azclips addition that matches az deployment tenant list --filter.