IDurableOrchestrationClient.TerminateAsync(String, String) Methode

Referenz

Definition

Namespace:: Microsoft.Azure.WebJobs.Extensions.DurableTask

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

Paket:: Microsoft.Azure.WebJobs.Extensions.DurableTask v2.8.1

Quelle:: IDurableOrchestrationClient.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Dient zum Beenden einer ausgeführten Orchestrierungsinstanz.

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

Parameter

instanceId: String

Die ID der zu beendenden Orchestrierung instance.

reason: String

Gibt den Grund für die Beendigung der Orchestrierungsinstanz an.

Gibt zurück

Task

Eine Aufgabe, die abgeschlossen wird, wenn die Beendigungsnachricht bei Bedarf in die Warteschlange eingereiht wird.

Ausnahmen

ArgumentException

Die instance-ID wird nicht auf eine gültige Orchestrierung instance.

InvalidOperationException

Die Orchestrierung instance mit der angegebenen instance-ID wird nicht ausgeführt.

Hinweise

Eine beendete Instanz wechselt schließlich in den Zustand Terminated. Dieser Übergang erfolgt jedoch nicht sofort. Stattdessen wird der Beendigungsvorgang im Aufgabenhub zusammen mit anderen Vorgängen für diese Instanz in eine Warteschlange eingereiht. Sie können die GetStatusAsync(String, Boolean, Boolean, Boolean) -Methode verwenden, um zu ermitteln, wann ein beendeter instance tatsächlich den Status Beendet erreicht hat.

Das Beenden einer Orchestrierung instance hat keine Auswirkungen auf in-flight-Aktivitätsfunktionen oder Untergeordnete Orchestrierungen, die vom aktuellen Orchestrierungs-instance gestartet wurden.

Gilt für:

Freigeben über