Partager via

Bibliothèque cliente de modèle Azure pour JavaScript - version 1.0.0-beta.1

Ce projet est utilisé comme package de modèle pour le Kit de développement logiciel (SDK) Azure pour JavaScript. Il est destiné à aider les développeurs du Kit de développement logiciel (SDK) Azure à démarrer de nouveaux packages et fournit un exemple d’organisation du code et de la documentation d’une bibliothèque cliente pour un service Azure.

Prise en main

Environnements actuellement pris en charge

Pour plus d’informations, consultez notre politique de support .

Prérequis

Généralement, vous placez une commande d’interpréteur de commandes pour approvisionner les services Azure nécessaires ici.

Installez le package @azure/template

Installez la bibliothèque cliente de modèle pour JavaScript avec npm:

npm install @azure/template

Prise en charge des navigateurs

Ensemble JavaScript

Pour utiliser cette bibliothèque cliente dans le navigateur, vous devez d’abord utiliser un bundler. Pour plus d’informations sur la façon de procéder, reportez-vous à notre documentation sur le regroupement.

CORS

Vous devez configurer des règles CORS (Cross-Origin Resource Sharing) pour votre compte de stockage si vous devez développer pour les navigateurs. Accédez à Portail Azure et Explorateur Stockage Azure, recherchez votre compte de stockage, créez des règles CORS pour les services blob/file/file/table.

Par exemple, vous pouvez créer les paramètres CORS suivants pour le débogage. Toutefois, personnalisez soigneusement les paramètres en fonction de vos besoins dans un environnement de production.

  • Origines autorisées : *
  • Verbes autorisés : DELETE,GET,HEAD,MERGE,POST,OPTIONS,PUT
  • En-têtes autorisés : *
  • En-têtes exposés : *
  • Âge maximal (secondes) : 86400

Autres exemples

Les exemples de niveau supérieur incluent généralement des éléments tels que la création et l’authentification du client main. Si votre service prend en charge plusieurs moyens d’authentification (par exemple, basé sur des clés et Azure Active Directory), vous pouvez donner un exemple distinct de chacun d’eux.

Concepts clés

ConfigurationClient

Décrivez votre client principal ici. Parlez des opérations qu’il peut effectuer et du moment où un développeur souhaite l’utiliser.

Autres exemples

Créez une section pour chaque concept de service de niveau supérieur que vous souhaitez expliquer.

Exemples

Premier exemple

Créez plusieurs exemples de code pour savoir comment quelqu’un utiliserait votre bibliothèque pour accomplir une tâche commune avec le service.

Résolution des problèmes

Journalisation

L’activation de la journalisation peut vous aider à mieux comprendre les échecs. Pour avoir un journal des requêtes et réponses HTTP, définissez la variable d’environnement AZURE_LOG_LEVEL sur info. Vous pouvez également activer la journalisation au moment de l’exécution en appelant setLogLevel dans @azure/logger :

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

setLogLevel("info");

Pour obtenir des instructions plus détaillées sur l’activation des journaux, consultez les documents relatifs au package @azure/logger.

Étapes suivantes

Consultez le répertoire d’exemples pour obtenir des exemples détaillés qui montrent comment utiliser les bibliothèques clientes.

Contribution

Si vous souhaitez contribuer à cette bibliothèque, lisez le guide de contribution pour en savoir plus sur la génération et le test du code.

Impressions

  • Last updated on