Azure AlertsManagement biblioteka klienta dla JavaScript - wersja 1.0.0-beta.1

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

Azure Alerts Management Service zapewnia jedną szybę alertów w całym Azure Monitor.

Kluczowe linki:

Rozpoczęcie pracy

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 zasady pomocy technicznej .

Wymagania wstępne

Instalowanie pakietu @azure/arm-alertsmanagement

Zainstaluj bibliotekę klienta Azure AlertsManagement dla JavaScript z npm:

npm install @azure/arm-alertsmanagement

Twórz i uwierzytelnij AlertsManagementClient

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

Możesz uwierzytelnić się w usłudze Azure Active Directory przy użyciu poświadczeń z biblioteki @azure/tożsamości lub istniejącego tokenu usługi AAD.

Aby użyć domyślnego dostawcyAzureCredential pokazanego poniżej lub innych dostawców poświadczeń dostarczonych z zestawem Azure SDK, zainstaluj @azure/identity pakiet:

npm install @azure/identity

Będziesz także musiał zarejestrować nową aplikację AAD i przydzielić dostęp do Azure AlertsManagement przypisując odpowiednią rolę swojemu mocodawcy (uwaga: role takie jak "Owner" nie przyznają wymaganych uprawnień).

Aby uzyskać więcej informacji na temat tworzenia aplikacji usługi Azure AD, zapoznaj się z tym przewodnikiem.

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

import { AlertsManagementClient } from "@azure/arm-alertsmanagement";
import { DefaultAzureCredential } from "@azure/identity";

const client = new AlertsManagementClient(new DefaultAzureCredential());

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { AlertsManagementClient } from "@azure/arm-alertsmanagement";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new AlertsManagementClient(credential);

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

AlertsManagementClient

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

Troubleshooting

Logowanie

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.