Udostępnij za pośrednictwem


@azure/core-lro package

Interfejsy

CreateHttpPollerOptions

Opcje createPoller.

OperationConfig

Konfiguracje sposobu sondowania operacji i sprawdzania, czy operacja została zakończona.

OperationResponse

Typ odpowiedzi LRO.

OperationState

Podczas gdy narzędzie poller działa jako mechanizm kontroli lokalnej, aby rozpocząć wyzwalanie i czekać na długotrwałą operację, OperationState dokumentuje stan zdalnej długotrwałej operacji. Jest aktualizowany po każdym ankiecie.

PollerLike

Poller dla operacji.

RawRequest

Prosty typ nieprzetworzonego żądania.

RawResponse

Prosty typ nieprzetworzonej odpowiedzi.

RunningOperation

Opis długotrwałej operacji.

Aliasy typu

CancelOnProgress

Metoda CancelOnProgress jest używana jako wartość zwracana przez metodę onProgress firmy Poller. Gdy użytkownik wywołuje metodę onProgress, musi przekazać funkcję, która będzie wywoływana jako wywołanie zwrotne z nowymi danymi odebranymi za każdym razem, gdy operacja sondowania zostanie zaktualizowana. funkcja onProgress zwraca funkcję, która uniemożliwi dalszą aktualizację, aby uzyskać dostęp do oryginalnego wywołania zwrotnego.

OperationStatus

Zestaw możliwych stanów, w których operacja może znajdować się w danym momencie.

ResourceLocationConfig

Potencjalna lokalizacja wyniku LRO, jeśli jest określona przez rozszerzenie LRO w strukturze Swagger.

RestorableOperationState

Typ długotrwałej operacji możliwej do przywrócenia.

Funkcje

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

Tworzy narzędzie poller, którego można użyć do sondowania długotrwałej operacji.

deserializeState<TResult, TState>(string)

Deserializuje stan

Szczegóły funkcji

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

Tworzy narzędzie poller, którego można użyć do sondowania długotrwałej operacji.

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

Parametry

lro

RunningOperation<unknown>

Opis długotrwałej operacji

options

CreateHttpPollerOptions<TResult, TState>

opcje konfigurowania galerii

Zwraca

PollerLike<TState, TResult>

zainicjowany poller

deserializeState<TResult, TState>(string)

Deserializuje stan

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

Parametry

serializedState

string

Zwraca

RestorableOperationState<TResult, TState>