FabricClient.ClusterManagementClient.DeactivateNodeAsync Method

Definition

Namespace:

System.Fabric

Assembly:

System.Fabric.dll

Package:

Microsoft.ServiceFabric v9.1.1833

Overloads

DeactivateNodeAsync(String, NodeDeactivationIntent)	Deactivates a particular node with the specified NodeDeactivationIntent.
DeactivateNodeAsync(String, NodeDeactivationIntent, TimeSpan, CancellationToken)	Deactivates a particular node with the specified NodeDeactivationIntent.

DeactivateNodeAsync(String, NodeDeactivationIntent)

Deactivates a particular node with the specified NodeDeactivationIntent.

public System.Threading.Tasks.Task DeactivateNodeAsync (string nodeName, System.Fabric.NodeDeactivationIntent deactivationIntent);

member this.DeactivateNodeAsync : string * System.Fabric.NodeDeactivationIntent -> System.Threading.Tasks.Task

Public Function DeactivateNodeAsync (nodeName As String, deactivationIntent As NodeDeactivationIntent) As Task

Parameters

nodeName

String

The name of the node to deactivate.

deactivationIntent

NodeDeactivationIntent

The NodeDeactivationIntent for deactivating the node.

Returns

Task

A Task that represents the asynchronous acknowledgment of the request.

Exceptions

FabricObjectClosedException

See https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/ for handling common FabricClient failures.

TimeoutException

See https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/ for handling common FabricClient failures.

FabricException

See also https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/ for handling common FabricClient failures.

Remarks

When this API completes it implies that the intent to deactivate has been registered by the system. It does not mean that the deactivation is complete. The progress of the operation can be determined by using the GetNodeListAsync() API

Once the deactivation is in progress, the deactivation intent can be “increased” but not decreased (for example, a node which is was deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated via ActivateNodeAsync(String) any time after they are deactivated. If the deactivation is not complete this will cancel the deactivation. A node which goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.

Service Fabric ensures that deactivation is a 'safe' process. It performs several safety checks (see SafetyCheckKind) to ensure that there is no loss of availability or data

DeactivateNodeAsync(String, NodeDeactivationIntent, TimeSpan, CancellationToken)

Deactivates a particular node with the specified NodeDeactivationIntent.

public System.Threading.Tasks.Task DeactivateNodeAsync (string nodeName, System.Fabric.NodeDeactivationIntent deactivationIntent, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);

member this.DeactivateNodeAsync : string * System.Fabric.NodeDeactivationIntent * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function DeactivateNodeAsync (nodeName As String, deactivationIntent As NodeDeactivationIntent, timeout As TimeSpan, cancellationToken As CancellationToken) As Task

Parameters

nodeName

String

The name of the node to deactivate.

deactivationIntent

NodeDeactivationIntent

The NodeDeactivationIntent for deactivating the node.

timeout

TimeSpan

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

cancellationToken

CancellationToken

The optional 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

A Task that represents the asynchronous acknowledgment of the request.

Exceptions

FabricObjectClosedException

See https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/ for handling common FabricClient failures.

TimeoutException

See https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/ for handling common FabricClient failures.

FabricException

See also https://azure.microsoft.com/documentation/articles/service-fabric-errors-and-exceptions/ for handling common FabricClient failures.

Remarks

When this API completes it implies that the intent to deactivate has been registered by the system. It does not mean that the deactivation is complete. The progress of the operation can be determined by using the GetNodeListAsync() API

Once the deactivation is in progress, the deactivation intent can be “increased” but not decreased (for example, a node which is was deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated via ActivateNodeAsync(String) any time after they are deactivated. If the deactivation is not complete this will cancel the deactivation. A node which goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.

Service Fabric ensures that deactivation is a 'safe' process. It performs several safety checks (see SafetyCheckKind) to ensure that there is no loss of availability or data