Sdílet prostřednictvím


Klientská knihovna Azure Atlas pro JavaScript – verze 1.0.0

Tento balíček obsahuje izomorfní sadu SDK (běží v Node.js i v prohlížečích) pro klienta Azure Atlas.

Key links:

Getting started

Aktuálně podporovaná prostředí

See our support policy for more details.

Prerequisites

Nainstalujte balíček @azure/arm-mongodbatlas.

Nainstalujte klientskou knihovnu Azure Atlas pro JavaScript pomocí npm:

npm install @azure/arm-mongodbatlas

Vytvořte a ověřte AtlasClient

Chcete-li vytvořit objekt klienta pro přístup k rozhraní API Azure Atlas, budete potřebovat endpoint svůj prostředek Azure Atlas a credential. Klient Azure Atlas může k ověření použít přihlašovací údaje 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

Budete také muset zaregistrovat novou aplikaci AAD a udělit přístup k Azure Atlas přiřazením příslušné role k instančnímu objektu (poznámka: role jako např "Owner" . neudělí potřebná oprávnění).

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

Pomocí Node.js a prostředí podobných uzlům můžete k ověření klienta použít třídu 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);

Pro prostředí prohlížeče použijte k ověření InteractiveBrowserCredential z balíčku @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

Pokud chcete tuto klientskou knihovnu použít v prohlížeči, musíte nejprve použít bundler. For details on how to do this, please refer to our bundling documentation.

Key concepts

AtlasClient

AtlasClient je primárním rozhraním pro vývojáře, kteří používají klientskou knihovnu Azure Atlas. Prozkoumejte metody tohoto objektu klienta, abyste porozuměli různým funkcím služby Azure Atlas, ke kterým máte přístup.

Troubleshooting

Logging

Povolení protokolování může pomoct odhalit užitečné informace o chybách. Pokud chcete zobrazit protokol požadavků HTTP a odpovědí, nastavte proměnnou AZURE_LOG_LEVEL prostředí na infohodnotu . Případně můžete protokolování povolit za běhu voláním setLogLevel příkazu @azure/logger:

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

setLogLevel("info");

Podrobnější pokyny k povolení protokolů najdete v dokumentaci k @azure/protokolovacímu balíčku.

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.