Freigeben über


Azure CarbonOptimizationManagement-Clientbibliothek für JavaScript – Version 1.0.0

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

Abfrage-API für Carbon Report Resource Provider.

Key links:

Getting started

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie .

Prerequisites

Installieren Sie das @azure/arm-carbonoptimization-Paket

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

npm install @azure/arm-carbonoptimization

Erstellen und Authentifizieren einer CarbonOptimizationManagementClient

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

Sie können sich bei Azure Active Directory mit 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 CarbonOptimizationManagement gewähren , indem Sie Ihrem Dienstprinzipal die entsprechende Rolle zuweisen (Hinweis: Rollen wie "Owner" gewähren nicht die erforderlichen Berechtigungen).

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

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

import { CarbonOptimizationManagementClient } from "@azure/arm-carbonoptimization";
import { DefaultAzureCredential } from "@azure/identity";

const client = new CarbonOptimizationManagementClient(new DefaultAzureCredential());

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { CarbonOptimizationManagementClient } from "@azure/arm-carbonoptimization";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new CarbonOptimizationManagementClient(credential);

JavaScript Bundle

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

Key concepts

CarbonOptimizationManagementClient

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

Troubleshooting

Logging

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.

Next steps

Bitte werfen Sie einen Blick auf das Beispielverzeichnis für detaillierte Beispiele zur Verwendung dieser Bibliothek.

Contributing

Wenn Sie zu dieser Bibliothek beitragen möchten, lesen Sie bitte den Leitfaden zum Beitragen, um mehr darüber zu erfahren, wie Sie den Code erstellen und testen.