Azure ApiManagement client library for JavaScript - version 1.0.0-beta.1

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

Liens clés :

Premiers pas

Environnements actuellement pris en charge

Pour plus d’informations, consultez notre de stratégie de support .

Prerequisites

Installer le package @azure/arm-aigateway

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

npm install @azure/arm-aigateway

Créer et authentifier un ApiManagementClient

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

Vous pouvez vous authentifier avec Microsoft Entra ID en utilisant un identifiant de la bibliothèque @azure/identity ou un jeton Microsoft Entra 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 Microsoft Entra et accorder l’accès à Azure ApiManagement en attribuant le rôle approprié à votre responsable de service (note : des rôles tels "Owner" que n’accorderont pas les autorisations nécessaires).

Pour plus d’informations sur la création d’une application Microsoft Entra, 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 { ApiManagementClient } from "@azure/arm-aigateway";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new ApiManagementClient(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 { ApiManagementClient } from "@azure/arm-aigateway";

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

Offre groupée JavaScript

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

Concepts clés

ApiManagementClient

ApiManagementClientest l’interface principale pour les développeurs utilisant la bibliothèque client Azure ApiManagement. Explorez les méthodes sur cet objet client pour comprendre les différentes fonctionnalités du service Azure ApiManagement 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.

Contributing

Si vous souhaitez contribuer à cette bibliothèque, veuillez lire le guide contribution pour en savoir plus sur la construction et le test du code.