Freigeben über

Azure Template-Clientbibliothek für JavaScript – Version 1.0.0-beta.1

  • Artikel

Dieses Projekt wird als Vorlagenpaket für das Azure SDK für JavaScript verwendet. Es soll Azure SDK-Entwicklern beim Bootstrap neuer Pakete helfen und bietet ein Beispiel für die Organisation des Codes und der Dokumentation einer Clientbibliothek für einen Azure-Dienst.

Erste Schritte

Die derzeitig unterstützten Umgebungen

Ausführlichere Informationen finden Sie in der Supportrichtlinie.

Voraussetzungen

Normalerweise setzen Sie hier einen Shellbefehl zum Bereitstellen der erforderlichen Azure-Dienste.

Installieren Sie das Paket @azure/template.

Installieren Sie die Vorlagenclientbibliothek für JavaScript mit npm:

npm install @azure/template

Browserunterstützung

JavaScript-Bundle

Um diese Clientbibliothek im Browser zu verwenden, müssen Sie zunächst einen Bundler verwenden. Ausführliche Informationen dazu finden Sie in unserer Bündelungsdokumentation.

CORS

Sie müssen CORS-Regeln (Cross-Origin Resource Sharing) für Ihr Speicherkonto einrichten, wenn Sie für Browser entwickeln müssen. Wechseln Sie zu Azure-Portal und Azure Storage-Explorer, suchen Sie Nach Ihrem Speicherkonto, und erstellen Sie neue CORS-Regeln für Blob-,Warteschlangen-,Datei-/Tabellendienste.

Sie können beispielsweise die folgenden CORS-Einstellungen für das Debuggen erstellen. Aber bitte passen Sie die Einstellungen sorgfältig an Ihre Anforderungen in einer Produktionsumgebung an.

  • Zulässige Ursprünge: *
  • Zulässige Verben: DELETE,GET,HEAD,MERGE,POST,OPTIONS,PUT
  • Zulässige Header: *
  • Verfügbar gemachte Header: *
  • Maximales Alter (Sekunden): 86400

Weitere Beispiele

Beispiele auf oberster Ebene umfassen in der Regel das Erstellen und Authentifizieren des Standard-Clients. Wenn Ihr Dienst mehrere Methoden der Authentifizierung unterstützt (z. B. schlüsselbasiert und Azure Active Directory), können Sie jeweils ein separates Beispiel für diese Elemente geben.

Wichtige Begriffe

ConfigurationClient

Beschreiben Sie hier Ihren primären Client. Sprechen Sie darüber, welche Vorgänge es ausführen kann und wann ein Entwickler sie verwenden möchte.

Zusätzliche Beispiele

Erstellen Sie einen Abschnitt für jedes Dienstkonzept der obersten Ebene, das Sie erläutern möchten.

Beispiele

Erstes Beispiel

Erstellen Sie mehrere Codebeispiele, wie jemand Ihre Bibliothek verwenden würde, um eine allgemeine Aufgabe mit dem Dienst zu erledigen.

Problembehandlung

Protokollierung

Die Aktivierung der Protokollierung kann hilfreiche Informationen über Fehler aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die Umgebungsvariable AZURE_LOG_LEVEL auf info fest. Alternativ kann die Protokollierung zur Laufzeit aktiviert werden, indem Sie setLogLevel in @azure/logger aufrufen:

const { setLogLevel } = require("@azure/logger");

setLogLevel("info");

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in der Paketdokumentation zu @azure/logger.

Nächste Schritte

Sehen Sie sich das Beispielverzeichnis an, um detaillierte Beispiele zu finden, die die Verwendung der Clientbibliotheken veranschaulichen.

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.

Aufrufe