Freigeben über

Azure ApiManagement-Clientbibliothek für JavaScript – Version 10.0.0

Dieses Paket enthält ein isomorphes SDK (sowohl in Node.js als auch in Browsern) für den Azure ApiManagement-Client.

ApiManagement-Client

Quellcode | Paket (NPM) | API-Referenzdokumentation | Proben

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Details finden Sie in unserer Supportrichtlinie .

Voraussetzungen

Installieren Sie das @azure/arm-apimanagement-Paket

Installieren Sie die Azure ApiManagement-Clientbibliothek für JavaScript mit npm:

npm install @azure/arm-apimanagement

Erstellen und Authentifizieren eines ApiManagementClient

Um ein Clientobjekt für den Zugriff auf die Azure ApiManagement-API zu erstellen, benötigen Sie die endpoint Azure ApiManagement-Ressource und eine credential. Der Azure ApiManagement-Client kann Azure Active Directory-Anmeldeinformationen verwenden, um sich zu authentifizieren. Sie finden den Endpunkt für Ihre Azure ApiManagement-Ressource im Azure-Portal.

Sie können sich mit Azure Active Directory mithilfe einer Anmeldeinformationen aus der @azure/Identitätsbibliothek oder einem vorhandenen AAD-Token authentifizieren.

Um den unten gezeigten DefaultAzureCredential-Anbieter oder andere anmeldeinformationsanbieter zu verwenden, die mit dem Azure SDK bereitgestellt werden, installieren Sie das @azure/identity Paket:

npm install @azure/identity

Sie müssen auch eine neue AAD-Anwendung registrieren und Zugriff auf Azure ApiManagement gewähren , indem Sie Ihrem Dienstprinzipal die geeignete Rolle zuweisen (Hinweis: Rollen wie "Owner" z. B. erteilen nicht die erforderlichen Berechtigungen).

Weitere Informationen zum Erstellen einer Azure AD-Anwendung finden Sie in diesem Handbuch.

Mithilfe von Node.js- und Node-ähnlichen Umgebungen können Sie die DefaultAzureCredential Klasse verwenden, um den Client zu authentifizieren.

import { ApiManagementClient } from "@azure/arm-apimanagement";
import { DefaultAzureCredential } from "@azure/identity";

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

Verwenden Sie für Browserumgebungen die InteractiveBrowserCredential aus dem @azure/identity Paket, um sich zu authentifizieren.

import { InteractiveBrowserCredential } from "@azure/identity";
import { ApiManagementClient } from "@azure/arm-apimanagement";

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

JavaScript-Bündel

Um diese Clientbibliothek im Browser zu verwenden, müssen Sie zuerst einen Bundler verwenden. Ausführliche Informationen dazu finden Sie in unserer Bündelungsdokumentation.

Wichtige Begriffe

ApiManagementClient

ApiManagementClient ist die primäre Schnittstelle für Entwickler, die die Azure ApiManagement-Clientbibliothek verwenden. Erkunden Sie die Methoden für dieses Clientobjekt, um die verschiedenen Features des Azure ApiManagement-Diensts zu verstehen, auf den Sie zugreifen können.

Problembehandlung

Protokollierung

Das Aktivieren der Protokollierung kann hilfreiche Informationen zu Fehlern aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die AZURE_LOG_LEVEL Umgebungsvariable auf info. Alternativ kann die Protokollierung zur Laufzeit aktiviert werden, indem Sie folgendes setLogLevelaufrufen@azure/logger:

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

setLogLevel("info");

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in den @azure/Logger-Paketdokumenten.

Nächste Schritte

Ausführliche Beispiele zur Verwendung dieser Bibliothek finden Sie im Beispielverzeichnis .

Mitarbeit

Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie bitte den Beitragsleitfaden , um mehr über das Erstellen und Testen des Codes zu erfahren.

  • Last updated on