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

Questo progetto viene usato come pacchetto modello per Azure SDK per JavaScript. Lo scopo è quello di aiutare gli sviluppatori di Azure SDK a eseguire il bootstrap di nuovi pacchetti e fornisce un esempio di come organizzare il codice e la documentazione di una libreria client per un servizio di Azure.

Come iniziare

Ambienti attualmente supportati

Per altri dettagli, vedere i criteri di supporto .

Prerequisiti

In genere si inserisce un comando shell per il provisioning dei servizi di Azure necessari.

Installare il pacchetto @azure/template

Installa la libreria client Template per JavaScript con npm:

npm install @azure/template

Supporto del browser

Pacchetto JavaScript

Per usare questa libreria client nel browser, è prima necessario usare un bundler. Per informazioni dettagliate su come eseguire questa operazione, vedere la documentazione di creazione di bundle .

CORS

Se è necessario sviluppare per i browser, è necessario configurare le regole CORS (Cross-Origin Resource Sharing) per l'account di archiviazione. Passare al portale di Azure e ad Azure Storage Explorer, trovare l'account di archiviazione, creare nuove regole CORS per i servizi BLOB/coda/file/tabelle.

Ad esempio, è possibile creare le impostazioni CORS seguenti per il debug. Tuttavia, si prega di personalizzare attentamente le impostazioni in base alle proprie esigenze in un ambiente di produzione.

  • Origini consentite: *
  • Verbi consentiti: DELETE,GET,HEAD,MERGE,POST,OPTIONS,PUT
  • Intestazioni consentite: *
  • Intestazioni esposte: *
  • Età massima (secondi): 86400

Altri esempi

Gli esempi di primo livello di solito includono cose come la creazione e l'autenticazione del client principale. Se il servizio supporta più metodi di autenticazione (basato su e.g. key e Azure Active Directory), è possibile fornire un esempio separato di ognuno di essi.

Concetti chiave

ConfigurationClient

Descrivi qui il tuo cliente principale. Parla di quali operazioni può fare e quando uno sviluppatore vorrebbe usarlo.

Esempi aggiuntivi

Crea una sezione per ogni concetto di servizio di primo livello che desideri spiegare.

Esempi

Primo esempio

Creare diversi esempi di codice per il modo in cui un utente userebbe la libreria per eseguire un'attività comune con il servizio.

Troubleshooting

Logging

L'abilitazione della registrazione può aiutare a individuare informazioni utili sugli errori. Per visualizzare un log di richieste e risposte HTTP, impostare la variabile di ambiente AZURE_LOG_LEVEL su info. In alternativa, la registrazione può essere abilitata in fase di esecuzione chiamando setLogLevel nel @azure/logger:

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

setLogLevel("info");

Per istruzioni più dettagliate su come abilitare i log, è possibile esaminare la documentazione del pacchetto @azure/logger.

Passaggi successivi

Dai un'occhiata alla directory samples per esempi dettagliati che dimostrano come utilizzare le librerie client.

Contributing

Per contribuire a questa libreria, leggere la guida contribuire per altre informazioni su come compilare e testare il codice.

  • Last updated on