Udostępnij za pomocą


Biblioteka klienta usługi Azure Atlas dla języka JavaScript — wersja 1.0.0

Ten pakiet zawiera izomorficzny zestaw SDK (działa zarówno w Node.js, jak i w przeglądarkach) dla klienta usługi Azure Atlas.

Key links:

Getting started

Obecnie obsługiwane środowiska

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

See our support policy for more details.

Prerequisites

Instalowanie pakietu @azure/arm-mongodbatlas

Zainstaluj bibliotekę klienta usługi Azure Atlas dla języka JavaScript za pomocą npmpolecenia :

npm install @azure/arm-mongodbatlas

Twórz i uwierzytelnij AtlasClient

Aby utworzyć obiekt klienta w celu uzyskania dostępu do interfejsu API usługi Azure Atlas, potrzebny endpoint jest zasób usługi Azure Atlas i plik credential. Klient usługi Azure Atlas może używać poświadczeń usługi Azure Active Directory do uwierzytelniania. 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

Należy również zarejestrować nową aplikację usługi AAD i udzielić dostępu do usługi Azure Atlas , przypisując odpowiednią rolę do jednostki usługi (uwaga: role, takie jak "Owner" nie udzielą niezbędnych uprawnień).

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

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

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

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

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

Aby użyć tej biblioteki klienta w przeglądarce, najpierw należy użyć pakietu. For details on how to do this, please refer to our bundling documentation.

Key concepts

AtlasClient

AtlasClient jest podstawowym interfejsem dla deweloperów korzystających z biblioteki klienta usługi Azure Atlas. Zapoznaj się z metodami tego obiektu klienta, aby zrozumieć różne funkcje usługi Azure Atlas, do której można uzyskać dostęp.

Troubleshooting

Logging

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

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

setLogLevel("info");

Aby uzyskać bardziej szczegółowe instrukcje dotyczące włączania dzienników, zapoznaj się z dokumentami dotyczącymi pakietów @azure/rejestratora.

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.