Partager via

@azure/core-lro package

  • Référence

Classes

LroEngine

Moteur LRO, une classe qui effectue l’interrogation.
Poller

Classe qui représente la définition d’un programme qui interroge des requêtes consécutives jusqu’à ce qu’il atteigne un état d’achèvement.

Un polleur peut être exécuté manuellement, en interrogeant demande par requête en appelant la méthode à plusieurs reprises, jusqu’à poll() ce que son opération soit terminée. Il permet également d’attendre la fin de l’opération, en appelant pollUntilDone() et en attendant la fin de l’opération. Les pollueurs peuvent également demander l’annulation du processus en cours à qui fournit l’opération de longue durée sous-jacente.

const poller = new MyPoller();

// Polling just once:
await poller.poll();

// We can try to cancel the request here, by calling:
//
//     await poller.cancelOperation();
//

// Getting the final result:
const result = await poller.pollUntilDone();

Le Poller est défini par deux types, un type représentant l’état du polleur, qui doit inclure un ensemble de propriétés de base de PollOperationState<TResult>, et un type de retour défini par TResult, qui peut être n’importe quoi.

La classe Poller implémente l’interface PollerLike , ce qui permet aux implémentations du polleur d’éviter d’avoir à exporter directement la classe de Poller et d’exporter uniquement l’polleur déjà instancié avec le type PollerLike.

class Client {
  public async makePoller: PollerLike<MyOperationState, MyResult> {
    const poller = new MyPoller({});
    // It might be preferred to return the poller after the first request is made,
    // so that some information can be obtained right away.
    await poller.poll();
    return poller;
  }
}

const poller: PollerLike<MyOperationState, MyResult> = myClient.makePoller();

Un polleur peut être créé via son constructeur, puis il peut être interrogé jusqu’à ce qu’il soit terminé. À tout moment, l’état du polleur peut être obtenu sans délai via la méthode getOperationState. À tout moment, les formes intermédiaires du type de résultat peuvent être demandées sans délai. Une fois l’opération sous-jacente marquée comme terminée, l’polleur s’arrête et la valeur finale est retournée.

const poller = myClient.makePoller();
const state: MyOperationState = poller.getOperationState();

// The intermediate result can be obtained at any time.
const result: MyResult | undefined = poller.getResult();

// The final result can only be obtained after the poller finishes.
const result: MyResult = await poller.pollUntilDone();
PollerCancelledError

Lorsque l’opération est annulée, l’polleur est rejeté avec une instance de PollerCancelledError.
PollerStoppedError

Lorsqu’un polleur est arrêté manuellement via la stopPolling méthode, celui-ci est rejeté avec une instance de PollerStoppedError.

Interfaces

CreateHttpPollerOptions

Options pour createPoller.
LongRunningOperation

Description d’une opération de longue durée.
LroEngineOptions

Options pour l’polleur LRO.
LroResponse

Type de la réponse d’un LRO.
OperationState

Alors que l’pollueur fonctionne comme le mécanisme de contrôle local pour commencer à déclencher et attendre une opération de longue durée, OperationState documente l’état de l’opération de longue durée distante. Il est mis à jour après chaque sondage.
PollOperation

PollOperation est une interface qui définit comment mettre à jour la référence locale de l’état de l’opération distante de longue durée, ainsi que comment demander l’annulation de la même opération.

Il dispose également d’une méthode pour sérialiser l’opération afin qu’elle puisse être stockée et reprise à tout moment.
PollOperationState

PollOperationState contient une liste opinionnée du plus petit ensemble de propriétés nécessaire pour définir un pollueur d’opérations de longue durée.

Alors que la classe Poller fonctionne comme le mécanisme de contrôle local pour démarrer le déclenchement, attendre et potentiellement annuler une opération de longue durée, pollOperationState documente l’état de l’opération distante de longue durée.

Il doit être mis à jour au moins lorsque l’opération démarre, quand elle est terminée et quand elle est annulée. Toutefois, les implémentations peuvent avoir n’importe quel autre nombre de propriétés qui peuvent être mises à jour pour d’autres raisons.
PollerLike

Représentation abstraite d’un polleur, destinée à exposer uniquement l’API minimale avec laquelle l’utilisateur doit travailler.
RawResponse

Type simple de la réponse brute.
SimplePollerLike

Interface d’interrogation simple.

Alias de type

CancelOnProgress

CancelOnProgress est utilisé comme valeur de retour de la méthode onProgress d’un Poller. Lorsqu’un utilisateur appelle onProgress, il doit passer une fonction qui sera appelée en tant que rappel avec les nouvelles données reçues chaque fois que l’opération d’interrogation est mise à jour. onProgress retourne une fonction qui empêche toute mise à jour supplémentaire d’atteindre le rappel d’origine.
LroResourceLocationConfig

Emplacement potentiel du résultat du LRO si spécifié par l’extension LRO dans le swagger.
OperationStatus

Ensemble d’états possibles où une opération peut se trouver à un moment donné.
PollProgressCallback

PollProgressCallback est le type des fonctions de rappel envoyées à onProgress. Ces fonctions recevront un TState défini par votre implémentation de la classe Poller.

Fonctions

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

Crée un pollueur qui peut être utilisé pour interroger une opération de longue durée.

Informations relatives à la fonction

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

Crée un pollueur qui peut être utilisé pour interroger une opération de longue durée.

function createHttpPoller<TResult, TState>(lro: LongRunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): Promise<SimplePollerLike<TState, TResult>>

Paramètres

lro

LongRunningOperation<unknown>

Description de l’opération de longue durée

options

CreateHttpPollerOptions<TResult, TState>

options pour configurer l’polleur

Retours

Promise<SimplePollerLike<TState, TResult>>

un polleur initialisé