Azure Deployments Client Library 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-Bereitstellungsclient.

Stellt Operationen für die Arbeit mit Einsätzen bereit.

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Voraussetzungen

Installieren Sie das @azure/arm-resourcesdeployments-Paket

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

npm install @azure/arm-resourcesdeployments

Erstellen und Authentifizieren einer DeploymentsClient

Um ein Clientobjekt für den Zugriff auf die Azure-Bereitstellungs-API zu erstellen, benötigen Sie die endpoint Ihrer Azure-Bereitstellungsressource und eine credential. Der Azure-Bereitstellungsclient kann Azure Active Directory-Anmeldeinformationen für die Authentifizierung verwenden. Den Endpunkt für deine Azure Deployments-Ressource findest du in der Azure-Portal.

Sie können sich mit Azure Active Directory authentifizieren, indem Sie eine Berechtigung aus der Bibliothek @azure/identity oder einem bestehenden AAD Token authentifizieren.

Um den unten gezeigten Anbieter DefaultAzureCredential oder andere mit dem Azure SDK bereitgestellte Zugangsdatenanbieter zu verwenden, installieren Sie bitte das @azure/identity-Paket:

npm install @azure/identity

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

Für weitere Informationen darüber, wie man eine Azure AD-Anwendung erstellt, siehe diesen Leitfaden.

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

import { DeploymentsClient } from "@azure/arm-resourcesdeployments";
import { DefaultAzureCredential } from "@azure/identity";

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

Für Browserumgebungen verwenden Sie zur Authentifizierung das InteractiveBrowserCredential aus dem @azure/identity-Paket.

import { InteractiveBrowserCredential } from "@azure/identity";
import { DeploymentsClient } from "@azure/arm-resourcesdeployments";

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

Zentrale Konzepte

DeploymentsClient

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

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.