GrpcDurableTaskClient.TerminateInstanceAsync 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.
Terminates a running orchestration instance and updates its runtime status to Terminated.
public override System.Threading.Tasks.Task TerminateInstanceAsync (string instanceId, object? output = default, System.Threading.CancellationToken cancellation = default);
override this.TerminateInstanceAsync : string * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overrides Function TerminateInstanceAsync (instanceId As String, Optional output As Object = Nothing, Optional cancellation As CancellationToken = Nothing) As Task
Parameters
- instanceId
- String
The ID of the orchestration instance to terminate.
- output
- Object
The optional output to set for the terminated orchestration instance.
- cancellation
- CancellationToken
The cancellation token. This only cancels enqueueing the termination request to the backend. Does not abort termination of the orchestration once enqueued.
Returns
A task that completes when the terminate message is enqueued.