Edit

Share via

Restart-AzureRmDeploymentManagerRollout

  • Reference
Module:
AzureRM.DeploymentManager

Restart a failed rollout.

Syntax

Restart-AzureRmDeploymentManagerRollout
       [-ResourceGroupName] <String>
       [-Name] <String>
       [-SkipSucceeded]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restart-AzureRmDeploymentManagerRollout
       [-ResourceId] <String>
       [-SkipSucceeded]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restart-AzureRmDeploymentManagerRollout
       [-Rollout] <PSRollout>
       [-SkipSucceeded]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Restart-AzureRmDeploymentManagerRollout cmdlet restarts a failed 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. Optional parameter SkipSucceeded allows you to skip all the succeeded steps in the previous run of the rollout.

Examples

Example 1

PS C:\> Restart-AzureRmDeploymentManagerRollout -ResourceGroupName ContosoResourceGroup -Name ContosoRollout -SkipSucceeded

This command restarts a rollout named ContosoRollout in the ContosoResourceGroup. The SkipSucceeded flag indicates that all the steps that already ran successfully should be skipped and the rollout should continue execution from where it last failed.

Example 2: Restart a rollout using the resource identifier

PS C:\> Restart-AzureRmDeploymentManagerRollout -ResourceId "/subscriptions/subscriptionId/resourcegroups/ContosoResourceGroup/providers/Microsoft.DeploymentManager/rollouts/ContosoRollout"

This command restarts a rollout named ContosoRollout in the ContosoResourceGroup.

Example 3: Restart a rollout using the rollout object.

PS C:\> Get-AzureRmDeploymentManagerRollout -Rollout $rolloutObject

This command restarts a rollout whose name and ResourceGroup match the Name and ResourceGroupName properties of the $rolloutObject, respectively.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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

-Rollout

The resource to be removed.

Type:Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SkipSucceeded

Skip steps that succeeded in the previous run of the rollout.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout

Outputs

Microsoft.Azure.Commands.DeploymentManager.Models.PSRollout