@azure/core-lro package

Interfaces

CreateHttpPollerOptions

Opções para createPoller.

OperationConfig

Configurações para sondar a operação e verificar se ela foi encerrada.

OperationResponse

O tipo de resposta de um LRO.

OperationState

Enquanto o poller funciona como o mecanismo de controle local para iniciar o acionamento e aguardar uma operação de longa duração, o OperationState documenta o status da operação remota de longa duração. Ele é atualizado após cada enquete.

PollerLike

Um poller para uma operação.

RawRequest

Tipo simples da solicitação bruta.

RawResponse

Tipo simples da resposta bruta.

RunningOperation

Descrição de uma operação de longa duração.

Aliases de Tipo

CancelOnProgress

CancelOnProgress é usado como o valor de retorno do método onProgress de um Poller. Quando um usuário invoca onProgress, ele é obrigado a passar uma função que será chamada como um retorno de chamada com os novos dados recebidos cada vez que a operação de pesquisa for atualizada. onProgress retorna uma função que impedirá que qualquer atualização adicional chegue ao retorno de chamada original.

OperationStatus

O conjunto de estados possíveis em que uma operação pode estar a qualquer momento.

ResourceLocationConfig

A localização potencial do resultado da ORL, se especificada pela extensão da ORL no swagger.

RestorableOperationState

Tipo de operação de longa duração restaurável.

Funções

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

Cria um poller que pode ser usado para sondar uma operação de longa duração.

deserializeState<TResult, TState>(string)

Desserializa o estado

Detalhes de Função

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

Cria um poller que pode ser usado para sondar uma operação de longa duração.

function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>

Parâmetros

lro

RunningOperation<unknown>

Descrição da operação de longa duração

options

CreateHttpPollerOptions<TResult, TState>

Opções para configurar o poller

Devoluções

PollerLike<TState, TResult>

um poller inicializado

deserializeState<TResult, TState>(string)

Desserializa o estado

function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>

Parâmetros

serializedState

string

Devoluções

RestorableOperationState<TResult, TState>