Поделиться через

Клиентская библиотека Azure Atlas для JavaScript — версия 1.0.0

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

Key links:

Getting started

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

See our support policy for more details.

Prerequisites

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

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

npm install @azure/arm-mongodbatlas

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

Чтобы создать клиентский объект для доступа к API Azure Atlas, вам потребуется endpoint ресурс Azure Atlas и credential. Клиент Azure Atlas может использовать учетные данные Azure Active Directory для проверки подлинности. You can find the endpoint for your Azure Atlas resource in the Azure Portal.

You can authenticate with Azure Active Directory using a credential from the @azure/identity library or an existing AAD Token.

To use the DefaultAzureCredential provider shown below, or other credential providers provided with the Azure SDK, please install the @azure/identity package:

npm install @azure/identity

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

For more information about how to create an Azure AD Application check out this guide.

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

import { AtlasClient } from "@azure/arm-mongodbatlas";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { AtlasClient } from "@azure/arm-mongodbatlas";

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

JavaScript Bundle

Чтобы использовать эту клиентную библиотеку в браузере, сначала необходимо использовать пакет. For details on how to do this, please refer to our bundling documentation.

Key concepts

AtlasClient

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

Troubleshooting

Logging

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

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

setLogLevel("info");

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

Next steps

Please take a look at the samples directory for detailed examples on how to use this library.

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.