FabricClient.FaultManagementClient.StopNodeAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| StopNodeAsync(String, BigInteger, CompletionMode, CancellationToken) |
Obsolete.
Stops a cluster node. |
| StopNodeAsync(String, BigInteger, CompletionMode) |
Obsolete.
Stops a cluster node. |
| StopNodeAsync(String, BigInteger, CompletionMode, TimeSpan, CancellationToken) |
Obsolete.
Stops a cluster node. |
StopNodeAsync(String, BigInteger, CompletionMode, CancellationToken)
Caution
This api is deprecated, use StartNodeTransitionAsync instead.
Stops a cluster node.
[System.Obsolete("This api is deprecated, use StartNodeTransitionAsync instead.")]
public System.Threading.Tasks.Task<System.Fabric.Result.StopNodeResult> StopNodeAsync (string nodeName, System.Numerics.BigInteger nodeInstance, System.Fabric.CompletionMode completionMode, System.Threading.CancellationToken token);[<System.Obsolete("This api is deprecated, use StartNodeTransitionAsync instead.")>]
member this.StopNodeAsync : string * System.Numerics.BigInteger * System.Fabric.CompletionMode * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.StopNodeResult>Public Function StopNodeAsync (nodeName As String, nodeInstance As BigInteger, completionMode As CompletionMode, token As CancellationToken) As Task(Of StopNodeResult)Parameters
- nodeName
- String
The node name of the node to stop.
- nodeInstance
- BigInteger
The node instance ID of the node to stop. If this is not specified, or is set to 0, this is ignored. If this is set to -1, the system will internally determine this value.
- completionMode
- CompletionMode
If set to Verify, the system will check that the node stopped, and the API will not return until it has. If set to DoNotVerify, the API returns once the node stop has been initiated.
- token
- CancellationToken
The cancellation token that is monitored for any request to cancel the operation.
Returns
A task with information representing the target node.
- Attributes
Exceptions
The ErrorCode property will indicate the reason. If the ErrorCode is InvalidArgument, nodeName is invalid. If the ErrorCode is InstanceIdMismatch, the nodeInstance provided does not match the currently running instance.
The operation timed out.
An argument with a value of null was passed in.
Remarks
A cluster node is a process, not an virtual or physical machine.
Applies to
StopNodeAsync(String, BigInteger, CompletionMode)
Caution
This api is deprecated, use StartNodeTransitionAsync instead.
Stops a cluster node.
[System.Obsolete("This api is deprecated, use StartNodeTransitionAsync instead.")]
public System.Threading.Tasks.Task<System.Fabric.Result.StopNodeResult> StopNodeAsync (string nodeName, System.Numerics.BigInteger nodeInstance, System.Fabric.CompletionMode completionMode);[<System.Obsolete("This api is deprecated, use StartNodeTransitionAsync instead.")>]
member this.StopNodeAsync : string * System.Numerics.BigInteger * System.Fabric.CompletionMode -> System.Threading.Tasks.Task<System.Fabric.Result.StopNodeResult>Public Function StopNodeAsync (nodeName As String, nodeInstance As BigInteger, completionMode As CompletionMode) As Task(Of StopNodeResult)Parameters
- nodeName
- String
The node name of the node to stop.
- nodeInstance
- BigInteger
The node instance ID of the node to stop. If this is not specified, or is set to 0, this is ignored. If this is set to -1, the system will internally determine this value.
- completionMode
- CompletionMode
If set to Verify, the system will check that the node stopped, and the API will not return until it has. If set to DoNotVerify, the API returns once the node stop has been initiated.
Returns
A task with information representing the target node.
- Attributes
Exceptions
The ErrorCode property will indicate the reason. If the ErrorCode is InvalidArgument, nodeName is invalid. If the ErrorCode is InstanceIdMismatch, the nodeInstance provided does not match the currently running instance.
The operation timed out.
An argument with a value of null was passed in.
Remarks
A cluster node is a process, not an virtual or physical machine.
Applies to
StopNodeAsync(String, BigInteger, CompletionMode, TimeSpan, CancellationToken)
Caution
This api is deprecated, use StartNodeTransitionAsync instead.
Stops a cluster node.
[System.Obsolete("This api is deprecated, use StartNodeTransitionAsync instead.")]
public System.Threading.Tasks.Task<System.Fabric.Result.StopNodeResult> StopNodeAsync (string nodeName, System.Numerics.BigInteger nodeInstance, System.Fabric.CompletionMode completionMode, TimeSpan operationTimeout, System.Threading.CancellationToken token);[<System.Obsolete("This api is deprecated, use StartNodeTransitionAsync instead.")>]
member this.StopNodeAsync : string * System.Numerics.BigInteger * System.Fabric.CompletionMode * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.StopNodeResult>Public Function StopNodeAsync (nodeName As String, nodeInstance As BigInteger, completionMode As CompletionMode, operationTimeout As TimeSpan, token As CancellationToken) As Task(Of StopNodeResult)Parameters
- nodeName
- String
The node name of the node to stop.
- nodeInstance
- BigInteger
The node instance ID of the node to stop. If this is not specified, or is set to 0, this is ignored. If this is set to -1, the system will internally determine this value.
- completionMode
- CompletionMode
If set to Verify, the system will check that the node stopped, and the API will not return until it has. If set to DoNotVerify, the API returns once the node stop has been initiated.
- operationTimeout
- TimeSpan
The timeout for this API call.
- token
- CancellationToken
The cancellation token that is monitored for any request to cancel the operation.
Returns
A task with information representing the target node
- Attributes
Exceptions
The ErrorCode property will indicate the reason. If the ErrorCode is InvalidArgument, nodeName is invalid. If the ErrorCode is InstanceIdMismatch, the nodeInstance provided does not match the currently running instance.
The operation timed out.
An argument with a value of null was passed in.
Remarks
A cluster node is a process, not an virtual or physical machine.
