Azure MicrosoftSerialConsole Client Library for JavaScript - Version 3.0.0

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

Die Azure Serial Console ermöglicht es Ihnen, auf die serielle Konsole einer virtuellen Maschine oder einer VM-Skalierungsset-Instanz zuzugreifen

Wichtige Links:

Erste Schritte

Derzeit unterstützte Umgebungen

Weitere Informationen finden Sie in unserer Supportrichtlinie.

Voraussetzungen

Installieren Sie das @azure/arm-serialconsole-Paket

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

npm install @azure/arm-serialconsole

Erstellen und Authentifizieren einer MicrosoftSerialConsoleClient

Um ein Client-Objekt zu erstellen, das auf die Azure MicrosoftSerialConsole-API zugreift, benötigen Sie das endpoint Ihrer Azure MicrosoftSerialConsole-Ressource und ein credential. Der Azure MicrosoftSerialConsole-Client kann Azure Active Directory-Anmeldedaten zur Authentifizierung verwenden. Den Endpunkt für deine Azure MicrosoftSerialConsole-Ressource findest du unter 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 außerdem eine neue AAD-Anwendung registrieren und Zugriff auf Azure MicrosoftSerialConsole gewähren, indem Sie die passende Rolle Ihrem Service Principal 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 { MicrosoftSerialConsoleClient } from "@azure/arm-serialconsole";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { MicrosoftSerialConsoleClient } from "@azure/arm-serialconsole";

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

MicrosoftSerialConsoleClient

MicrosoftSerialConsoleClient ist die primäre Schnittstelle für Entwickler, die die Azure MicrosoftSerialConsole-Client-Bibliothek verwenden. Erkunden Sie die Methoden auf diesem Client-Objekt, um die verschiedenen Funktionen des Azure MicrosoftSerialConsole-Dienstes zu verstehen, auf die 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.

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.