DurableClient class

Paquet:: durable-functions

Client pour le démarrage, l’interrogation, la fin et le déclenchement d’événements vers des instances d’orchestration et d’entité.

Propriétés

taskHubName

Nom du hub de tâches configuré sur cette instance cliente d’orchestration.

Méthodes

createCheckStatusResponse(undefined \| HttpRequest, string)	Crée une réponse HTTP utile pour vérifier l’état de l’instance spécifiée.
createHttpManagementPayload(string)	Crée un objet HttpManagementPayload qui contient des points de terminaison HTTP de gestion d’instance.
getStatus(string, GetStatusOptions)	Obtient l’état de l’instance d’orchestration spécifiée.
getStatusAll()	Obtient l’état de toutes les instances d’orchestration.
getStatusBy(OrchestrationFilter)	Obtient l’état de toutes les instances d’orchestration qui correspondent aux conditions spécifiées.
purgeInstanceHistory(string)	Videz l’historique d’une instance d’orchestration spécifique.
purgeInstanceHistoryBy(OrchestrationFilter)	Videz l’historique d’orchestration des instances qui correspondent aux conditions.
raiseEvent(string, string, unknown, TaskHubOptions)	Envoie un message de notification d’événement à une instance d’orchestration en attente.
readEntityState<T>(EntityId, TaskHubOptions)	Tente de lire l’état actuel d’une entité. Retourne une valeur non définie si l’entité n’existe pas ou si l’état json sérialisé de l’entité est supérieur à 16 Ko.
rewind(string, string, TaskHubOptions)	Rembobine l’instance d’orchestration ayant échoué spécifiée avec une raison.
signalEntity(EntityId, string, unknown, TaskHubOptions)	Signale à une entité d’effectuer une opération.
startNew(string, StartNewOptions)	Démarre une nouvelle instance de la fonction d’orchestrateur spécifiée. Si une instance d’orchestration avec l’ID spécifié existe déjà, l’instance existante est remplacée en mode silencieux par cette nouvelle instance.
terminate(string, string)	Termine une instance d’orchestration en cours d’exécution.
waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)	Crée une réponse HTTP qui contient une charge utile d’URL de gestion pour une instance non terminée ou contient la charge utile contenant la sortie de l’orchestration terminée. Si l’orchestration ne se termine pas dans le délai d’expiration spécifié, la réponse HTTP est identique à celle de createCheckStatusResponse().

Détails de la propriété

taskHubName

Nom du hub de tâches configuré sur cette instance cliente d’orchestration.

taskHubName: string

Valeur de propriété

string

Détails de la méthode

createCheckStatusResponse(undefined | HttpRequest, string)

Crée une réponse HTTP utile pour vérifier l’état de l’instance spécifiée.

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

Paramètres

request: undefined | HttpRequest

Requête HTTP qui a déclenché l’instance d’orchestration actuelle.

instanceId: string

ID de l’instance d’orchestration à vérifier.

Retours

HttpResponse

Réponse HTTP 202 avec un en-tête Location et une charge utile contenant des URL de gestion d’instance.

createHttpManagementPayload(string)

Crée un objet HttpManagementPayload qui contient des points de terminaison HTTP de gestion d’instance.

function createHttpManagementPayload(instanceId: string): HttpManagementPayload

Paramètres

instanceId: string

ID de l’instance d’orchestration à vérifier.

Retours

HttpManagementPayload

getStatus(string, GetStatusOptions)

Obtient l’état de l’instance d’orchestration spécifiée.

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

Paramètres

instanceId: string

ID de l’instance d’orchestration à interroger.

options: GetStatusOptions

objet options spécifiant une configuration supplémentaire

Retours

Promise<DurableOrchestrationStatus>

getStatusAll()

Obtient l’état de toutes les instances d’orchestration.

function getStatusAll(): Promise<DurableOrchestrationStatus[]>

Retours

Promise<DurableOrchestrationStatus[]>

getStatusBy(OrchestrationFilter)

Obtient l’état de toutes les instances d’orchestration qui correspondent aux conditions spécifiées.

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

Paramètres

filter: OrchestrationFilter

objet OrchestrationFilter spécifiant les orchestrations à récupérer.

Retours

Promise<DurableOrchestrationStatus[]>

purgeInstanceHistory(string)

Videz l’historique d’une instance d’orchestration spécifique.

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

Paramètres

instanceId: string

ID de l’instance d’orchestration à vider.

Retours

Promise<PurgeHistoryResult>

purgeInstanceHistoryBy(OrchestrationFilter)

