Freigeben über

AzureTerraformResourceProvider-Clientbibliothek für JavaScript

  • Artikel

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

Die Azure Terraform-Verwaltungs-API stellt einen RESTful-Satz von Webdiensten bereit, die zum Verwalten Ihrer Azure Terraform-Ressourcen verwendet werden.

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Voraussetzungen

Installieren des @azure/arm-terraform-Pakets

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

npm install @azure/arm-terraform

Erstellen und Authentifizieren einer AzureTerraformClient

Um ein Clientobjekt für den Zugriff auf die AzureTerraformResourceProvider-API zu erstellen, benötigen Sie die endpoint Ihrer AzureTerraformResourceProvider-Ressource und eine credential. Der AzureTerraformResourceProvider-Client kann Azure Active Directory-Anmeldeinformationen zur Authentifizierung verwenden. Sie finden den Endpunkt für Ihre AzureTerraformResourceProvider-Ressource 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 auch eine neue AAD-Anwendung registrieren und Zugriff auf AzureTerraformResourceProvider gewähren, indem Sie Ihrem Dienstprinzipal die geeignete Rolle zuweisen (Hinweis: Rollen wie "Owner" erteilen nicht die erforderlichen Berechtigungen). Legen Sie die Werte der Client-ID, der Mandanten-ID und des geheimen Clientschlüssels der AAD-Anwendung als Umgebungsvariablen fest: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

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

const { AzureTerraformClient } = require("@azure/arm-terraform");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

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

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new AzureTerraformClient(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.

Schlüsselkonzepte

AzureTerraformClient

AzureTerraformClient ist die primäre Schnittstelle für Entwickler, die die AzureTerraformResourceProvider-Clientbibliothek verwenden. Erkunden Sie die Methoden für dieses Clientobjekt, um die verschiedenen Features des AzureTerraformResourceProvider-Diensts zu verstehen, auf den Sie zugreifen können.

Fehlerbehebung

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:

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in den @azure/Logger-Paketdokumenten.

Beitragend

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.