Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Get-AzureResourceGroupDeployment

Get-AzureResourceGroupDeployment

microsoft.azure.commands.resources.dll

Synopsis

Gets the deployments in a resource group.

Syntax

Get-AzureResourceGroupDeployment [-ResourceGroupName] [-Name] [-ProvisioningState] [<CommonParameters>]

Detailed Description

The Get-AzureResourceGroupDeployment cmdlet gets the deployments in an Azure resource group. You can use the Name (DeploymentName) and ProvisioningState parameters to filter the deployments. By default, Get-AzureResourceGroupDeployment returns 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.This cmdlet is very useful for tracking. For debugging, use it with the Get-AzureResourceGroupLog cmdlet.

Parameters

-ResourceGroupName <String>

Gets the deployments for the specified resource group. Wildcards are not permitted. This parameter is required and you can specify only one resource group in each command.

Aliases

None

Required?

true

Position

0

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Gets only the deployment with the specified name. Wildcards are not permitted. This parameter is optional. By default, Get-AzureResourceGroupDeployment returns all deployments for the specified resource group.

Aliases

None

Required?

false

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-ProvisioningState <String>

Gets only the deployments with the specified provisioning state. Valid values include, but are not limited to: Canceled, Deprovisioning, Failed, NotProvisioned, Provisioned, Provisioning, and Succeeded. This parameter is optional. By default, Get-AzureResourceGroupDeployment returns all deployments for the specified resource group.

Aliases

None

Required?

false

Position

2

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

Microsoft.Azure.Commands.ResourceManagement.Models. PSResourceGroupDeployment

Notes

The Get-AzureResourceGroupDeployment cmdlet is included in the Azure Resource Manager module beginning in module version 0.8.0.

Examples

-------------------------- Example 1: Get all deployments for a resource group --------------------------

This command gets all deployments for the ContosoLabsRG resource group. The output shows a deployment for a WordPress blog that used a gallery template.

PS C:\>Get-AzureResourceGroupDeployment -ResourceGroupName ContosoLabsRG
DeploymentName    : WordPress.WordPress
ResourceGroupName : ContosoLabsRG
ProvisioningState : Succeeded
Timestamp         : 3/26/2014 1:56:55 AM
Mode              : Incremental
TemplateLink      : 
                    Uri            : https://gallerystoreprodch.blob.core.windows.net/prod-microsoft-windowsazure-gallery/8D6B920B-10F4-4B5A-B3DA-9D398FBCF3EE.PUBLICGALLERYITEMS.WORDPRESS.WORDPRESS.0.1.0-PREVIEW1/Deplo                  ymentTemplates/Website_NewHostingPlanBasicStandard_MySQL_NewDB.json
                    ContentVersion : 1.0.0.0


Parameters        : 
                    Name             Type                       Value
                    ===============  =========================  ==========
                    siteName         String                     wordpress-group-ws01
                    hostingPlanName  String                     Plan
                    siteMode         String                     Limited
                    computeMode      String                     Dedicated
                    siteLocation     String                     North Europe
                    sku              String                     Standard
                    workerSize       String                     0
                    databaseName     String                     wordpressgroupdbwp1
                    databaseLocation  String                    North Europe
                    databaseSku      String
                    subscriptionId   String                     c9cbd920-c00c-427c-852b-8aaf38babcde
                    resourceGroup    String                     ContosoLabsRG
                    dbSubscriptionId  String                    c9cbd920-c00c-427c-852b-8aaf38babcde
                    dbResourceGroup  String                     WordPress-Group
                    autoscaleEnabled  Bool                      True
Outputs           :

-------------------------- Example 2: Get a deployment by name --------------------------

This command gets the DeployWebsite1 deployment of the ContosoLabsRG resource group. You can assign a name to a deployment when you create it by using the New-AzureResourceGroup or New-AzureResourceGroupDeployment cmdlets. If you do not assign a name, the cmdlets provide a default name based on the template used to create the deployment.

PS C:\>Get-AzureResourceGroupDeployment -ResourceGroupName ContosoLabsRG -Name DeployWebsite1

-------------------------- Example 3: Get a deployment by provisioning state --------------------------

This command gets the deployments of the ContosoLabsRG resource group that are not yet provisioned.

PS C:\>Get-AzureResourceGroupDeployment -ResourceGroupName ContosoLabsRG -ProvisioningState NotProvisioned

-------------------------- Example 4: Get the deployments of all resource groups --------------------------

This command gets all deployments of all resource groups in the subscription and formats them in a table with their ResourceGroupName, DeploymentName and ProvisioningState property values.

PS C:\>Get-AzureResourceGroup | Get-AzureResourceGroupDeployment | Format-Table ResourceGroupName, DeploymentName, ProvisioningState
ResourceGroupName                   DeploymentName                          ProvisioningState
-----------------                   --------------                          -----------------
ContosoAppa001                      Microsoft.WebSiteSQLDatabase.0.1.0-p... Succeeded
ContosoAppa001                      DBUpdated                               Canceled
DevTest001                          CakeSoftwareFoundation.CakePHP.0.1.0... Succeeded
LabDeploy001                        Ghost.Ghost.0.1.0-preview1              Succeeded
ContosoDB                           CLrg001depl001                          Succeeded
ContosoBlog                         WordPress.WordPress.0.1.0-preview1      Succeeded
ContosoLabsRG                       WordPress.WordPress                     Succeeded

Online Version