Delen via

Azure Atlas-clientbibliotheek voor JavaScript - versie 1.0.0

Dit pakket bevat een isomorfe SDK (die zowel in Node.js als in browsers wordt uitgevoerd) voor de Azure Atlas-client.

Key links:

Getting started

Momenteel ondersteunde omgevingen

See our support policy for more details.

Prerequisites

Het @azure/arm-mongodbatlas-pakket installeren

Installeer de Azure Atlas-clientbibliotheek voor JavaScript met npm:

npm install @azure/arm-mongodbatlas

Een AtlasClient maken en verifiëren

Als u een clientobject wilt maken voor toegang tot de Azure Atlas-API, hebt u de endpoint van uw Azure Atlas-resource en een credential. De Azure Atlas-client kan Azure Active Directory-referenties gebruiken om te verifiëren. 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

U moet ook een nieuwe AAD-toepassing registreren en toegang verlenen tot Azure Atlas door de juiste rol toe te wijzen aan uw service-principal (opmerking: rollen zoals "Owner" verlenen niet de benodigde machtigingen).

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

Met Node.js- en Node-achtige omgevingen kunt u de DefaultAzureCredential-klasse gebruiken om de client te verifiëren.

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

Gebruik voor browseromgevingen de InteractiveBrowserCredential uit het @azure/identity-pakket om te verifiëren.

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

Als u deze clientbibliotheek in de browser wilt gebruiken, moet u eerst een bundelaar gebruiken. For details on how to do this, please refer to our bundling documentation.

Key concepts

AtlasClient

AtlasClient is de primaire interface voor ontwikkelaars die gebruikmaken van de Azure Atlas-clientbibliotheek. Verken de methoden op dit clientobject om inzicht te krijgen in de verschillende functies van de Azure Atlas-service waartoe u toegang hebt.

Troubleshooting

Logging

Het inschakelen van logboekregistratie kan helpen nuttige informatie over fouten te ontdekken. Als u een logboek met HTTP-aanvragen en -antwoorden wilt zien, stelt u de AZURE_LOG_LEVEL omgevingsvariabele in op info. U kunt logboekregistratie ook tijdens runtime inschakelen door het setLogLevelvolgende aan te roepen@azure/logger:

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

setLogLevel("info");

Voor meer gedetailleerde instructies over het inschakelen van logboeken, kunt u de @azure/logger pakketdocumenten bekijken.

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.