Extensions.RollbackComposeDeploymentUpgradeAsync Method

Definition

Namespace:

Microsoft.ServiceFabric.Preview.Client

Assembly:

Microsoft.ServiceFabric.Preview.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

RollbackComposeDeploymentUpgradeAsync(FabricClient+ComposeDeploymentClient, ComposeDeploymentRollbackDescription)	Starts rolling back the current compose deployment upgrade.
RollbackComposeDeploymentUpgradeAsync(FabricClient+ComposeDeploymentClient, ComposeDeploymentRollbackDescription, TimeSpan)	Starts rolling back the current compose deployment upgrade.
RollbackComposeDeploymentUpgradeAsync(FabricClient+ComposeDeploymentClient, ComposeDeploymentRollbackDescription, TimeSpan, CancellationToken)	Starts rolling back the current compose deployment upgrade.

RollbackComposeDeploymentUpgradeAsync(FabricClient+ComposeDeploymentClient, ComposeDeploymentRollbackDescription)

Starts rolling back the current compose deployment upgrade.

public static System.Threading.Tasks.Task RollbackComposeDeploymentUpgradeAsync (this System.Fabric.FabricClient.ComposeDeploymentClient client, Microsoft.ServiceFabric.Preview.Client.Description.ComposeDeploymentRollbackDescription description);

static member RollbackComposeDeploymentUpgradeAsync : System.Fabric.FabricClient.ComposeDeploymentClient * Microsoft.ServiceFabric.Preview.Client.Description.ComposeDeploymentRollbackDescription -> System.Threading.Tasks.Task

<Extension()>
Public Function RollbackComposeDeploymentUpgradeAsync (client As FabricClient.ComposeDeploymentClient, description As ComposeDeploymentRollbackDescription) As Task

Parameters

client

FabricClient.ComposeDeploymentClient

FabricClient object.

description

ComposeDeploymentRollbackDescription

The ComposeDeploymentRollbackDescription that determines which compose deployment should be rolled back.

Returns

Task

A Task representing the operation.

Exceptions

FabricElementNotFoundException

ComposeDeploymentNotFound: The compose deployment does not exist.

FabricException

ComposeDeploymentNotUpgrading: There is no pending upgrade for the specified compose deployment to rollback.

RollbackComposeDeploymentUpgradeAsync(FabricClient+ComposeDeploymentClient, ComposeDeploymentRollbackDescription, TimeSpan)

Starts rolling back the current compose deployment upgrade.

public static System.Threading.Tasks.Task RollbackComposeDeploymentUpgradeAsync (this System.Fabric.FabricClient.ComposeDeploymentClient client, Microsoft.ServiceFabric.Preview.Client.Description.ComposeDeploymentRollbackDescription description, TimeSpan timeout);

static member RollbackComposeDeploymentUpgradeAsync : System.Fabric.FabricClient.ComposeDeploymentClient * Microsoft.ServiceFabric.Preview.Client.Description.ComposeDeploymentRollbackDescription * TimeSpan -> System.Threading.Tasks.Task

<Extension()>
Public Function RollbackComposeDeploymentUpgradeAsync (client As FabricClient.ComposeDeploymentClient, description As ComposeDeploymentRollbackDescription, timeout As TimeSpan) As Task

Parameters

client

FabricClient.ComposeDeploymentClient

FabricClient object.

description

ComposeDeploymentRollbackDescription

The ComposeDeploymentRollbackDescription that determines which compose deployment should be rolled back.

timeout

TimeSpan

Defines the maximum amount of time the system will allow this operation to continue before returning System.TimeoutException.

Returns

Task

A Task representing the operation.

Exceptions

FabricElementNotFoundException

ComposeDeploymentNotFound: The compose deployment does not exist.

FabricException

ComposeDeploymentNotUpgrading: There is no pending upgrade for the specified compose deployment to rollback.

RollbackComposeDeploymentUpgradeAsync(FabricClient+ComposeDeploymentClient, ComposeDeploymentRollbackDescription, TimeSpan, CancellationToken)

Starts rolling back the current compose deployment upgrade.

public static System.Threading.Tasks.Task RollbackComposeDeploymentUpgradeAsync (this System.Fabric.FabricClient.ComposeDeploymentClient client, Microsoft.ServiceFabric.Preview.Client.Description.ComposeDeploymentRollbackDescription description, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

static member RollbackComposeDeploymentUpgradeAsync : System.Fabric.FabricClient.ComposeDeploymentClient * Microsoft.ServiceFabric.Preview.Client.Description.ComposeDeploymentRollbackDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task

<Extension()>
Public Function RollbackComposeDeploymentUpgradeAsync (client As FabricClient.ComposeDeploymentClient, description As ComposeDeploymentRollbackDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task

Parameters

client

FabricClient.ComposeDeploymentClient

FabricClient object.

description

ComposeDeploymentRollbackDescription

The ComposeDeploymentRollbackDescription that determines which compose deployment should be rolled back.

timeout

TimeSpan

Defines the maximum amount of time the system will allow this operation to continue before returning System.TimeoutException.

cancellationToken

CancellationToken

The CancellationToken that the operation is observing. It can be used to propagate notification that the operation should be canceled.

Returns

Task

A Task representing the operation.

Exceptions

FabricElementNotFoundException

ComposeDeploymentNotFound: The compose deployment does not exist.

FabricException

ComposeDeploymentNotUpgrading: There is no pending upgrade for the specified compose deployment to rollback.