@azure/core-lro package
Klassen
LroEngine |
Die LRO-Engine, eine Klasse, die Abrufvorgänge durchführt. |
Poller |
Eine Klasse, die die Definition eines Programms darstellt, das aufeinanderfolgende Anforderungen abruft, bis es einen Abschlussstatus erreicht. Ein Poller kann manuell ausgeführt werden, indem anforderungsweise durch wiederholtes Aufrufen der
Der Poller wird durch zwei Typen definiert: ein Typ, der den Zustand des Pollers darstellt, der einen grundlegenden Satz von Eigenschaften aus Die Poller-Klasse implementiert die
Ein Poller kann über seinen Konstruktor erstellt und dann abgefragt werden, bis er abgeschlossen ist. Der Zustand des Pollers kann jederzeit ohne Verzögerung über die getOperationState-Methode abgerufen werden. Die Zwischenformen des Ergebnistyps können jederzeit ohne Verzögerung angefordert werden. Sobald der zugrunde liegende Vorgang als abgeschlossen markiert ist, wird der Poller beendet, und der endgültige Wert wird zurückgegeben.
|
PollerCancelledError |
Wenn der Vorgang abgebrochen wird, wird der Poller mit einer Instanz von PollerCancelledError abgelehnt. |
PollerStoppedError |
Wenn ein Poller manuell über die |
Schnittstellen
CreateHttpPollerOptions |
Optionen für |
LongRunningOperation |
Beschreibung eines Vorgangs mit langer Ausführungsdauer. |
LroEngineOptions |
Optionen für den LRO-Poller. |
LroResponse |
Der Typ der Antwort eines LRO. |
OperationState |
Während der Poller als lokaler Steuerungsmechanismus fungiert, um mit dem Auslösen zu beginnen und auf einen Vorgang mit langer Ausführungszeit zu warten, dokumentiert OperationState den Status des Remotevorgangs mit langer Ausführungsdauer. Sie wird nach jeder Umfrage aktualisiert. |
PollOperation |
PollOperation ist eine Schnittstelle, die definiert, wie der lokale Verweis des Zustands des Remotevorgangs mit langer Ausführungsdauer aktualisiert wird, ebenso wie das Anfordern des Abbruchs desselben Vorgangs. Es verfügt auch über eine Methode zum Serialisieren des Vorgangs, sodass er jederzeit gespeichert und fortgesetzt werden kann. |
PollOperationState |
PollOperationState enthält eine liste der kleinsten Eigenschaften, die zum Definieren von Abfragevorgängen mit langer Ausführungszeit erforderlich sind. Während die Poller-Klasse als lokaler Steuerungsmechanismus zum Starten des Auslösens, Wartens und Abbrechen eines vorgangs mit langer Ausführung funktioniert, dokumentiert PollOperationState den Status des Remotevorgangs mit langer Ausführungsdauer. Es sollte mindestens aktualisiert werden, wenn der Vorgang gestartet wird, wenn er abgeschlossen ist und wenn er abgebrochen wird. Implementierungen können jedoch eine beliebige andere Anzahl von Eigenschaften aufweisen, die aus anderen Gründen aktualisiert werden können. |
PollerLike |
Abstrakte Darstellung eines Pollers, die nur die minimale API verfügbar machen soll, mit der der Benutzer arbeiten muss. |
RawResponse |
Einfacher Typ der Unformatierten Antwort. |
SimplePollerLike |
Eine einfache Poller-Schnittstelle. |
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 mit den neuen Daten als Rückruf aufgerufen wird. onProgress gibt eine Funktion zurück, die verhindert, dass weitere Aktualisierungen den ursprünglichen Rückruf erreichen. |
LroResourceLocationConfig |
Die potenzielle Position des Ergebnisses der LRO, wenn es durch die LRO-Erweiterung im Swagger angegeben wird. |
OperationStatus |
Der Satz möglicher Zustände, in dem sich ein Vorgang zu einem beliebigen Zeitpunkt befinden kann. |
PollProgressCallback |
PollProgressCallback ist der Typ der Rückruffunktionen, die an onProgress gesendet werden. Diese Funktionen erhalten einen TState, der von Ihrer Implementierung der Poller-Klasse definiert wird. |
Functions
create |
Erstellt einen Poller, der zum Abfragen eines Vorgangs mit langer Ausführungszeit verwendet werden kann. |
Details zur Funktion
createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)
Erstellt einen Poller, der zum Abfragen eines Vorgangs mit langer Ausführungszeit verwendet werden kann.
function createHttpPoller<TResult, TState>(lro: LongRunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): Promise<SimplePollerLike<TState, TResult>>
Parameter
- lro
-
LongRunningOperation<unknown>
Beschreibung des zeitintensiven Vorgangs
- options
-
CreateHttpPollerOptions<TResult, TState>
Optionen zum Konfigurieren des Abrufs
Gibt zurück
Promise<SimplePollerLike<TState, TResult>>
ein initialisierter Poller