IDurableOrchestrationClient.TerminateAsync(String, String) メソッド

  • リファレンス

定義

名前空間:
Microsoft.Azure.WebJobs.Extensions.DurableTask
アセンブリ:
Microsoft.Azure.WebJobs.Extensions.DurableTask.dll
パッケージ:
Microsoft.Azure.WebJobs.Extensions.DurableTask v2.8.1
ソース:
IDurableOrchestrationClient.cs

実行中のオーケストレーション インスタンスを終了します。

public System.Threading.Tasks.Task TerminateAsync (string instanceId, string reason);
abstract member TerminateAsync : string * string -> System.Threading.Tasks.Task
Public Function TerminateAsync (instanceId As String, reason As String) As Task

パラメーター

instanceId
String

終了するオーケストレーション インスタンスの ID。

reason
String

オーケストレーション インスタンスの終了の理由。

戻り値

Task

必要に応じて終了メッセージがエンキューされるときに完了するタスク。

例外

ArgumentException

インスタンス ID は、有効なオーケストレーション インスタンスに対してコアが応答しません。

InvalidOperationException

指定されたインスタンス ID を持つオーケストレーション インスタンスが実行されていません。

注釈

終了したインスタンスは、最終的に Terminated 状態に切り替えられます。 ただし、この切り替えはすぐには行われません。 代わりに、終了操作は、そのインスタンスに対する他の操作と共に、タスクハブでキューに登録されます。 メソッドを GetStatusAsync(String, Boolean, Boolean, Boolean) 使用して、終了したインスタンスが実際に終了状態に達したことを確認できます。

オーケストレーション インスタンスを終了しても、現在のオーケストレーション インスタンスによって開始された実行中のアクティビティ関数の実行やサブオーケストレーションには影響しません。

適用対象