Get-AzTenantDeployment
Get deployment at tenant scope
Syntax
GetByDeploymentName (Default)
Get-AzTenantDeployment
[[-Name] <String>]
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
GetByDeploymentId
Get-AzTenantDeployment
-Id <String>
[-Pre]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzTenantDeployment cmdlet gets the deployments at the tenant scope. Specify the Name or Id parameter to filter the results. By default, Get-AzTenantDeployment gets all deployments at the tenant scope.
Examples
Example 1: Get all deployments at the tenant scope
Get-AzTenantDeployment
This command gets all deployments at the current tenant scope.
Example 2: Get a deployment by name
Get-AzDeployment -Name "Deploy01"
This command gets the "Deploy01" deployment at the current tenant scope. You can assign a name to a deployment when you create it by using the New-AzTenantDeployment cmdlets. If you do not assign a name, the cmdlets provide a default name based on the template that is used to create the deployment.
Example 3: Get a deployment by ID
Get-AzDeployment -Id "/providers/Microsoft.Resources/deployments/Deploy01"
This command gets the "Deploy01" deployment at the tenant scope.
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 |
-Id
The fully qualified resource Id of the deployment. example: /providers/Microsoft.Resources/deployments/{deploymentName}
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DeploymentId, ResourceId |
Parameter sets
GetByDeploymentId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The name of deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| 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 |
-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 |
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.
