FabricClient.TestManagementClient.CancelTestCommandAsync 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
| CancelTestCommandAsync(Guid, Boolean) |
Cancels a test command. |
| CancelTestCommandAsync(Guid, Boolean, CancellationToken) |
Cancels a test command. |
| CancelTestCommandAsync(Guid, Boolean, TimeSpan) |
Cancels a test command. |
| CancelTestCommandAsync(Guid, Boolean, TimeSpan, CancellationToken) |
Cancels a test command. |
CancelTestCommandAsync(Guid, Boolean)
Cancels a test command.
public System.Threading.Tasks.Task CancelTestCommandAsync (Guid operationId, bool force);member this.CancelTestCommandAsync : Guid * bool -> System.Threading.Tasks.TaskPublic Function CancelTestCommandAsync (operationId As Guid, force As Boolean) As TaskParameters
- operationId
- Guid
Indicates the operationId of the test command to cancel.
- force
- Boolean
Indicates whether to gracefully rollback and clean up internal system state modified by executing the test command. See Remarks.
Returns
A Task.
Remarks
If force is false, then the specified test command will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state may be left behind. Specifying force as true should be used with care. Calling CancelTestCommandAsync() with force set to true is not allowed until CancelTestCommandAsync() has been called on the same test command with force set to false first, or unless the test command already has a TestCommandProgressState of TestCommandProgressState.RollingBack. Clarification: TestCommandProgressState.RollingBack means that the system will/is cleaning up internal system state caused by executing the command. It will not restore data if the test command was to cause data loss. For example, if you call StartPartitionDataLossAsync() then call CancelTestCommandAsync() the system will only clean up internal state from running the command. It will not restore the target partition's data, if the command progressed far enough to cause data loss.
Important note: if this API is invoked with force==true, internal state may be left behind. CleanTestStateAsync() should be invoked to remove state that may have been left behind.
The FaultAnalysisService must be enabled to use this API.
Applies to
CancelTestCommandAsync(Guid, Boolean, CancellationToken)
Cancels a test command.
public System.Threading.Tasks.Task CancelTestCommandAsync (Guid operationId, bool force, System.Threading.CancellationToken cancellationToken);member this.CancelTestCommandAsync : Guid * bool * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function CancelTestCommandAsync (operationId As Guid, force As Boolean, cancellationToken As CancellationToken) As TaskParameters
- operationId
- Guid
Indicates the operationId of the test command to cancel.
- force
- Boolean
Indicates whether to gracefully rollback and clean up internal system state modified by executing the test command. See Remarks.
- cancellationToken
- CancellationToken
This token can be signalled to abort this operation before it finishes
Returns
A Task.
Remarks
If force is false, then the specified test command will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state may be left behind. Specifying force as true should be used with care. Calling CancelTestCommandAsync() with force set to true is not allowed until CancelTestCommandAsync() has been called on the same test command with force set to false first, or unless the test command already has a TestCommandProgressState of TestCommandProgressState.RollingBack. Clarification: TestCommandProgressState.RollingBack means that the system will/is cleaning up internal system state caused by executing the command. It will not restore data if the test command was to cause data loss. For example, if you call StartPartitionDataLossAsync() then call CancelTestCommandAsync() the system will only clean up internal state from running the command. It will not restore the target partition's data, if the command progressed far enough to cause data loss.
Important note: if this API is invoked with force==true, internal state may be left behind. CleanTestStateAsync() should be invoked to remove state that may have been left behind.
The FaultAnalysisService must be enabled to use this API.
Applies to
CancelTestCommandAsync(Guid, Boolean, TimeSpan)
Cancels a test command.
public System.Threading.Tasks.Task CancelTestCommandAsync (Guid operationId, bool force, TimeSpan timeout);member this.CancelTestCommandAsync : Guid * bool * TimeSpan -> System.Threading.Tasks.TaskPublic Function CancelTestCommandAsync (operationId As Guid, force As Boolean, timeout As TimeSpan) As TaskParameters
- operationId
- Guid
Indicates the operationId of the test command to cancel.
- force
- Boolean
Indicates whether to gracefully rollback and clean up internal system state modified by executing the test command. See Remarks.
- timeout
- TimeSpan
The timeout to use for the API call.
Returns
A Task.
Remarks
If force is false, then the specified test command will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state may be left behind. Specifying force as true should be used with care. Calling CancelTestCommandAsync() with force set to true is not allowed until CancelTestCommandAsync() has been called on the same test command with force set to false first, or unless the test command already has a TestCommandProgressState of TestCommandProgressState.RollingBack. Clarification: TestCommandProgressState.RollingBack means that the system will/is cleaning up internal system state caused by executing the command. It will not restore data if the test command was to cause data loss. For example, if you call StartPartitionDataLossAsync() then call CancelTestCommandAsync() the system will only clean up internal state from running the command. It will not restore the target partition's data, if the command progressed far enough to cause data loss.
Important note: if this API is invoked with force==true, internal state may be left behind. CleanTestStateAsync() should be invoked to remove state that may have been left behind.
The FaultAnalysisService must be enabled to use this API.
Applies to
CancelTestCommandAsync(Guid, Boolean, TimeSpan, CancellationToken)
Cancels a test command.
public System.Threading.Tasks.Task CancelTestCommandAsync (Guid operationId, bool force, TimeSpan timeout, System.Threading.CancellationToken cancellationToken);member this.CancelTestCommandAsync : Guid * bool * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function CancelTestCommandAsync (operationId As Guid, force As Boolean, timeout As TimeSpan, cancellationToken As CancellationToken) As TaskParameters
- operationId
- Guid
Indicates the operationId of the test command to cancel.
- force
- Boolean
Indicates whether to gracefully rollback and clean up internal system state modified by executing the test command. See Remarks.
- timeout
- TimeSpan
The timeout to use for the API call.
- cancellationToken
- CancellationToken
This token can be signalled to abort this operation before it finishes
Returns
A Task.
Remarks
If force is false, then the specified test command will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state may be left behind. Specifying force as true should be used with care. Calling CancelTestCommandAsync() with force set to true is not allowed until CancelTestCommandAsync() has been called on the same test command with force set to false first, or unless the test command already has a TestCommandProgressState of TestCommandProgressState.RollingBack. Clarification: TestCommandProgressState.RollingBack means that the system will/is cleaning up internal system state caused by executing the command. It will not restore data if the test command was to cause data loss. For example, if you call StartPartitionDataLossAsync() then call CancelTestCommandAsync() the system will only clean up internal state from running the command. It will not restore the target partition's data, if the command progressed far enough to cause data loss.
Important note: if this API is invoked with force==true, internal state may be left behind. CleanTestStateAsync() should be invoked to remove state that may have been left behind.
The FaultAnalysisService must be enabled to use this API.
Applies to
Azure SDK for .NET