Azure ContainerAppsAPI Client-Bibliothek für JavaScript - Version 4.0.0

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

Funktionen sind eine Erweiterungsressource für Überarbeitungen, und die aufgeführte API wird verwendet, um den Aufruf von Web RP an den Hostprozess der Funktions-App zu proxyn, diese API wird nicht für Benutzer verfügbar gemacht, und nur Web RP darf die Erweiterungsressource der Funktionen aufrufen.

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Details finden Sie in unserer Supportrichtlinie .

Voraussetzungen

Installieren Sie das @azure/arm-appcontainers-Paket

Installiere die Azure ContainerAppsAPI-Client-Bibliothek für JavaScript mit npm:

npm install @azure/arm-appcontainers

Erstellen und Authentifizieren eines ContainerAppsAPIClient

Um ein Client-Objekt zu erstellen, das auf die Azure ContainerAppsAPI-API zugreift, benötigen Sie die endpoint Ihrer Azure ContainerAppsAPI-Ressource und ein credential. Der Azure ContainerAppsAPI-Client kann Azure Active Directory-Anmeldedaten zur Authentifizierung verwenden. Den Endpunkt für deine Azure ContainerAppsAPI-Ressource findest du in der 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 außerdem eine neue AAD-Anwendung registrieren und Zugriff auf Azure ContainerAppsAPI indem Sie die geeignete Rolle Ihrem Service Principal zuweisen (Hinweis: Rollen wie gewähren 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 { ContainerAppsAPIClient } from "@azure/arm-appcontainers";
import { DefaultAzureCredential } from "@azure/identity";

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

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

ContainerAppsAPIClient

ContainerAppsAPIClient ist die primäre Schnittstelle für Entwickler, die die Azure ContainerAppsAPI-Client-Bibliothek verwenden. Erkunden Sie die Methoden auf diesem Client-Objekt, um die verschiedenen Funktionen des Azure ContainerAppsAPI-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 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.