Azure MicrosoftSerialConsole biblioteka klienta dla JavaScript - wersja 3.0.0

Ten pakiet zawiera izomorficzne SDK (działające zarówno w Node.js, jak i w przeglądarkach) dla klienta Azure MicrosoftSerialConsole.

Azure Serial Console pozwala uzyskać dostęp do konsoli szeregowej maszyny wirtualnej lub instancji VM scale set

Kluczowe linki:

Wprowadzenie

Obecnie obsługiwane środowiska

  • Wersje LTS systemu Node.js
  • Najnowsze wersje przeglądarek Safari, Chrome, Edge i Firefox.

Aby uzyskać więcej informacji, zobacz nasze zasad pomocy technicznej.

Wymagania wstępne

Instalowanie pakietu @azure/arm-serialconsole

Zainstaluj bibliotekę klienta MicrosoftSerialConsole Azure dla JavaScript z npm:

npm install @azure/arm-serialconsole

Twórz i uwierzytelnij MicrosoftSerialConsoleClient

Aby utworzyć obiekt klienta do dostępu do API Azure MicrosoftSerialConsole, będziesz potrzebować endpoint swojego Azure zasobu MicrosoftSerialConsole oraz credential. Klient Azure MicrosoftSerialConsole może używać poświadczeń Azure Active Directory do uwierzytelniania. Punkt końcowy dla swojego Azure zasobu MicrosoftSerialConsole znajdziesz w Azure Portal.

Możesz uwierzytelnić się Azure Active Directory używając poświadczenia z biblioteki @azure/identity lub istniejącego tokena AAD.

Aby korzystać z dostawcy DefaultAzureCredential pokazanego poniżej lub innych dostawców poświadczonych w Azure SDK, prosimy o zainstalowanie pakietu @azure/identity:

npm install @azure/identity

Będziesz także musiał zarejestrować nową aplikację AAD i przyznać dostęp do Azure MicrosoftSerialConsole przypisując odpowiednią rolę swojemu podmiotowi usługi (uwaga: role takie jak "Owner" nie przyznają niezbędnych uprawnień).

Aby dowiedzieć się więcej o tym, jak stworzyć aplikację Azure AD, sprawdź ten przewodnik.

Korzystając ze środowisk Node.js i środowisk podobnych do węzłów, możesz użyć klasy DefaultAzureCredential do uwierzytelniania klienta.

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);

W przypadku środowisk przeglądarki użyj InteractiveBrowserCredential z pakietu @azure/identity do uwierzytelniania.

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);

Pakiet JavaScript

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć pakietu. Aby uzyskać szczegółowe informacje o tym, jak to zrobić, zapoznaj się z naszą dokumentacją dotyczącą tworzenia pakietów .

Kluczowe pojęcia

MicrosoftSerialConsoleClient

MicrosoftSerialConsoleClient to główny interfejs dla programistów korzystających z biblioteki klienta MicrosoftSerialConsole Azure. Poznaj metody tego obiektu klienta, aby zrozumieć różne funkcje usługi Azure MicrosoftSerialConsole, do której masz dostęp.

Troubleshooting

Logging

Włączenie rejestrowania może pomóc odkryć przydatne informacje o błędach. Aby wyświetlić dziennik żądań i odpowiedzi HTTP, ustaw zmienną środowiskową AZURE_LOG_LEVEL na info. Alternatywnie rejestrowanie można włączyć w czasie wykonywania, wywołując setLogLevel w @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentacją pakietu @azure/logger.

Następne kroki

Zapoznaj się z przykładami katalogu, aby zapoznać się ze szczegółowymi przykładami dotyczącymi korzystania z tej biblioteki.

Contributing

Jeśli chcesz współtworzyć tę bibliotekę, przeczytaj przewodnik dotyczący współtworzenia , aby dowiedzieć się więcej na temat tworzenia i testowania kodu.