Get-AzManagementGroupDeployment
Gets management-group deployments.
Syntax
GetByDeploymentName (Default)
Get-AzManagementGroupDeployment
[-ManagementGroupId] <string>
[[-Name] <string>]
[-Profile <string>]
[<CommonParameters>]
GetByDeploymentId
Get-AzManagementGroupDeployment
-Id <string>
[-Profile <string>]
[<CommonParameters>]
Aliases
This cmdlet has no aliases.
Description
Lists deployments when only -ManagementGroupId is supplied. Gets one deployment when
-ManagementGroupId and -Name, or a full deployment -Id, are supplied.
List results are written as individual deployment objects.
Examples
Example 1
Lists all deployments recorded at a management group.
Get-AzManagementGroupDeployment -ManagementGroupId myManagementGroup
Example 2
Gets one deployment by management group and name.
Get-AzManagementGroupDeployment -ManagementGroupId myManagementGroup -Name myDeployment
Example 3
Gets one deployment by full resource ID.
$id = '/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Resources/deployments/myDeployment'
Get-AzManagementGroupDeployment -Id $id
Parameters
-Id
The full management-group deployment resource ID, for example
/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Resources/deployments/myDeployment.
Use this instead of -ManagementGroupId and -Name.
Parameter properties
| Type: | String |
| 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 |
-ManagementGroupId
The management group ID.
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetByDeploymentName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
The deployment name. Omit it to list deployments.
Parameter properties
| Type: | String |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DeploymentName |
Parameter sets
GetByDeploymentName
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Profile
The AzClips profile to use instead of 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 |
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
Returns one or more management-group deployment objects.
Notes
The full ID form must identify a Microsoft.Resources/deployments resource beneath a
Microsoft.Management/managementGroups scope.
-Id also accepts the aliases -DeploymentId and -ResourceId; -Name accepts -DeploymentName.
The legacy -Pre switch is not supported.