Клиентская библиотека Azure AlertsManagement для JavaScript — версия 1.0.0-beta.1

Этот пакет содержит изоморфный SDK (работает как в Node.js, так и в браузерах) для клиента Azure AlertsManagement.

Azure Alerts Management Service предоставляет единую панель оповещений по всему Azure Monitor.

Ключевые ссылки:

Начало работы

Поддерживаемые в настоящее время среды

Чтобы получить дополнительные сведения, ознакомьтесь с нашей политикой поддержки.

Необходимые условия

Установите пакет @azure/arm-alertsmanagement.

Установите клиентскую библиотеку Azure AlertsManagement для JavaScript с помощью npm:

npm install @azure/arm-alertsmanagement

Создание и проверка подлинности AlertsManagementClient

Чтобы создать клиентский объект для доступа к API Azure AlertsManagement, вам понадобится endpoint вашего ресурса Azure AlertsManagement и credential. Клиент Azure AlertsManagement может использовать Azure Active Directory credentials для аутентификации. Вы можете найти конечную точку для вашего ресурса Azure AlertsManagement в портал Azure.

Вы можете пройти проверку подлинности с помощью Azure Active Directory с помощью учетных данных из библиотеки @azure/удостоверений или существующего токена AAD.

Чтобы использовать провайдера DefaultAzureCredential, показанного ниже, или других поставщиков учетных данных, предоставленных с SDK Azure, пожалуйста, установите пакет @azure/identity:

npm install @azure/identity

Вам также нужно будет зарегистрировать приложение AAD и предоставить доступ к Azure AlertsManagement назначив соответствующую роль вашему руководителю службы (примечание: такие роли, как "Owner", не предоставляют необходимые права).

Дополнительные сведения о создании приложения Azure AD см. в этом руководстве.

Используя среды Node.js и node-like, можно использовать класс DefaultAzureCredential для проверки подлинности клиента.

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

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

Для браузерных сред используйте InteractiveBrowserCredential из пакета @azure/identity для аутентификации.

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

Пакет JavaScript

Чтобы использовать эту клиентную библиотеку в браузере, сначала необходимо использовать пакет. Подробнее о том, как to do это, пожалуйста, обратитесь к нашей документации по bundling.

Основные понятия

AlertsManagementClient

AlertsManagementClient является основным интерфейсом для разработчиков, использующих клиентскую библиотеку Azure AlertsManagement. Изучите методы на этом клиентском объекте, чтобы понять различные функции сервиса Azure AlertsManagement, к которым вы можете получить доступ.

Troubleshooting

Логирование

Включение ведения журнала может помочь выявить полезные сведения о сбоях. Чтобы просмотреть журнал HTTP-запросов и ответов, задайте для переменной среды AZURE_LOG_LEVEL значение info. В альтернативном порядке, логирование можно включить во время выполнения, вызвав setLogLevel в @azure/logger:

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

setLogLevel("info");

Дополнительные инструкции по включению журналов см. в документации по пакету @azure/loger.

Дальнейшие действия

Ознакомьтесь с примерами каталога, чтобы получить подробные примеры использования этой библиотеки.

Contributing

Если вы хотите внести вклад в эту библиотеку, пожалуйста, ознакомьтесь с руководством contributing guide чтобы узнать больше о том, как создавать и тестировать код.

  • Last updated on