Azure Template client library for JavaScript - verze 1.0.0-beta.3

Tento projekt se používá jako balíček šablon pro sadu Azure SDK pro JavaScript. Jejím cílem je pomoci vývojářům sady Azure SDK spouštět nové balíčky a poskytuje příklad, jak uspořádat kód a dokumentaci klientské knihovny pro službu Azure.

Začínáme

Aktuálně podporovaná prostředí

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

Předpoklady

  • Předplatné služby Azure.

Obvykle byste sem umístili příkaz shellu pro poskytování nezbytných služeb Azure.

Nainstalujte balíček @azure/template.

Nainstalujte klientskou knihovnu Template pro JavaScript pomocí npm:

npm install @azure/template

Podpora prohlížečů

JavaScriptový balíček

Pokud chcete tuto klientskou knihovnu použít v prohlížeči, musíte nejprve použít bundler. Podrobnosti o tom, jak to udělat, najdete v naší dokumentaci 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, front, souborů nebo tabulek.

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

  • Povolené počátky: *
  • Povolená slovesa: DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT
  • Povolené hlavičky: *
  • Vystavené hlavičky: *
  • Maximální věk (sekund): 86400

Další příklady

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

Klíčové koncepty

ConfigurationClient

Zde popište svého primárního klienta. Mluvte o tom, jaké operace umí a kdy by ji vývojář chtěl použít.

Další příklady

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

Examples

První příklad

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

Řešení problémů

Protokolování

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

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

setLogLevel("info");

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k @azure/protokolovacímu balíčku.

Další kroky

Podívejte se prosím do adresáře samples pro podrobné příklady, které ukazují, jak používat klientské knihovny.

Contributing

Pokud chcete přispívat do této knihovny, přečtěte si průvodce přispívání a přečtěte si další informace o vytváření a testování kódu.