Share via

Start-ServiceFabricComposeDeploymentRollback

  • Reference
Module:
ServiceFabric

PREVIEW. Starts rolling back a Service Fabric compose deployment upgrade.

Syntax

Start-ServiceFabricComposeDeploymentRollback
     [-DeploymentName] <String>
     [-TimeoutSec <Int32>]
     [<CommonParameters>]

Description

This cmdlet is in PREVIEW and is subject to change in the next release(s). There is no compatibility guarantee.

The Start-ServiceFabricComposeDeploymentRollback cmdlet manually starts rolling back a pending compose deployment upgrade in Service Fabric. To monitor the status of the rollback, use the Get-ServiceFabricComposeDeploymentUpgrade cmdlet.

Before you perform any operation on a Service Fabric cluster, establish a connection to the cluster by using the Connect-ServiceFabricCluster cmdlet.

For guidance of Service Fabric compose deployment, please refer to: Compose Deployment support in Service Fabric

Examples

Example 1

PS C:\> Start-ServiceFabricComposeDeploymentRollback -DeploymentName mydeployment

The command starts rolling back the pending upgrade of the compose deployment that has the deployment name "mydeployment". The compose deployment upgrade can be interrupted for rollback during ProvisioningTarget and RollingForward states. Upgrade cannot be interrupted once it enters the UnprovisioningCurrent state.

To start a compose deployment upgrade, use the Start-ServiceFabricComposeDeploymentUpgrade

Parameters

-DeploymentName

Specifies the name of compose deployment. To get the name of the currently compose deployment, use Get-ServiceFabricComposeDeploymentStatus. The cmdlet starts rolling back the pending upgrade of the compose deployment that has the deployment name that you specify.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-TimeoutSec

Specifies the time-out period, in seconds, for the operation. If the operation times out, the state of the compose deployment is undetermined. The default value is 120 seconds.

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

Inputs

None

Outputs

System.Object