Freigeben über

Azure Atlas-Clientbibliothek für JavaScript – Version 1.0.0

Dieses Paket enthält ein isomorphes SDK (wird sowohl in Node.js als auch in Browsern ausgeführt) für den Azure Atlas-Client.

Key links:

Getting started

Derzeit unterstützte Umgebungen

See our support policy for more details.

Prerequisites

Installieren Sie das @azure/arm-mongodbatlas-Paket

Installieren Sie die Azure Atlas-Clientbibliothek für JavaScript mit npm:

npm install @azure/arm-mongodbatlas

Erstellen und Authentifizieren einer AtlasClient

Um ein Clientobjekt für den Zugriff auf die Azure Atlas-API zu erstellen, benötigen Sie die endpoint Ihrer Azure Atlas-Ressource und eine credential. Der Azure Atlas-Client kann Azure Active Directory-Anmeldeinformationen zur Authentifizierung verwenden. 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

Sie müssen auch eine neue AAD-Anwendung registrieren und Zugriff auf Azure Atlas gewähren , indem Sie Ihrem Dienstprinzipal die entsprechende Rolle zuweisen (Hinweis: Rollen wie "Owner" gewähren nicht die erforderlichen Berechtigungen).

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

Mithilfe von Node.js- und Node-ähnlichen Umgebungen können Sie die DefaultAzureCredential Klasse verwenden, um den Client zu authentifizieren.

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

Verwenden Sie für Browserumgebungen die InteractiveBrowserCredential aus dem @azure/identity Paket, um sich zu authentifizieren.

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

Um diese Clientbibliothek im Browser zu verwenden, müssen Sie zuerst einen Bundler verwenden. For details on how to do this, please refer to our bundling documentation.

Key concepts

AtlasClient

AtlasClient ist die primäre Schnittstelle für Entwickler, die die Azure Atlas-Clientbibliothek verwenden. Erkunden Sie die Methoden für dieses Clientobjekt, um die verschiedenen Features des Azure Atlas-Diensts zu verstehen, auf die Sie zugreifen können.

Troubleshooting

Logging

Das Aktivieren der Protokollierung kann hilfreiche Informationen zu Fehlern aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die AZURE_LOG_LEVEL Umgebungsvariable auf infofest. Alternativ kann die Protokollierung zur Laufzeit durch Aufrufen von setLogLevel im @azure/loggeraktiviert werden:

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

setLogLevel("info");

Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in den @azure/Logger-Paketdokumenten.

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.

  • Last updated on