Klientská knihovna šablon Azure pro JavaScript – verze 1.0.0-beta.1

  • Článek

Tento projekt se používá jako balíček šablony pro sadu Azure SDK pro JavaScript. Jejím cílem je pomoct vývojářům sady Azure SDK spustit nové balíčky a poskytuje příklad uspořádání kódu a dokumentace klientské knihovny pro službu Azure.

Začínáme

Aktuálně podporovaná prostředí

  • LtS verze Node.js
  • Nejnovější verze prohlížečů Safari, Chrome, Edge a Firefox.

Další podrobnosti najdete v našich zásadách podpory .

Požadavky

Obvykle byste sem umístili příkaz prostředí pro zřízení potřebných služeb Azure.

Nainstalujte balíček @azure/template.

Nainstalujte klientskou knihovnu šablon pro JavaScript pomocí npm:

npm install @azure/template

Podpora prohlížečů

JavaScript Bundle

Pokud chcete tuto klientskou knihovnu používat v prohlížeči, musíte nejprve použít nástroj bundler. Podrobnosti o tom, jak to udělat, najdete v naší dokumentaci k sdružování.

CORS

Pokud potřebujete vyvíjet pro prohlížeče, musíte pro svůj účet úložiště nastavit pravidla sdílení prostředků mezi zdroji (CORS ). Přejděte na Azure Portal a Průzkumník služby Azure Storage, vyhledejte svůj účet úložiště a vytvořte nová pravidla CORS pro služby objektů blob, fronty, souborů a tabulek.

Můžete například vytvořit následující nastavení CORS pro ladění. Přizpůsobte ale nastavení pečlivě podle svých požadavků v produkčním prostředí.

  • Povolené původy: *
  • Povolené příkazy: DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT
  • Povolené hlavičky: *
  • Vystavené hlavičky: *
  • Maximální věk (sekundy): 86400

Další příklady

Příklady nejvyšší úrovně obvykle zahrnují například vytvoření a ověření hlavního klienta. Pokud vaše služba podporuje více prostředků ověřování (např. na základě klíčů a Azure Active Directory), můžete uvést samostatný příklad každého z nich.

Klíčové koncepty

ConfigurationClient

Tady popište svého primárního klienta. Promluvte si o tom, jaké operace může provádět a kdy ho vývojář chce použít.

Další příklady

Vytvořte oddíl pro každý koncept služby nejvyšší úrovně, který chcete vysvětlit.

Příklady

První příklad

Vytvořte několik příkladů kódu, jak by někdo použil vaši knihovnu k provádění společné úlohy se službou.

Poradce při potížích

protokolování

Povolení protokolování může pomoct odhalit užitečné informace o selháních. Pokud chcete zobrazit protokol požadavků a odpovědí HTTP, nastavte proměnnou AZURE_LOG_LEVEL prostředí na info. Případně je možné protokolování povolit za běhu voláním setLogLevel v :@azure/logger

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

setLogLevel("info");

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k balíčkům @azure/protokolovacího nástroje.

Další kroky

Podrobné příklady, které ukazují, jak používat klientské knihovny, najdete v adresáři samples .

Přispívání

Pokud chcete přispívat do této knihovny, přečtěte si příručku pro přispívání , kde najdete další informace o tom, jak sestavit a otestovat kód.

Imprese