Compartir a través de

@azure/core-lro package

  • Referencia

Clases

LroEngine

LRO Engine, una clase que realiza el sondeo.
Poller

Clase que representa la definición de un programa que sondea a través de solicitudes consecutivas hasta que alcanza un estado de finalización.

Un sondeo se puede ejecutar manualmente, mediante la solicitud de sondeo mediante una llamada al método repetidamente, poll() hasta que se complete su operación. También proporciona una manera de esperar hasta que se complete la operación, llamando pollUntilDone() a y esperando hasta que finalice la operación. Los sondeos también pueden solicitar la cancelación del proceso en curso al que proporciona la operación subyacente de larga duración.

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

El sondeo se define mediante dos tipos, un tipo que representa el estado del sondeo, que debe incluir un conjunto básico de propiedades de PollOperationState<TResult>y un tipo de valor devuelto definido por TResult, que puede ser cualquier cosa.

La clase Poller implementa la PollerLike interfaz , que permite a las implementaciones de sondeo evitar tener que exportar la clase de Poller directamente y, en su lugar, solo exportar el sondeo ya creado con el 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();

Se puede crear un sondeo a través de su constructor y, a continuación, se puede sondear hasta que se complete. En cualquier momento, el estado del sondeo se puede obtener sin demora a través del método getOperationState. En cualquier momento, las formas intermedias del tipo de resultado se pueden solicitar sin demora. Una vez completada la operación subyacente, el sondeo se detendrá y se devolverá el valor final.

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

Cuando se cancela la operación, el sondeo se rechazará con una instancia de PollerCancelledError.
PollerStoppedError

Cuando un sondeo se detiene manualmente a través del stopPolling método , el sondeo se rechazará con una instancia de PollerStoppedError.

Interfaces

CreateHttpPollerOptions

Opciones de createPoller.
LongRunningOperation

Descripción de una operación de larga duración.
LroEngineOptions

Opciones para el sondeo LRO.
LroResponse

Tipo de la respuesta de un LRO.
OperationState

Aunque el sondeo funciona como mecanismo de control local para iniciar el desencadenamiento y esperar una operación de larga duración, OperationState documenta el estado de la operación remota de larga duración. Se actualiza después de cada sondeo.
PollOperation

PollOperation es una interfaz que define cómo actualizar la referencia local del estado de la operación remota de larga duración, así como cómo solicitar la cancelación de la misma operación.

También tiene un método para serializar la operación para que se pueda almacenar y reanudar en cualquier momento.
PollOperationState

PollOperationState contiene una lista fundamentada del conjunto más pequeño de propiedades necesarias para definir cualquier sondeo de operación de larga duración.

Aunque la clase Poller funciona como mecanismo de control local para iniciar el desencadenamiento, esperar y cancelar potencialmente una operación de larga duración, PollOperationState documenta el estado de la operación remota de larga duración.

Debe actualizarse al menos cuando se inicia la operación, cuando finalice y cuando se cancele. Sin embargo, las implementaciones pueden tener cualquier otro número de propiedades que se puedan actualizar por otros motivos.
PollerLike

Representación abstracta de un sondeo, diseñada para exponer solo la API mínima con la que el usuario necesita trabajar.
RawResponse

Tipo simple de la respuesta sin procesar.
SimplePollerLike

Una interfaz de sondeo simple.

Alias de tipos

CancelOnProgress

CancelOnProgress se usa como valor devuelto del método onProgress de un poller. Cuando un usuario invoca onProgress, es necesario pasar una función a la que se llamará como devolución de llamada con los nuevos datos recibidos cada vez que se actualiza la operación de sondeo. onProgress devuelve una función que impedirá que se actualice más para llegar a la devolución de llamada original.
LroResourceLocationConfig

La posible ubicación del resultado del LRO si se especifica mediante la extensión LRO en swagger.
OperationStatus

El conjunto de estados posibles en los que se puede realizar una operación puede estar en cualquier momento dado.
PollProgressCallback

PollProgressCallback es el tipo de las funciones de devolución de llamada enviadas a onProgress. Estas funciones recibirán un TState definido por la implementación de la clase Poller.

Funciones

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

Crea un sondeo que se puede usar para sondear una operación de larga duración.

Detalles de la función

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

Crea un sondeo que se puede usar para sondear una operación de larga duración.

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

Parámetros

lro

LongRunningOperation<unknown>

Descripción de la operación de ejecución prolongada

options

CreateHttpPollerOptions<TResult, TState>

opciones para configurar el sondeo

Devoluciones

Promise<SimplePollerLike<TState, TResult>>

un sondeo inicializado