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

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

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

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

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

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

Prerequisites

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

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

npm install @azure/arm-aigateway

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

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

Вы можете аутентифицироваться с помощью Microsoft Entra ID, используя учетные данные из библиотеки @azure/identity или имея существующий токен Microsoft Entra.

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

npm install @azure/identity

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

Для получения дополнительной информации о том, как создать приложение Microsoft Entra, ознакомьтесь с этим руководством.

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

import { ApiManagementClient } from "@azure/arm-aigateway";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { ApiManagementClient } from "@azure/arm-aigateway";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new ApiManagementClient(credential, subscriptionId);

Пакет JavaScript

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

Ключевые понятия

ApiManagementClient

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

Troubleshooting

Logging

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

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

setLogLevel("info");

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

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

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

Contributing

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