@azure/core-lro package
Interfészek
| CreateHttpPollerOptions |
A |
| OperationConfig |
Konfigurációk a művelet lekérdezéséhez és annak ellenőrzéséhez, hogy a művelet leállt-e. |
| OperationResponse |
Az LRO válaszának típusa. |
| OperationState |
Bár a lekérdezés helyi vezérlő mechanizmusként működik a hosszú ideig futó művelet aktiválásának és várakozásának megkezdéséhez, az OperationState dokumentálja a távoli, hosszan futó művelet állapotát. Minden szavazás után frissül. |
| PollerLike |
Egy lekérdezés egy művelethez. |
| RawRequest |
A nyers kérelem egyszerű típusa. |
| RawResponse |
A nyers válasz egyszerű típusa. |
| RunningOperation |
Egy hosszú ideig futó művelet leírása. |
Típusaliasok
| CancelOnProgress |
A CancelOnProgress a Poller onProgress metódusának visszatérési értéke. Amikor egy felhasználó meghívja az onProgress szolgáltatást, egy olyan függvényt kell átadnia, amely visszahívásként lesz meghívva a lekérdezési művelet minden egyes frissítésekor kapott új adatokkal. Az onProgress egy függvényt ad vissza, amely megakadályozza, hogy a további frissítések elérjék az eredeti visszahívást. |
| OperationStatus |
A műveletek lehetséges állapotainak halmaza bármikor be lehet állítva. |
| ResourceLocationConfig |
Az LRO eredményének lehetséges helye, ha a Swagger LRO-bővítménye határozza meg. |
| RestorableOperationState |
Helyreállítható, hosszú ideig futó művelet típusa. |
Függvények
| create |
Létrehoz egy lekérdezést, amely egy hosszú ideig futó művelet lekérdezésére használható. |
| deserialize |
Deszerializálja az állapotot |
Függvény adatai
createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
Létrehoz egy lekérdezést, amely egy hosszú ideig futó művelet lekérdezésére használható.
function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>Paraméterek
- lro
-
RunningOperation<unknown>
A hosszú ideig futó művelet leírása
- options
-
CreateHttpPollerOptions<TResult, TState>
beállítások a lekérdezés konfigurálásához
Válaszok
PollerLike<TState, TResult>
inicializált poller
deserializeState<TResult, TState>(string)
Deszerializálja az állapotot
function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>Paraméterek
- serializedState
-
string
Válaszok
RestorableOperationState<TResult, TState>