Azure CompanionAPI Client-Bibliothek für JavaScript - Version 1.0.0-beta.1

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

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Voraussetzungen

Installieren Sie das @azure/arm-napsteromniagentapi-Paket

Installiere die Azure CompanionAPI-Clientbibliothek für JavaScript mit npm:

npm install @azure/arm-napsteromniagentapi

Erstellen und Authentifizieren einer CompanionAPIClient

Um ein Client-Objekt zu erstellen, das auf die Azure CompanionAPI-API zugriff, benötigen Sie die endpoint Ressource Ihrer Azure CompanionAPI und eine credential. Der Azure CompanionAPI-Client kann Azure Active Directory-Anmeldedaten zur Authentifizierung verwenden. Den Endpunkt für deine Azure CompanionAPI-Ressource findest du im Azure-Portal.

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

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

npm install @azure/identity

Sie müssen außerdem eine neue AAD-Anwendung registrieren und Zugang zu Azure CompanionAPI gewähren, indem Sie Ihrem Service-Principal die passende Rolle zuweisen (Hinweis: Rollen wie diese "Owner" gewähren nicht die erforderlichen Berechtigungen).

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

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

import { CompanionAPIClient } from "@azure/arm-napsteromniagentapi";
import { DefaultAzureCredential } from "@azure/identity";

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

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new CompanionAPIClient(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 Konzepte

CompanionAPIClient

CompanionAPIClientist die primäre Schnittstelle für Entwickler, die die Client-Bibliothek von Azure CompanionAPI verwenden. Erkunden Sie die Methoden auf diesem Client-Objekt, um die verschiedenen Funktionen des Azure CompanionAPI-Dienstes zu verstehen, auf die 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 infofest. Alternativ kann die Protokollierung zur Laufzeit durch Aufrufen von setLogLevel im @azure/loggeraktiviert werden:

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 in den Beispielen Verzeichnis.

Contributing

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

  • Last updated on