< Back
Get-AzureRmResourceGroupDeployment
Post
NAME Get-AzureRmResourceGroupDeployment
SYNOPSIS
Gets the deployments in a resource group.
SYNTAX
Get-AzureRmResourceGroupDeployment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] -Id <String> [-Pre] [<CommonParameters>]
Get-AzureRmResourceGroupDeployment [-ResourceGroupName] <String> [[-Name] <String>] [-ApiVersion <String>] [-DefaultProfile
<IAzureContextContainer>] [-Pre] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmResourceGroupDeployment cmdlet gets the deployments in an Azure resource group. Specify the Name or Id parameter to filter the
results. By default, Get-AzureRmResourceGroupDeployment gets all deployments for a specified resource group.
An Azure resource is a user-managed Azure entity, such as a database server, database, or web site. An Azure resource group is a collection of
Azure resources that are deployed as a unit.
A deployment is the operation that makes the resources in the resource group available for use. For more information about Azure resources and
Azure resource groups, see the New-AzureRmResourceGroup cmdlet.
You can use this cmdlet for tracking. For debugging, use this cmdlet with the Get-AzureRmLog cmdlet.
PARAMETERS
-ApiVersion <String>
Specifies the API version that is supported by the resource Provider. You can specify a different version than the default version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the resource group deployment to get.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the deployment to get. Wildcard characters are not permitted.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group. The cmdlet gets the deployments for the resource group that this parameter specifies. Wildcard
characters are not permitted. This parameter is required and you can specify only one resource group in each command.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Azure.Commands.ResourceManagement.Models.PSResourceGroupDeployment
The cmdlet returns resource group deployments.
NOTES
Example 1: Get all deployments for a resource group
PS C:\\>Get-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoLabsRG"
This command gets all deployments for the ContosoLabsRG resource group. The output shows a deployment for a WordPress blog that used a gallery
template.
Example 2: Get a deployment by name
PS C:\\>Get-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoLabsRG" -Name "DeployWebsite01"
This command gets the DeployWebsite01 deployment of the ContosoLabsRG resource group. You can assign a name to a deployment when you create it by
using the New-AzureRmResourceGroup or New-AzureRmResourceGroupDeployment 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 the deployments of all resource groups
PS C:\\>Get-AzureRmResourceGroup | Get-AzureRmResourceGroupDeployment | Format-Table ResourceGroupName, DeploymentName, ProvisioningState
This command gets all resource groups in your subscription by using the Get-AzureRmResourceGroup cmdlet. The command passes the resource groups to
the current cmdlet by using the pipeline operator. The current cmdlet gets all deployments of all resource groups in the subscription, and passes
the results to the Format-Table cmdlet to display their ResourceGroupName , DeploymentName , and ProvisioningState property values.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Get-AzureRmResourceGroup
New-AzureRmResourceGroup
New-AzureRmResourceGroupDeployment
Remove-AzureRmResourceGroupDeployment
Stop-AzureRmResourceGroupDeployment
Test-AzureRmResourceGroupDeployment
SYNOPSIS
Gets the deployments in a resource group.
SYNTAX
Get-AzureRmResourceGroupDeployment [-ApiVersion <String>] [-DefaultProfile <IAzureContextContainer>] -Id <String> [-Pre] [<CommonParameters>]
Get-AzureRmResourceGroupDeployment [-ResourceGroupName] <String> [[-Name] <String>] [-ApiVersion <String>] [-DefaultProfile
<IAzureContextContainer>] [-Pre] [<CommonParameters>]
DESCRIPTION
The Get-AzureRmResourceGroupDeployment cmdlet gets the deployments in an Azure resource group. Specify the Name or Id parameter to filter the
results. By default, Get-AzureRmResourceGroupDeployment gets all deployments for a specified resource group.
An Azure resource is a user-managed Azure entity, such as a database server, database, or web site. An Azure resource group is a collection of
Azure resources that are deployed as a unit.
A deployment is the operation that makes the resources in the resource group available for use. For more information about Azure resources and
Azure resource groups, see the New-AzureRmResourceGroup cmdlet.
You can use this cmdlet for tracking. For debugging, use this cmdlet with the Get-AzureRmLog cmdlet.
PARAMETERS
-ApiVersion <String>
Specifies the API version that is supported by the resource Provider. You can specify a different version than the default version.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <String>
Specifies the ID of the resource group deployment to get.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the deployment to get. Wildcard characters are not permitted.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Pre [<SwitchParameter>]
Indicates that this cmdlet considers pre-release API versions when it automatically determines which version to use.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of a resource group. The cmdlet gets the deployments for the resource group that this parameter specifies. Wildcard
characters are not permitted. This parameter is required and you can specify only one resource group in each command.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Azure.Commands.ResourceManagement.Models.PSResourceGroupDeployment
The cmdlet returns resource group deployments.
NOTES
Example 1: Get all deployments for a resource group
PS C:\\>Get-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoLabsRG"
This command gets all deployments for the ContosoLabsRG resource group. The output shows a deployment for a WordPress blog that used a gallery
template.
Example 2: Get a deployment by name
PS C:\\>Get-AzureRmResourceGroupDeployment -ResourceGroupName "ContosoLabsRG" -Name "DeployWebsite01"
This command gets the DeployWebsite01 deployment of the ContosoLabsRG resource group. You can assign a name to a deployment when you create it by
using the New-AzureRmResourceGroup or New-AzureRmResourceGroupDeployment 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 the deployments of all resource groups
PS C:\\>Get-AzureRmResourceGroup | Get-AzureRmResourceGroupDeployment | Format-Table ResourceGroupName, DeploymentName, ProvisioningState
This command gets all resource groups in your subscription by using the Get-AzureRmResourceGroup cmdlet. The command passes the resource groups to
the current cmdlet by using the pipeline operator. The current cmdlet gets all deployments of all resource groups in the subscription, and passes
the results to the Format-Table cmdlet to display their ResourceGroupName , DeploymentName , and ProvisioningState property values.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Get-AzureRmResourceGroup
New-AzureRmResourceGroup
New-AzureRmResourceGroupDeployment
Remove-AzureRmResourceGroupDeployment
Stop-AzureRmResourceGroupDeployment
Test-AzureRmResourceGroupDeployment