Get-AzureRmDeploymentManagerRollout
Gets a rollout.
Syntax
Get-AzureRmDeploymentManagerRollout
[-ResourceGroupName] <String>
[-Name] <String>
[[-RetryAttempt] <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDeploymentManagerRollout
[-ResourceId] <String>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureRmDeploymentManagerRollout
[-Rollout] <PSRollout>
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzureRmDeploymentManagerRollout cmdlet gets a rollout, and returns an object that represents that rollout with all the detailed information on the progress of the rollout. Specify the rollout by its name and resource group name. Alternately, you can provide the Rollout object or the ResourceId.
Examples
Example 1
PS C:\> Get-AzureRmDeploymentManagerRollout -ResourceGroupName ContosoResourceGroup -Name ContosoRollout
This command gets a rollout named ContosoRollout in the ContosoResourceGroup.
Example 2: Get a rollout using the resource identifier
PS C:\> Get-AzureRmDeploymentManagerRollout -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/rollouts/ContosoRollout"
This command gets a rollout named ContosoRollout in the ContosoResourceGroup.
Example 3: Get a rollout using the rollout object.
PS C:\> Get-AzureRmDeploymentManagerRollout -Rollout $rolloutObject
This command gets a rollout whose name and ResourceGroup match the Name and ResourceGroupName properties of the $rolloutObject, respectively.
Parameters
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
The name of the rollout.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
The resource group.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceId
The resource identifier.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-RetryAttempt
The retry attempt of the rollout.
Type: | Nullable<T>[Int32] |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Rollout
Rollout object.
Type: | Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Inputs
None
Outputs
Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout