Freigeben über


Azure Policy-Clientbibliothek für JavaScript – Version 6.0.0

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

Um den Zugriff auf Ihre Ressourcen zu verwalten und zu steuern, können Sie angepasste Richtlinien definieren und diese in einem Bereich zuweisen.

Quellcode | Package (NPM) | API-Referenzdokumentation | Beispiele

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Voraussetzungen

Installieren des @azure/arm-policy-Pakets

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

npm install @azure/arm-policy

Erstellen und Authentifizieren einer PolicyClient

Um ein Clientobjekt für den Zugriff auf die Azure-Richtlinien-API zu erstellen, benötigen Sie die endpoint Ihrer Azure-Richtlinienressource und eine credential. Der Azure Policy-Client kann Azure Active Directory-Anmeldeinformationen verwenden, um sich zu authentifizieren. Sie finden den Endpunkt für Ihre Azure-Richtlinienressource 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

Außerdem müssen Sie eine neue AAD-Anwendung registrieren und Zugriff auf Azure Policy gewähren, indem Sie Ihrem Dienstprinzipal die geeignete Rolle zuweisen (Hinweis: Rollen wie "Owner" erteilen 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 { PolicyClient } from "@azure/arm-policy";
import { DefaultAzureCredential } from "@azure/identity";

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

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

PolicyClient

PolicyClient ist die primäre Schnittstelle für Entwickler, die die Azure Policy-Clientbibliothek verwenden. Erkunden Sie die Methoden für dieses Clientobjekt, um die verschiedenen Features des Azure-Richtliniendiensts 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 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.

Mitarbeit

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.