Azure Template Client Library for JavaScript - Version 1.0.0-beta.3

Dieses Projekt wird als Vorlagenpaket für das Azure SDK für JavaScript verwendet. Er soll Azure SDK-Entwicklern beim Bootstrapping neuer Pakete helfen und bietet ein Beispiel dafür, wie der Code und die Dokumentation einer Clientbibliothek für einen Azure-Dienst organisiert werden.

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Voraussetzungen

Normalerweise würden Sie hier einen Shell-Befehl zum Bereitstellen der erforderlichen Azure-Dienste einfügen.

Installieren Sie das @azure/template-Paket

Installieren Sie die Vorlagen-Client-Bibliothek für JavaScript mit npm:

npm install @azure/template

Browserunterstützung

JavaScript-Bündel

Um diese Clientbibliothek im Browser zu verwenden, müssen Sie zuerst 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. Navigieren Sie zum Azure-Portal und zum Azure Storage-Explorer, suchen Sie Ihr Speicherkonto, und erstellen Sie neue CORS-Regeln für Blob-/Warteschlangen-/Datei-/Tabellendienste.

Sie können z. B. die folgenden CORS-Einstellungen für das Debuggen erstellen. Bitte passen Sie die Einstellungen jedoch sorgfältig an Ihre Anforderungen in einer Produktionsumgebung an.

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

Weitere Beispiele

Beispiele für die oberste Ebene umfassen in der Regel Dinge wie das Erstellen und Authentifizieren des Hauptclients. Wenn Ihr Dienst mehrere Authentifizierungsmittel unterstützt (e.g. key-basiert und Azure Active Directory), können Sie für jede ein separates Beispiel angeben.

Wichtige Begriffe

ConfigurationClient

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

Zusätzliche Beispiele

Erstellen Sie einen Abschnitt für jedes Top-Level-Servicekonzept, das Sie erläutern möchten.

Beispiele

Erstes Beispiel

Erstellen Sie mehrere Codebeispiele dafür, wie jemand Ihre Bibliothek verwenden würde, um eine allgemeine Aufgabe mit dem Dienst auszuführen.

Problembehandlung

Protokollierung

Das Aktivieren der Protokollierung kann hilfreiche Informationen zu Fehlern aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die AZURE_LOG_LEVEL Umgebungsvariable auf infofest. Alternativ kann die Protokollierung zur Laufzeit durch Aufrufen von setLogLevel im @azure/loggeraktiviert werden:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in den @azure/Logger-Paketdokumenten.

Nächste Schritte

Bitte schauen Sie sich das Verzeichnis samples an, um detaillierte Beispiele zu finden, die zeigen, wie man die Client-Bibliotheken verwendet.

Contributing

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.

  • Last updated on