FabricClient.FaultManagementClient.RemoveReplicaAsync 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
| RemoveReplicaAsync(String, Guid, Int64, CompletionMode, Boolean, Double, CancellationToken) |
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector. |
| RemoveReplicaAsync(String, Guid, Int64, CompletionMode, Boolean, CancellationToken) |
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector. |
| RemoveReplicaAsync(String, Guid, Int64, CompletionMode, Boolean) |
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector. |
| RemoveReplicaAsync(ReplicaSelector, CompletionMode, Boolean, CancellationToken) |
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector. |
| RemoveReplicaAsync(ReplicaSelector, CompletionMode, Boolean) |
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector. |
| RemoveReplicaAsync(ReplicaSelector, CompletionMode, Boolean, TimeSpan, CancellationToken) |
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector. |
RemoveReplicaAsync(String, Guid, Int64, CompletionMode, Boolean, Double, CancellationToken)
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector.
public System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult> RemoveReplicaAsync (string nodeName, Guid partitionId, long replicaId, System.Fabric.CompletionMode completionMode, bool forceRemove, double operationTimeoutSec, System.Threading.CancellationToken token);member this.RemoveReplicaAsync : string * Guid * int64 * System.Fabric.CompletionMode * bool * double * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult>Public Function RemoveReplicaAsync (nodeName As String, partitionId As Guid, replicaId As Long, completionMode As CompletionMode, forceRemove As Boolean, operationTimeoutSec As Double, token As CancellationToken) As Task(Of RemoveReplicaResult)Parameters
- nodeName
- String
Node name where replica is to be moved ReplicaSelector
- partitionId
- Guid
Partition Id where the replica needs to be removed
- replicaId
- Int64
Replica Id that needs to be removed
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the restart of the replica is complete or not DoNotVerify - Return after triggering the restart of the replica Verify - Return after the remove completes
- forceRemove
- Boolean
Will forcefully remove the replica.
- operationTimeoutSec
- Double
The overall timeout in seconds for the operation, including the timeout to wait for replica to be removed if CompletionMode is Verify
- token
- CancellationToken
Cancellation token
Returns
RemoveReplicaResult which gives information about the actual selected replica.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.ReplicaDoesNotExist - If the Selected replica was not found FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist.
Applies to
RemoveReplicaAsync(String, Guid, Int64, CompletionMode, Boolean, CancellationToken)
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector.
public System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult> RemoveReplicaAsync (string nodeName, Guid partitionId, long replicaId, System.Fabric.CompletionMode completionMode, bool forceRemove, System.Threading.CancellationToken token);member this.RemoveReplicaAsync : string * Guid * int64 * System.Fabric.CompletionMode * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult>Public Function RemoveReplicaAsync (nodeName As String, partitionId As Guid, replicaId As Long, completionMode As CompletionMode, forceRemove As Boolean, token As CancellationToken) As Task(Of RemoveReplicaResult)Parameters
- nodeName
- String
Node name where replica is to be moved ReplicaSelector
- partitionId
- Guid
Partition Id where the replica needs to be removed
- replicaId
- Int64
Replica Id that needs to be removed
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the remove of the replica is complete or not DoNotVerify - Return after triggering the remove of the replica Verify - Return after the remove completes i.e. the replica is out of the FM view.
- forceRemove
- Boolean
Will forcefully remove the replica
- token
- CancellationToken
Cancellation token
Returns
RemoveReplicaResult which gives information about the actual selected replica.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.ReplicaDoesNotExist - If the Selected replica was not found FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist.
Applies to
RemoveReplicaAsync(String, Guid, Int64, CompletionMode, Boolean)
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector.
public System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult> RemoveReplicaAsync (string nodeName, Guid partitionId, long replicaId, System.Fabric.CompletionMode completionMode, bool forceRemove);member this.RemoveReplicaAsync : string * Guid * int64 * System.Fabric.CompletionMode * bool -> System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult>Public Function RemoveReplicaAsync (nodeName As String, partitionId As Guid, replicaId As Long, completionMode As CompletionMode, forceRemove As Boolean) As Task(Of RemoveReplicaResult)Parameters
- nodeName
- String
Node name where replica is to be moved ReplicaSelector
- partitionId
- Guid
Partition Id where the replica needs to be removed
- replicaId
- Int64
Replica Id that needs to be removed
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the restart of the replica is complete or not DoNotVerify - Return after triggering the restart of the replica Verify - Return after the remove completes
- forceRemove
- Boolean
Will forcefully remove the replica
Returns
RemoveReplicaResult which gives information about the actual selected replica.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.ReplicaDoesNotExist - If the Selected replica was not found FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist.
Applies to
RemoveReplicaAsync(ReplicaSelector, CompletionMode, Boolean, CancellationToken)
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector.
public System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult> RemoveReplicaAsync (System.Fabric.ReplicaSelector replicaSelector, System.Fabric.CompletionMode completionMode, bool forceRemove, System.Threading.CancellationToken token);member this.RemoveReplicaAsync : System.Fabric.ReplicaSelector * System.Fabric.CompletionMode * bool * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult>Public Function RemoveReplicaAsync (replicaSelector As ReplicaSelector, completionMode As CompletionMode, forceRemove As Boolean, token As CancellationToken) As Task(Of RemoveReplicaResult)Parameters
- replicaSelector
- ReplicaSelector
The ReplicaSelector which indicates the replica to be removed.
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the remove of the replica is complete or not DoNotVerify - Return after triggering the remove of the replica Verify - Return after the remove completes i.e. the replica is out of the FM view
- forceRemove
- Boolean
Will forcefully remove the replica
- token
- CancellationToken
Cancellation token
Returns
RemoveReplicaResult which gives information about the actual selected replica.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.ReplicaDoesNotExist - If the Selected replica was not found FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist.
Applies to
RemoveReplicaAsync(ReplicaSelector, CompletionMode, Boolean)
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector.
public System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult> RemoveReplicaAsync (System.Fabric.ReplicaSelector replicaSelector, System.Fabric.CompletionMode completionMode, bool forceRemove);member this.RemoveReplicaAsync : System.Fabric.ReplicaSelector * System.Fabric.CompletionMode * bool -> System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult>Public Function RemoveReplicaAsync (replicaSelector As ReplicaSelector, completionMode As CompletionMode, forceRemove As Boolean) As Task(Of RemoveReplicaResult)Parameters
- replicaSelector
- ReplicaSelector
The ReplicaSelector which indicates the replica to be removed.
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the remove of the replica is complete or not DoNotVerify - Return after triggering the remove of the replica Verify - Return after the remove completes i.e. the replica is out of the FM vie.w
- forceRemove
- Boolean
Will forcefully remove the replica
Returns
RemoveReplicaResult which gives information about the actual selected replica.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.ReplicaDoesNotExist - If the Selected replica was not found FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist.
Applies to
RemoveReplicaAsync(ReplicaSelector, CompletionMode, Boolean, TimeSpan, CancellationToken)
This API will remove the replica (equivalent of ReportFault - Permanent) specified by the passed in ReplicaSelector.
public System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult> RemoveReplicaAsync (System.Fabric.ReplicaSelector replicaSelector, System.Fabric.CompletionMode completionMode, bool forceRemove, TimeSpan operationTimeout, System.Threading.CancellationToken token);member this.RemoveReplicaAsync : System.Fabric.ReplicaSelector * System.Fabric.CompletionMode * bool * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.Result.RemoveReplicaResult>Public Function RemoveReplicaAsync (replicaSelector As ReplicaSelector, completionMode As CompletionMode, forceRemove As Boolean, operationTimeout As TimeSpan, token As CancellationToken) As Task(Of RemoveReplicaResult)Parameters
- replicaSelector
- ReplicaSelector
The ReplicaSelector which indicates the replica to be removed.
- completionMode
- CompletionMode
The CompletionMode that specifies whether to wait until the remove of the replica is complete or not DoNotVerify - Return after triggering the remove of the replica Verify - Return after the remove completes i.e. the replica is out of the FM view.
- forceRemove
- Boolean
Will forcefully remove the replica.
- operationTimeout
- TimeSpan
The overall timeout for the operation including the timeout to wait for replica to be removed if CompletionMode is Verify
- token
- CancellationToken
Cancellation token
Returns
RemoveReplicaResult which gives information about the actual selected replica.
Exceptions
Action took more than its allocated time.
Any of the required arguments are null.
These are the fabric failures FabricErrorCode.ReplicaDoesNotExist - If the Selected replica was not found FabricErrorCode.PartitionNotFound - if the specified partition selected does not exist.
