DurableClient class

Název centra úloh nakonfigurovaného pro tuto instanci klienta orchestrace.

taskHubName: string

Hodnota vlastnosti

Vytvoří odpověď HTTP, která je užitečná pro kontrolu stavu zadané instance.

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

Parametry

Návraty

Odpověď HTTP 202 s hlavičkou Location a datovou částí obsahující adresy URL správy instancí.

Vytvoří HttpManagementPayload objekt, který obsahuje koncové body HTTP správy instancí.

function createHttpManagementPayload(instanceId: string): HttpManagementPayload

Parametry

Návraty

Získá stav zadané instance orchestrace.

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

Parametry

Návraty

Získá stav všech instancí orchestrace.

function getStatusAll(): Promise<DurableOrchestrationStatus[]>

Návraty

Získá stav všech instancí orchestrace, které odpovídají zadaným podmínkám.

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

Parametry

Návraty

Vymažte historii pro konkrétní instanci orchestrace.

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

Parametry

Návraty

Vyprázdněte historii orchestrace pro instance, které splňují podmínky.

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

Parametry

Návraty

Odešle zprávu s oznámením události do čekající instance orchestrace.

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

Parametry

Návraty

Příslib, který se vyřeší, když je zpráva s oznámením události v frontě.

Aby bylo možné zpracovat událost, musí cílová instance orchestrace čekat na událost s názvem eventName pomocí waitForExternalEvent(string).

Pokud zadaná instance není nalezena nebo není spuštěna, tato operace nebude mít žádný vliv.

Pokusí se přečíst aktuální stav entity. Vrátí nedefinovanou hodnotu, pokud entita neexistuje nebo pokud je serializovaný stav JSON entity větší než 16 kB.

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

Parametry

Návraty

Odpověď obsahující aktuální stav entity.

Převiňte zadanou instanci orchestrace, která selhala, s důvodem.

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

Parametry

Návraty

Příslib, který se vyřeší při převinutí zprávy zpět do fronty.

Tato funkce je aktuálně ve verzi Preview.

Signalizuje entitu k provedení operace.

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

Parametry

Návraty

Spustí novou instanci zadané funkce orchestrátoru.

Pokud instance orchestrace se zadaným ID již existuje, stávající instance bude bezobslužně nahrazena touto novou instancí.

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

Parametry

Návraty

ID nové instance orchestrace.

Ukončí spuštěnou instanci orchestrace.

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

Parametry

Návraty

Příslib, který se vyřeší při zařazení zprávy ukončení do fronty.

Ukončení instance orchestrace nemá žádný vliv na žádné spuštění funkcí aktivity v letu ani dílčí orchestrace, které byly spuštěny aktuální instancí orchestrace.

Vytvoří odpověď HTTP, která obsahuje datovou část adres URL pro správu pro nedokončenou instanci nebo obsahuje datovou část obsahující výstup dokončené orchestrace.

Pokud se orchestrace nedokončí v zadaném časovém limitu, bude odpověď HTTP stejná jako metoda createCheckStatusResponse().

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

Parametry

Návraty