DurableClient class

Der Name des Aufgabenhubs, der auf dieser Orchestrierungsclientinstanz konfiguriert ist.

taskHubName: string

Eigenschaftswert

Erstellt eine HTTP-Antwort, die nützlich ist, um den Status der angegebenen Instanz zu überprüfen.

function createCheckStatusResponse(request: undefined | HttpRequest, instanceId: string): HttpResponse

Parameter

Gibt zurück

Eine HTTP 202-Antwort mit einem Location-Header und einer Nutzlast mit Instanzverwaltungs-URLs.

Erstellt ein HttpManagementPayload--Objekt, das HTTP-Endpunkte für die Instanzverwaltung enthält.

function createHttpManagementPayload(instanceId: string): HttpManagementPayload

Parameter

Gibt zurück

Ruft den Status der angegebenen Orchestrierungsinstanz ab.

function getStatus(instanceId: string, options?: GetStatusOptions): Promise<DurableOrchestrationStatus>

Parameter

Gibt zurück

Ruft den Status aller Orchestrierungsinstanzen ab.

function getStatusAll(): Promise<DurableOrchestrationStatus[]>

Gibt zurück

Ruft den Status aller Orchestrierungsinstanzen ab, die den angegebenen Bedingungen entsprechen.

function getStatusBy(filter: OrchestrationFilter): Promise<DurableOrchestrationStatus[]>

Parameter

Gibt zurück

Löscht den Verlauf für eine bestimmte Orchestrierungsinstanz.

function purgeInstanceHistory(instanceId: string): Promise<PurgeHistoryResult>

Parameter

Gibt zurück

Löschen Sie den Orchestrierungsverlauf für Instanzen, die den Bedingungen entsprechen.

function purgeInstanceHistoryBy(filter: OrchestrationFilter): Promise<PurgeHistoryResult>

Parameter

Gibt zurück

Sendet eine Ereignisbenachrichtigung an eine wartende Orchestrierungsinstanz.

function raiseEvent(instanceId: string, eventName: string, eventData: unknown, options?: TaskHubOptions): Promise<void>

Parameter

Gibt zurück

Eine Zusage, die aufgelöst wird, wenn die Ereignisbenachrichtigung enqueued wurde.

Um das Ereignis zu behandeln, muss die Ziel-Orchestrierungsinstanz auf ein Ereignis mit dem Namen eventName mit waitForExternalEvent(string)warten.

Wenn die angegebene Instanz nicht gefunden wird oder nicht ausgeführt wird, hat dieser Vorgang keine Auswirkung.

Versucht, den aktuellen Status einer Entität zu lesen. Gibt nicht definiert zurück, wenn die Entität nicht vorhanden ist oder der JSON-serialisierte Zustand der Entität größer als 16 KB ist.

function readEntityState<T>(entityId: EntityId, options?: TaskHubOptions): Promise<EntityStateResponse<T>>

Parameter

Gibt zurück

Eine Antwort, die den aktuellen Status der Entität enthält.

Gibt die angegebene fehlgeschlagene Orchestrierungsinstanz aus einem Grund zurück.

function rewind(instanceId: string, reason: string, options?: TaskHubOptions): Promise<void>

Parameter

Gibt zurück

Eine Zusage, die aufgelöst wird, wenn die Rückspulennachricht abgefragt wird.

Dieses Feature befindet sich derzeit in der Vorschau.

Signalisiert eine Entität zum Ausführen eines Vorgangs.

function signalEntity(entityId: EntityId, operationName?: string, operationContent?: unknown, options?: TaskHubOptions): Promise<void>

Parameter

Gibt zurück

Startet eine neue Instanz der angegebenen Orchestratorfunktion.

Wenn bereits eine Orchestrierungsinstanz mit der angegebenen ID vorhanden ist, wird die vorhandene Instanz automatisch durch diese neue Instanz ersetzt.

function startNew(orchestratorFunctionName: string, options?: StartNewOptions): Promise<string>

Parameter

Gibt zurück

Die ID der neuen Orchestrierungsinstanz.

Beendet eine ausgeführte Orchestrierungsinstanz.

function terminate(instanceId: string, reason: string): Promise<void>

Parameter

Gibt zurück

Eine Zusage, die aufgelöst wird, wenn die Beendigungsnachricht enqueuiert wird.

Das Beenden einer Orchestrierungsinstanz hat keine Auswirkungen auf Ausführungen von In-Flight-Aktivitätsfunktionen oder Unter-Orchestrierungen, die von der aktuellen Orchestrierungsinstanz gestartet wurden.

Erstellt eine HTTP-Antwort, die entweder eine Nutzlast von Verwaltungs-URLs für eine nicht abgeschlossene Instanz enthält oder die Nutzlast enthält, die die Ausgabe der abgeschlossenen Orchestrierung enthält.

Wenn die Orchestrierung nicht innerhalb des angegebenen Timeouts abgeschlossen ist, ist die HTTP-Antwort mit der von createCheckStatusResponse() identisch.

function waitForCompletionOrCreateCheckStatusResponse(request: HttpRequest, instanceId: string, waitOptions?: WaitForCompletionOptions): Promise<HttpResponse>

Parameter

Gibt zurück