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

Det här projektet används som ett mallpaket för Azure SDKs för JavaScript. Den är avsedd att hjälpa Azure SDKs-utvecklare att starta nya paket, och den ger ett exempel på hur du organiserar koden och dokumentationen för ett klientbibliotek för en Azure-tjänst.

Komma igång

Miljöer som stöds för närvarande

Mer information finns i vår supportprincip.

Förutsättningar

Vanligtvis placerar du ett skalkommando för att etablera nödvändiga Azure-tjänster här.

Installera @azure/template-paketet

Installera mallklientbiblioteket för JavaScript med npm:

npm install @azure/template

Webbläsarstöd

JavaScript-paket

Om du vill använda det här klientbiblioteket i webbläsaren måste du först använda en bundler. Mer information om hur du gör detta finns i vår paketeringsdokumentation.

CORS

Du måste konfigurera CORS-regler (Cross-Origin Resource Sharing) för ditt lagringskonto om du behöver utveckla för webbläsare. Gå till Azure Portal och Azure Storage Explorer, hitta ditt lagringskonto, skapa nya CORS-regler för blob-/kö-/fil-/tabelltjänster.

Du kan till exempel skapa följande CORS-inställningar för felsökning. Men anpassa inställningarna noggrant enligt dina krav i en produktionsmiljö.

  • Tillåtna ursprung: *
  • Tillåtna verb: DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT
  • Tillåtna rubriker: *
  • Exponerade rubriker: *
  • Maximal ålder (sekunder): 86400

Ytterligare exempel

Exempel på toppnivå inkluderar vanligtvis saker som att skapa och autentisera huvudklienten. Om din tjänst stöder flera metoder för autentisering (e.g. key-baserad och Azure Active Directory) kan du ge ett separat exempel på var och en.

Viktiga begrepp

ConfigurationClient

Beskriv din primära kund här. Prata om vilka åtgärder den kan göra och när en utvecklare skulle vilja använda den.

Ytterligare exempel

Skapa ett avsnitt för varje servicekoncept på den översta nivån som du vill förklara.

Examples

Första exemplet

Skapa flera kodexempel för hur någon skulle använda ditt bibliotek för att utföra en vanlig uppgift med tjänsten.

Troubleshooting

Loggar

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg med HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Du kan också aktivera loggning vid körning genom att anropa setLogLevel i @azure/logger:

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

setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i dokument för @azure/logger-paket.

Nästa steg

Ta gärna en titt på katalogen samples för detaljerade exempel som visar hur man använder klientbiblioteken.

Contributing

Om du vill bidra till det här biblioteket kan du läsa bidragsguide för att lära dig mer om hur du skapar och testar koden.

  • Last updated on