@azure/core-lro package
Schnittstellen
| CreateHttpPollerOptions |
Optionen für |
| OperationConfig |
Konfigurationen zum Abrufen des Vorgangs und zum Überprüfen, ob er beendet wurde. |
| OperationResponse |
Der Typ der Antwort eines LRO. |
| OperationState |
Während der Abrufer als lokaler Steuerungsmechanismus funktioniert, um mit dem Auslösen zu beginnen und auf einen langen Vorgang zu warten, dokumentiert OperationState den Status des Remote-Long-Running-Vorgangs. Sie wird nach jeder Umfrage aktualisiert. |
| PollerLike |
Ein Poller für einen Vorgang. |
| RawRequest |
Einfacher Typ der rohen Anforderung. |
| RawResponse |
Einfacher Typ der unformatierten Antwort. |
| RunningOperation |
Beschreibung eines vorgangs mit langer Ausführung. |
Typaliase
| CancelOnProgress |
CancelOnProgress wird als Rückgabewert der OnProgress-Methode eines Pollers verwendet. Wenn ein Benutzer onProgress aufruft, muss er eine Funktion übergeben, die bei jeder Aktualisierung des Abrufvorgangs als Rückruf mit den neuen Daten aufgerufen wird. onProgress gibt eine Funktion zurück, die verhindert, dass weitere Aktualisierungen zum ursprünglichen Rückruf gelangen. |
| OperationStatus |
Der Satz möglicher Zustände, in dem sich ein Vorgang zu einem bestimmten Zeitpunkt befinden kann. |
| ResourceLocationConfig |
Der mögliche Standort des Ergebnisses der LRO, wenn die LRO-Erweiterung im Swagger angegeben wird. |
| RestorableOperationState |
Typ eines wiederherstellbaren lang ausgeführten Vorgangs. |
Functions
| create |
Erstellt einen Poller, der zum Abrufen eines lange ausgeführten Vorgangs verwendet werden kann. |
| deserialize |
Deserialisiert den Zustand |
Details zur Funktion
createHttpPoller<TResult, TState>(RunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
Erstellt einen Poller, der zum Abrufen eines lange ausgeführten Vorgangs verwendet werden kann.
function createHttpPoller<TResult, TState>(lro: RunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): PollerLike<TState, TResult>Parameter
- lro
-
RunningOperation<unknown>
Beschreibung des lang ausgeführten Vorgangs
- options
-
CreateHttpPollerOptions<TResult, TState>
Optionen zum Konfigurieren des Pollers
Gibt zurück
PollerLike<TState, TResult>
initialisiertes Poller
deserializeState<TResult, TState>(string)
Deserialisiert den Zustand
function deserializeState<TResult, TState>(serializedState: string): RestorableOperationState<TResult, TState>Parameter
- serializedState
-
string
Gibt zurück
RestorableOperationState<TResult, TState>