Condividi tramite

@azure/core-lro package

  • Riferimento

Classi

LroEngine

Motore LRO, classe che esegue il polling.
Poller

Classe che rappresenta la definizione di un programma che esegue il polling tramite richieste consecutive fino a quando non raggiunge uno stato di completamento.

Un poller può essere eseguito manualmente, eseguendo il polling della richiesta tramite richiesta chiamando ripetutamente il metodo, fino al completamento dell'operazione poll() . Fornisce anche un modo per attendere il completamento dell'operazione, chiamando pollUntilDone() e aspettando il completamento dell'operazione. I poller possono anche richiedere l'annullamento del processo in corso a cui viene fornito l'operazione a esecuzione prolungata sottostante.

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();

Il poller è definito da due tipi, un tipo che rappresenta lo stato del poller, che deve includere un set di proprietà di base da PollOperationState<TResult>e un tipo restituito definito da TResult, che può essere qualsiasi elemento.

La classe Poller implementa l'interfaccia PollerLike , che consente l'implementazione del poller per evitare di dover esportare direttamente la classe di Poller ed esportare solo il poller già creato con il tipo 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 poller può essere creato tramite il relativo costruttore, quindi può essere eseguito il polling fino al completamento. In qualsiasi momento, lo stato del poller può essere ottenuto senza ritardo tramite il metodo getOperationState. In qualsiasi momento, le forme intermedie del tipo di risultato possono essere richieste senza ritardo. Una volta completata l'operazione sottostante, il poller si arresterà e il valore finale verrà restituito.

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

Quando l'operazione viene annullata, il poller verrà rifiutato con un'istanza del PollerCancelledError.
PollerStoppedError

Quando un poller viene arrestato manualmente tramite il stopPolling metodo, il poller verrà rifiutato con un'istanza di PollerStoppedError.

Interfacce

CreateHttpPollerOptions

Opzioni per createPoller.
LongRunningOperation

Descrizione di un'operazione a esecuzione prolungata.
LroEngineOptions

Opzioni per il poller LRO.
LroResponse

Tipo della risposta di un LRO.
OperationState

Mentre il poller funziona come meccanismo di controllo locale per avviare l'attivazione e attendere un'operazione a esecuzione prolungata, OperationState documenta lo stato dell'operazione a esecuzione prolungata remota. Viene aggiornato dopo ogni polling.
PollOperation

PollOperation è un'interfaccia che definisce come aggiornare il riferimento locale dello stato dell'operazione a esecuzione prolungata remota, oltre a come richiedere l'annullamento della stessa operazione.

Ha anche un metodo per serializzare l'operazione in modo che possa essere archiviato e ripreso in qualsiasi momento.
PollOperationState

PollOperationState contiene un elenco di opinioni del set più piccolo di proprietà necessarie per definire qualsiasi poller di operazione a esecuzione prolungata.

Mentre la classe Poller funziona come meccanismo di controllo locale per avviare l'attivazione, attendere e annullare potenzialmente un'operazione a esecuzione prolungata, pollOperationState documenta lo stato dell'operazione a esecuzione prolungata remota.

Deve essere aggiornato almeno all'avvio dell'operazione, al termine dell'operazione e al momento dell'annullamento. Tuttavia, le implementazioni possono avere qualsiasi altro numero di proprietà che possono essere aggiornate da altri motivi.
PollerLike

Rappresentazione astratta di un poller, destinata a esporre solo l'API minima con cui l'utente deve lavorare.
RawResponse

Tipo semplice della risposta non elaborata.
SimplePollerLike

Interfaccia semplice del poller.

Alias tipo

CancelOnProgress

CancelOnProgress viene usato come valore restituito del metodo onProgress di Un Poller. Quando un utente richiama onProgress, è necessario passare una funzione che verrà chiamata come callback con i nuovi dati ricevuti ogni volta che l'operazione di polling viene aggiornata. onProgress restituisce una funzione che impedirà un ulteriore aggiornamento per raggiungere il callback originale.
LroResourceLocationConfig

Posizione potenziale del risultato dell'LRO se specificata dall'estensione LRO nel swagger.
OperationStatus

Il set di possibili stati un'operazione può trovarsi in qualsiasi momento.
PollProgressCallback

PollProgressCallback è il tipo delle funzioni di callback inviate a onProgress. Queste funzioni riceveranno un TState definito dall'implementazione della classe Poller.

Funzioni

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

Crea un poller che può essere usato per eseguire il polling di un'operazione a esecuzione prolungata.

Dettagli funzione

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

Crea un poller che può essere usato per eseguire il polling di un'operazione a esecuzione prolungata.

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

Parametri

lro

LongRunningOperation<unknown>

Descrizione dell'operazione a esecuzione prolungata

options

CreateHttpPollerOptions<TResult, TState>

opzioni per configurare il poller

Restituisce

Promise<SimplePollerLike<TState, TResult>>

un poller inizializzato