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

Artikel
04/13/2024

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

@azure/core-lrofolgt den Azure SDK-Entwurfsrichtlinien für Vorgänge mit langer Ausführungsdauer.

Wichtige Links:

Erste Schritte

Die derzeitig unterstützten Umgebungen

LTS-Versionen von Node.js
Neueste Versionen von Safari, Chrome, Edge und Firefox.

Installation

Dieses Paket wird in erster Linie in generiertem Code verwendet und ist nicht für die direkte Nutzung durch Endbenutzer gedacht.

Wichtige Begriffe

`SimplePollerLike`

Ein Poller ist ein Objekt, das den lang ausgeführten Vorgang auf dem Server nach seinem Zustand abfragen 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 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 sollen, wenn eine Abfrageantwort empfangen wird
poll: sendet eine einzelne Abfrageanforderung
pollUntilDone: Gibt eine Zusage zurück, die mit dem Ergebnis des Vorgangs aufgelöst wird.
stopPolling: beendet die Abfrage;
toString: Serialisiert den Zustand des Pollers

`OperationState`

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

switch(poller.getOperationState().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 bei Auftreten von Fehlern wie folgt:

ruft an und pollpollUntilDone löst 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 der Vorgang fehlschlägt oder eine Fehlerantwort zurückgibt.

Beispiele

Beispiele finden Sie im Ordner samples.

Problembehandlung

Protokollierung

Protokolle können nach Eigenem Ermessen der Bibliothek hinzugefügt werden, die den Abfragevorgang mit langer Ausführung implementiert. Pakete in azure-sdk-for-js verwenden @azure/Protokollierung.

Nächste Schritte

Ausführliche Beispiele zur Verwendung dieser Bibliothek finden Sie im Beispielverzeichnis .

Mitwirken

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie die Anleitung für Mitwirkende, um mehr darüber zu erfahren, wie Sie den Code erstellen und testen können.

Testen

Installieren Sie zum Ausführen unserer Tests zuerst die Abhängigkeiten (mit npm install oder rush install), und führen Sie dann die Komponententests mit aus: npm run unit-test.

Verhaltenskodex

Für dieses Projekt gelten die Microsoft-Verhaltensregeln für Open Source (Microsoft Open Source Code of Conduct). Weitere Informationen finden Sie in den häufig gestellten Fragen zum Verhaltenskodex. Sie können sich auch an opencode@microsoft.com wenden, wenn Sie weitere Fragen oder Anmerkungen haben.

Aufrufe

Share via