Azure GuestConfiguration Client-Bibliothek für JavaScript - Version 1.0.0-beta.3

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

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Voraussetzungen

Installieren Sie das @azure/arm-guestconfiguration-Paket

Installieren Sie die Azure GuestConfiguration-Client-Bibliothek für JavaScript mit npm:

npm install @azure/arm-guestconfiguration

Erstellen und Authentifizieren einer GuestConfigurationClient

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

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

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

GuestConfigurationClient

GuestConfigurationClient ist die primäre Schnittstelle für Entwickler, die die Azure GuestConfiguration-Client-Bibliothek verwenden. Erkunden Sie die Methoden dieses Client-Objekts, um die verschiedenen Funktionen des Azure GuestConfiguration-Dienstes zu verstehen, auf den Sie zugreifen können.

Troubleshooting

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.

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.