DurableClient class
Client per l'avvio, l'esecuzione di query, la terminazione e la generazione di eventi alle istanze di orchestrazione ed entità.
Proprietà
| task |
Nome dell'hub attività configurato in questa istanza del client di orchestrazione. |
Metodi
| create |
Crea una risposta HTTP utile per controllare lo stato dell'istanza specificata. |
| create |
Crea un oggetto HttpManagementPayload che contiene gli endpoint HTTP di gestione delle istanze. |
| get |
Ottiene lo stato dell'istanza di orchestrazione specificata. |
| get |
Ottiene lo stato di tutte le istanze di orchestrazione. |
| get |
Ottiene lo stato di tutte le istanze di orchestrazione che soddisfano le condizioni specificate. |
| purge |
Eliminare la cronologia per un'istanza di orchestrazione specifica. |
| purge |
Eliminare la cronologia dell'orchestrazione per le istanze che soddisfano le condizioni. |
| raise |
Invia un messaggio di notifica degli eventi a un'istanza di orchestrazione in attesa. |
| read |
Prova a leggere lo stato corrente di un'entità. Restituisce undefined se l'entità non esiste o se lo stato serializzato JSON dell'entità è maggiore di 16 KB. |
| rewind(string, string, Task |
Riavvolge l'istanza di orchestrazione non riuscita specificata con un motivo. |
| signal |
Segnala a un'entità di eseguire un'operazione. |
| start |
Avvia una nuova istanza della funzione dell'agente di orchestrazione specificata. Se esiste già un'istanza di orchestrazione con l'ID specificato, l'istanza esistente verrà sostituita automaticamente da questa nuova istanza. |
| terminate(string, string) | Termina un'istanza di orchestrazione in esecuzione. |
| wait |
Crea una risposta HTTP che contiene un payload di URL di gestione per un'istanza non completata o contiene il payload contenente l'output dell'orchestrazione completata. Se l'orchestrazione non viene completata entro il timeout specificato, la risposta HTTP sarà identica a quella di createCheckStatusResponse(). |
Dettagli proprietà
taskHubName
Nome dell'hub attività configurato in questa istanza del client di orchestrazione.
taskHubName: stringValore della proprietà
string
Dettagli metodo
createCheckStatusResponse(undefined | HttpRequest, string)
Crea una risposta HTTP utile per controllare lo stato dell'istanza specificata.
function createCheckStatusResponse(request: undefined | HttpRequest, instanceId: string): HttpResponseParametri
- request
-
undefined | HttpRequest
Richiesta HTTP che ha attivato l'istanza di orchestrazione corrente.
- instanceId
-
string
ID dell'istanza di orchestrazione da controllare.
Restituisce
Risposta HTTP 202 con un'intestazione Location e un payload contenente gli URL di gestione delle istanze.
createHttpManagementPayload(string)
Crea un oggetto HttpManagementPayload che contiene gli endpoint HTTP di gestione delle istanze.
function createHttpManagementPayload(instanceId: string): HttpManagementPayloadParametri
- instanceId
-
string
ID dell'istanza di orchestrazione da controllare.
Restituisce
getStatus(string, GetStatusOptions)
Ottiene lo stato dell'istanza di orchestrazione specificata.
function getStatus(instanceId: string, options?: GetStatusOptions): Promise<DurableOrchestrationStatus>Parametri
- instanceId
-
string
ID dell'istanza di orchestrazione su cui eseguire una query.
- options
- GetStatusOptions
oggetto options che specifica una configurazione aggiuntiva
Restituisce
Promise<DurableOrchestrationStatus>
getStatusAll()
Ottiene lo stato di tutte le istanze di orchestrazione.
function getStatusAll(): Promise<DurableOrchestrationStatus[]>Restituisce
Promise<DurableOrchestrationStatus[]>
getStatusBy(OrchestrationFilter)
Ottiene lo stato di tutte le istanze di orchestrazione che soddisfano le condizioni specificate.
function getStatusBy(filter: OrchestrationFilter): Promise<DurableOrchestrationStatus[]>Parametri
- filter
- OrchestrationFilter
Oggetto OrchestrationFilter che specifica le orchestrazioni da recuperare.
Restituisce
Promise<DurableOrchestrationStatus[]>
purgeInstanceHistory(string)
Eliminare la cronologia per un'istanza di orchestrazione specifica.
function purgeInstanceHistory(instanceId: string): Promise<PurgeHistoryResult>Parametri
- instanceId
-
string
ID dell'istanza di orchestrazione da eliminare.
Restituisce
Promise<PurgeHistoryResult>
purgeInstanceHistoryBy(OrchestrationFilter)
Eliminare la cronologia dell'orchestrazione per le istanze che soddisfano le condizioni.
function purgeInstanceHistoryBy(filter: OrchestrationFilter): Promise<PurgeHistoryResult>Parametri
- filter
- OrchestrationFilter
oggetto OrchestrationFilter che specifica le orchestrazioni da eliminare.
Restituisce
Promise<PurgeHistoryResult>
raiseEvent(string, string, unknown, TaskHubOptions)
Invia un messaggio di notifica degli eventi a un'istanza di orchestrazione in attesa.
function raiseEvent(instanceId: string, eventName: string, eventData: unknown, options?: TaskHubOptions): Promise<void>Parametri
- instanceId
-
string
ID dell'istanza di orchestrazione che gestirà l'evento.
- eventName
-
string
Nome dell'evento.
- eventData
-
unknown
Dati serializzabili JSON associati all'evento.
- options
- TaskHubOptions
oggetto che fornisce TaskHubName dell'istanza di orchestrazione e il nome della stringa di connessione associata
Restituisce
Promise<void>
Promessa che si risolve quando il messaggio di notifica dell'evento è stato accodato.
Per gestire l'evento, l'istanza di orchestrazione di destinazione deve essere in attesa di un evento denominato eventName usando waitForExternalEvent(string).
Se l'istanza specificata non viene trovata o non è in esecuzione, questa operazione non avrà alcun effetto.
readEntityState<T>(EntityId, TaskHubOptions)
Prova a leggere lo stato corrente di un'entità. Restituisce undefined se l'entità non esiste o se lo stato serializzato JSON dell'entità è maggiore di 16 KB.
function readEntityState<T>(entityId: EntityId, options?: TaskHubOptions): Promise<EntityStateResponse<T>>Parametri
- entityId
- EntityId
Entità di destinazione.
- options
- TaskHubOptions
oggetto facoltativo che fornisce TaskHubName dell'entità di destinazione e il nome della stringa di connessione associata
Restituisce
Promise<EntityStateResponse<T>>
Risposta contenente lo stato corrente dell'entità.
rewind(string, string, TaskHubOptions)
Riavvolge l'istanza di orchestrazione non riuscita specificata con un motivo.
function rewind(instanceId: string, reason: string, options?: TaskHubOptions): Promise<void>Parametri
- instanceId
-
string
ID dell'istanza di orchestrazione da riavvolgere.
- reason
-
string
Motivo della riavvolgimento dell'istanza di orchestrazione.
- options
- TaskHubOptions
oggetto che fornisce TaskHubName dell'istanza di orchestrazione e il nome della stringa di connessione associata
Restituisce
Promise<void>
Promessa che viene risolta quando viene accodato il messaggio di riavvolgimento.
Questa funzionalità è attualmente in anteprima.
signalEntity(EntityId, string, unknown, TaskHubOptions)
Segnala a un'entità di eseguire un'operazione.
function signalEntity(entityId: EntityId, operationName?: string, operationContent?: unknown, options?: TaskHubOptions): Promise<void>Parametri
- entityId
- EntityId
Entità di destinazione.
- operationName
-
string
Nome dell'operazione.
- operationContent
-
unknown
Contenuto dell'operazione.
- options
- TaskHubOptions
oggetto che fornisce TaskHubName dell'istanza dell'entità e il nome della stringa di connessione associata
Restituisce
Promise<void>
startNew(string, StartNewOptions)
Avvia una nuova istanza della funzione dell'agente di orchestrazione specificata.
Se esiste già un'istanza di orchestrazione con l'ID specificato, l'istanza esistente verrà sostituita automaticamente da questa nuova istanza.
function startNew(orchestratorFunctionName: string, options?: StartNewOptions): Promise<string>Parametri
- orchestratorFunctionName
-
string
Nome della funzione dell'agente di orchestrazione da avviare.
- options
- StartNewOptions
oggetto facoltativo per controllare l'agente di orchestrazione pianificato (ad esempio, fornire input, instanceID)
Restituisce
Promise<string>
ID della nuova istanza di orchestrazione.
terminate(string, string)
Termina un'istanza di orchestrazione in esecuzione.
function terminate(instanceId: string, reason: string): Promise<void>Parametri
- instanceId
-
string
ID dell'istanza di orchestrazione da terminare.
- reason
-
string
Motivo della terminazione dell'istanza di orchestrazione.
Restituisce
Promise<void>
Promessa che viene risolta quando il messaggio di termina viene accodato.
La terminazione di un'istanza di orchestrazione non ha alcun effetto sulle esecuzioni di funzioni di attività in anteprima o sulle sotto orchestrazioni avviate dall'istanza di orchestrazione corrente.
waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)
Crea una risposta HTTP che contiene un payload di URL di gestione per un'istanza non completata o contiene il payload contenente l'output dell'orchestrazione completata.
Se l'orchestrazione non viene completata entro il timeout specificato, la risposta HTTP sarà identica a quella di createCheckStatusResponse().
function waitForCompletionOrCreateCheckStatusResponse(request: HttpRequest, instanceId: string, waitOptions?: WaitForCompletionOptions): Promise<HttpResponse>Parametri
- request
- HttpRequest
Richiesta HTTP che ha attivato la funzione corrente.
- instanceId
-
string
ID univoco dell'istanza da controllare.
- waitOptions
- WaitForCompletionOptions
oggetto options che specifica i timeout per quanto tempo attendere l'output dalla funzione durevole e la frequenza con cui verificare la disponibilità di output.
Restituisce
Promise<HttpResponse>