Compartir a través de

Biblioteca cliente de Azure Atlas para JavaScript: versión 1.0.0

Este paquete contiene un SDK isomórfico (se ejecuta tanto en Node.js como en exploradores) para el cliente de Azure Atlas.

Key links:

Getting started

Entornos admitidos actualmente

See our support policy for more details.

Prerequisites

Instalación del paquete @azure/arm-mongodbatlas

Instale la biblioteca cliente de Azure Atlas para JavaScript con npm:

npm install @azure/arm-mongodbatlas

Creación y autenticación de un AtlasClient

Para crear un objeto de cliente para acceder a la API de Azure Atlas, necesitará el de su endpoint recurso de Azure Atlas y un credentialarchivo . El cliente de Azure Atlas puede usar credenciales de Azure Active Directory para autenticarse. 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

También deberá registrar una nueva aplicación de AAD y conceder acceso a Azure Atlas asignando el rol adecuado a la entidad de servicio (nota: roles como "Owner" no concederán los permisos necesarios).

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

Con Node.js y entornos similares a nodos, puede usar la clase DefaultAzureCredential para autenticar al cliente.

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

En el caso de los entornos del explorador, use el InteractiveBrowserCredential del paquete de @azure/identity para autenticarse.

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

Para usar esta biblioteca cliente en el explorador, primero debe usar un agrupador. For details on how to do this, please refer to our bundling documentation.

Key concepts

AtlasClient

AtlasClient es la interfaz principal para los desarrolladores que usan la biblioteca cliente de Azure Atlas. Explore los métodos de este objeto cliente para comprender las diferentes características del servicio Azure Atlas a las que puede acceder.

Troubleshooting

Logging

Habilitar el registro puede ayudar a descubrir información útil sobre errores. Para ver un registro de solicitudes y respuestas HTTP, establezca la variable de entorno AZURE_LOG_LEVEL en info. Como alternativa, el registro se puede habilitar en tiempo de ejecución llamando a setLogLevel en el @azure/logger:

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

setLogLevel("info");

Para obtener instrucciones más detalladas sobre cómo habilitar los registros, puede consultar los documentos del paquete de @azure/registrador.

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