Freigeben über

Azure Core LRO-Clientbibliothek für JavaScript – Version 3.3.1

Dies ist die Standardimplementierung von Vorgängen mit langer Ausführung in JavaScript-Clientbibliotheken des Azure SDK, die sowohl im Browser als auch in NodeJS funktionieren. Diese Bibliothek soll in erster Linie in Code verwendet werden, der von AutoRest- und autorest.typescriptgeneriert wird.

@azure/core-lro folgt den Azure SDK-Entwurfsrichtlinien für lange ausgeführte Vorgänge

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Installation

Dieses Paket wird in erster Linie in generierten Code verwendet und sollte nicht direkt von Endbenutzern genutzt werden.

Wichtige Begriffe

SimplePollerLike

Ein Poller ist ein Objekt, mit dem der lange ausgeführte Vorgang auf dem Server abgerufen werden kann, bis er einen Terminalstatus erreicht. Es stellt die folgenden Methoden bereit:

  • getOperationState: gibt den Status des Vorgangs zurück, der als Typ eingegeben wird, der erweitert wird. OperationState
  • getResult: gibt das Ergebnis des Vorgangs zurück, wenn er abgeschlossen ist und undefined andernfalls
  • isDone: gibt zurück, ob sich der Vorgang in einem Terminalzustand befindet.
  • isStopped: gibt zurück, ob die Abfrage beendet wurde.
  • onProgress: registriert Rückruffunktionen, die jedes Mal aufgerufen werden, wenn eine Abrufantwort empfangen wird
  • poll: sendet eine einzelne Abfrageanforderung.
  • pollUntilDone: gibt eine Zusage zurück, die mit dem Ergebnis des Vorgangs aufgelöst wird.
  • stopPolling: abruft nicht mehr;
  • toString: Serialisiert den Zustand des Pollers.

OperationState

Ein Typ für den Vorgangszustand. Es enthält ein status Feld mit den folgenden möglichen Werten: notStarted, , running, , succeeded, failedund canceled. Auf sie kann wie folgt zugegriffen werden:

switch (poller.operationState.status) {
  case "succeeded": // return poller.getResult();
  case "failed": // throw poller.getOperationState().error;
  case "canceled": // throw new Error("Operation was canceled");
  case "running": // ...
  case "notStarted": // ...
}

createHttpPoller

Eine Funktion, die ein Objekt vom Typ SimplePollerLikezurückgibt. Dieser Poller verhält sich im Vorhandensein von Fehlern wie folgt:

  • Aufrufe an poll und pollUntilDone lösen einen Fehler aus, falls der Vorgang fehlgeschlagen oder abgebrochen wurde, es sei denn, die resolveOnUnsuccessful Option wurde auf "true" festgelegt.
  • poller.getOperationState().status wird auf "true" festgelegt, wenn entweder der Vorgang fehlschlägt oder eine Fehlerantwort zurückgegeben wird.

Beispiele

Beispiele finden Sie im Ordner samples.

Problembehandlung

Protokollierung

Protokolle können nach Eigenem Ermessen der Bibliothek hinzugefügt werden, die den Abrufvorgang "Long Running Operation" implementiert. Pakete innerhalb von azure-sdk-for-js verwenden @azure/Logger.

Nächste Schritte

Ausführliche Beispiele zur Verwendung dieser Bibliothek finden Sie in den Beispielen Verzeichnis.

Mitarbeit

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie bitte den mitwirkenden Leitfaden, um mehr über das Erstellen und Testen des Codes zu erfahren.

Testen

Um unsere Tests auszuführen, installieren Sie zuerst die Abhängigkeiten (mit pnpm install) und führen Sie dann die Komponententests mit folgendem aus: npm run unit-test.

Verhaltenskodex

Dieses Projekt hat den Microsoft Open Source Code of Conductübernommen. Weitere Informationen finden Sie im Code of Conduct FAQ oder wenden Sie sich an opencode@microsoft.com mit weiteren Fragen oder Kommentaren.

  • Last updated on