DurableOrchestrationClientBase.TerminateAsync(String, String) Method

Definition

Namespace:: Microsoft.Azure.WebJobs

Assembly:: Microsoft.Azure.WebJobs.Extensions.DurableTask.dll

Package:: Microsoft.Azure.WebJobs.Extensions.DurableTask v1.8.3

Source:: DurableOrchestrationClientBase.cs

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.

public abstract System.Threading.Tasks.Task TerminateAsync(string instanceId, string reason);

abstract member TerminateAsync : string * string -> System.Threading.Tasks.Task

Public MustOverride Function TerminateAsync (instanceId As String, reason As String) As Task

Parameters

instanceId: System.String

The ID of the orchestration instance to terminate.

reason: System.String

The reason for terminating the orchestration instance.

Returns

System.Threading.Tasks.Task

A task that completes when the terminate message is enqueued.

Remarks

Terminating an orchestration instance has no effect on any in-flight activity function executions or sub-orchestrations that were started by the current orchestration instance.

Applies to