Azure TemplateSpecs bibliothèque client pour JavaScript - version 2.2.0

Ce paquet contient un SDK isomorphe (exécuté à la fois dans Node.js et dans les navigateurs) pour Azure client TemplateSpecs.

TemplateSpecs Client

Documentation de référence sur le code source PackageAPISamples

Premiers pas

Environnements actuellement pris en charge

Consultez notre politique d’assistance pour plus de détails.

Prerequisites

Installer le package @azure/arm-templatespecs

Installez la bibliothèque client Azure TemplateSpecs pour JavaScript avec npm:

npm install @azure/arm-templatespecs

Créer et authentifier un TemplateSpecsClient

Pour créer un objet client afin d’accéder à l’API Azure TemplateSpecs, vous aurez besoin de la endpoint ressource Azure TemplateSpecs et d’un credentialfichier . Le client Azure TemplateSpecs peut utiliser les identifiants Azure Active Directory pour s’authentifier. Vous pouvez trouver le point de terminaison pour votre ressource Azure TemplateSpecs dans le Portail Azure.

Vous pouvez vous authentifier auprès d’Azure Active Directory à l’aide d’informations d’identification à partir de la bibliothèque de @azure/identité ou un jeton AAD existant.

Pour utiliser le fournisseur DefaultAzureCredential indiqué ci-dessous ou d’autres fournisseurs d’informations d’identification fournis avec le Kit de développement logiciel (SDK) Azure, installez le package :

npm install @azure/identity

Vous devrez également enregistrer une nouvelle application AAD et accorder l’accès à Azure TemplateSpecs en attribuant le rôle approprié à votre principal de service (note : les rôles tels "Owner" que ne délivreront pas les autorisations nécessaires).

Pour plus d’informations sur la création d’une application Azure AD, consultez ce guide.

À l’aide de Node.js et d’environnements de type Nœud, vous pouvez utiliser la classe DefaultAzureCredential pour authentifier le client.

import { TemplateSpecsClient } from "@azure/arm-templatespecs";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new TemplateSpecsClient(new DefaultAzureCredential(), subscriptionId);

Pour les environnements de navigateur, utilisez le InteractiveBrowserCredential à partir du package @azure/identity pour l’authentification.

import { InteractiveBrowserCredential } from "@azure/identity";
import { TemplateSpecsClient } from "@azure/arm-templatespecs";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new TemplateSpecsClient(credential, subscriptionId);

Offre groupée JavaScript

Pour utiliser cette bibliothèque cliente dans le navigateur, vous devez d’abord utiliser un bundler. Pour plus de détails sur la procédure à suivre, veuillez consulter notre documentation sur les offres groupées.

Concepts clés

TemplateSpecsClient

TemplateSpecsClientest l’interface principale pour les développeurs utilisant la bibliothèque client Azure TemplateSpecs. Explorez les méthodes sur cet objet client pour comprendre les différentes fonctionnalités du service Azure TemplateSpecs auxquelles vous pouvez accéder.

Troubleshooting

Logging

L’activation de la journalisation peut vous aider à découvrir des informations utiles sur les échecs. Pour afficher 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 la @azure/logger:

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

setLogLevel("info");

Pour obtenir des instructions plus détaillées sur l’activation des journaux, vous pouvez consulter la documentationdu package @azure/enregistreur d’événements.

Étapes suivantes

Consultez les exemples répertoire pour obtenir des exemples détaillés sur l’utilisation de cette bibliothèque.

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.

  • Dernière mise à jour :