FabricClient.ClusterManagementClient.ValidateFabricUpgradeAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

ValidateFabricUpgradeAsync(FabricUpgradeDescription)	Validate the supplied upgrade parameters and assess the expected impact of a code or configuration version upgrade of a Service Fabric cluster. The upgrade will not be initiated.
ValidateFabricUpgradeAsync(FabricUpgradeDescription, TimeSpan, CancellationToken)	Validate the supplied upgrade parameters and assess the expected impact of a code or configuration version upgrade of a Service Fabric cluster. The upgrade will not be initiated.

ValidateFabricUpgradeAsync(FabricUpgradeDescription)

Validate the supplied upgrade parameters and assess the expected impact of a code or configuration version upgrade of a Service Fabric cluster.

The upgrade will not be initiated.

public System.Threading.Tasks.Task<System.Fabric.Description.ValidateFabricUpgradeResult> ValidateFabricUpgradeAsync (System.Fabric.Description.FabricUpgradeDescription upgradeDescription);

member this.ValidateFabricUpgradeAsync : System.Fabric.Description.FabricUpgradeDescription -> System.Threading.Tasks.Task<System.Fabric.Description.ValidateFabricUpgradeResult>

Public Function ValidateFabricUpgradeAsync (upgradeDescription As FabricUpgradeDescription) As Task(Of ValidateFabricUpgradeResult)

Parameters

upgradeDescription

FabricUpgradeDescription

The description of the upgrade.

Returns

Task<ValidateFabricUpgradeResult>

The upgrade validation result

Exceptions

FabricObjectClosedException

The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.

ValidateFabricUpgradeAsync(FabricUpgradeDescription, TimeSpan, CancellationToken)

Validate the supplied upgrade parameters and assess the expected impact of a code or configuration version upgrade of a Service Fabric cluster.

The upgrade will not be initiated.

public System.Threading.Tasks.Task<System.Fabric.Description.ValidateFabricUpgradeResult> ValidateFabricUpgradeAsync (System.Fabric.Description.FabricUpgradeDescription upgradeDescription, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.ValidateFabricUpgradeAsync : System.Fabric.Description.FabricUpgradeDescription * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Description.ValidateFabricUpgradeResult>

Public Function ValidateFabricUpgradeAsync (upgradeDescription As FabricUpgradeDescription, timeout As TimeSpan, cancellationToken As CancellationToken) As Task(Of ValidateFabricUpgradeResult)

Parameters

upgradeDescription

FabricUpgradeDescription

The description of the upgrade.

timeout

TimeSpan

The timespan that defines the maximum amount of time Service Fabric will allow this operation to continue before returning a TimeoutException.

cancellationToken

CancellationToken

The cancellation token that the operation is observing. It can be used to send a notification that the operation should be canceled. Note that cancellation is advisory and that the operation may still be completed even if it is cancelled.

Returns

Task<ValidateFabricUpgradeResult>

The upgrade validation result

Exceptions

FabricObjectClosedException

The FabricClient object is in a closed state. Dispose of the FabricClient object you are using and instantiate a new FabricClient object.