Videz l’historique d’orchestration des instances qui correspondent aux conditions.

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

Paramètres

filter: OrchestrationFilter

objet OrchestrationFilter spécifiant les orchestrations à purger.

Retours

Promise<PurgeHistoryResult>

raiseEvent(string, string, unknown, TaskHubOptions)

Envoie un message de notification d’événement à une instance d’orchestration en attente.

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

Paramètres

instanceId: string

ID de l’instance d’orchestration qui gère l’événement.

eventName: string

Nom de l’événement.

eventData: unknown

Données sérialisables JSON associées à l’événement.

options: TaskHubOptions

objet fournissant TaskHubName de l’instance d’orchestration et le nom de sa chaîne de connexion associée

Retours

Promise<void>

Promesse qui se résout lorsque le message de notification d’événement a été mis en file d’attente.

Pour gérer l’événement, l’instance d’orchestration cible doit attendre un événement nommé eventName à l’aide de waitForExternalEvent(string).

Si l’instance spécifiée est introuvable ou n’est pas en cours d’exécution, cette opération n’aura aucun effet.

readEntityState<T>(EntityId, TaskHubOptions)

Tente de lire l’état actuel d’une entité. Retourne une valeur non définie si l’entité n’existe pas ou si l’état json sérialisé de l’entité est supérieur à 16 Ko.

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

Paramètres

entityId: EntityId

Entité cible.

options: TaskHubOptions

objet facultatif fournissant le TaskHubName de l’entité cible et le nom de sa chaîne de connexion associée

Retours

Promise<EntityStateResponse<T>>

Réponse contenant l’état actuel de l’entité.

rewind(string, string, TaskHubOptions)

Rembobine l’instance d’orchestration ayant échoué spécifiée avec une raison.

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

Paramètres

instanceId: string

ID de l’instance d’orchestration à rembobiner.

reason: string

Motif du rembobinage de l’instance d’orchestration.

options: TaskHubOptions

objet fournissant TaskHubName de l’instance d’orchestration et le nom de sa chaîne de connexion associée

Retours

Promise<void>

Promesse qui se résout lorsque le message de rembobinage est mis en file d’attente.

Cette fonctionnalité est actuellement en préversion.

signalEntity(EntityId, string, unknown, TaskHubOptions)

Signale à une entité d’effectuer une opération.

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

Paramètres

entityId: EntityId

Entité cible.

operationName: string

Nom de l’opération.

operationContent: unknown

Contenu de l’opération.

options: TaskHubOptions

objet fournissant TaskHubName de l’instance d’entité et le nom de sa chaîne de connexion associée

Retours

Promise<void>

startNew(string, StartNewOptions)

Démarre une nouvelle instance de la fonction d’orchestrateur spécifiée.

Si une instance d’orchestration avec l’ID spécifié existe déjà, l’instance existante est remplacée en mode silencieux par cette nouvelle instance.

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

Paramètres

orchestratorFunctionName: string

Nom de la fonction d’orchestrateur à démarrer.

options: StartNewOptions

objet facultatif pour contrôler l’orchestrateur planifié (par exemple, fournir une entrée, instanceID)

Retours

Promise<string>

ID de la nouvelle instance d’orchestration.

terminate(string, string)

Termine une instance d’orchestration en cours d’exécution.

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

Paramètres

instanceId: string

ID de l’instance d’orchestration à arrêter.

reason: string

Raison de la fin de l’instance d’orchestration.

Retours

Promise<void>

Promesse qui se résout lorsque le message d’arrêt est mis en file d’attente.

La fin d’une instance d’orchestration n’a aucun effet sur les exécutions de fonctions d’activité en cours ou les sous-orchestrations démarrées par l’instance d’orchestration actuelle.

waitForCompletionOrCreateCheckStatusResponse(HttpRequest, string, WaitForCompletionOptions)

Crée une réponse HTTP qui contient une charge utile d’URL de gestion pour une instance non terminée ou contient la charge utile contenant la sortie de l’orchestration terminée.

Si l’orchestration ne se termine pas dans le délai d’expiration spécifié, la réponse HTTP est identique à celle de createCheckStatusResponse().

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

Paramètres

request: HttpRequest

Requête HTTP qui a déclenché la fonction actuelle.

instanceId: string

ID unique de l’instance à vérifier.

waitOptions: WaitForCompletionOptions

objet options spécifiant les délais d’attente pendant combien de temps attendre la sortie de la fonction durable et la fréquence de vérification de la sortie.

Retours

Promise<HttpResponse>