Compartilhar via


Azure CosmosDBManagement client library for JavaScript – versão 16.4.0

Esse pacote contém um SDK isomórfico (executado em Node.js e em navegadores) para o cliente do Azure CosmosDBManagement.

API REST do Provedor de Recursos do Serviço de Banco de Dados do Azure Cosmos DB

NPM (pacote de | de código-fonte) | documentação de referência da API | Exemplos

Introdução

Ambientes com suporte no momento

Consulte nossa política de suporte para obter mais detalhes.

Pré-requisitos

Instalar o pacote @azure/arm-cosmosdb

Instale a biblioteca de clientes do Azure CosmosDBManagement para JavaScript com npm:

npm install @azure/arm-cosmosdb

Criar e autenticar um CosmosDBManagementClient

Para criar um objeto cliente para acessar a API do Azure CosmosDBManagement, você precisará do endpoint do recurso do Azure CosmosDBManagement e de um credential. O cliente do Azure CosmosDBManagement pode usar as credenciais do Azure Active Directory para autenticar. Você pode encontrar o ponto de extremidade para o recurso do Azure CosmosDBManagement no portal do Azure.

Você pode autenticar com o Azure Active Directory usando uma credencial da biblioteca de de @azure/identidade ou um token do AAD existente.

Para usar o provedor DefaultAzureCredential mostrado abaixo ou outros provedores de credenciais fornecidos com o SDK do Azure, instale o pacote @azure/identity:

npm install @azure/identity

Você também precisará registrar um novo aplicativo do AAD e conceder acesso ao Azure CosmosDBManagement atribuindo a função adequada à entidade de serviço (observação: funções como "Owner" não concederão as permissões necessárias).

Para obter mais informações sobre como criar um aplicativo do Azure AD, confira este guia.

Usando ambientes semelhantes a Node.js e nó, você pode usar a classe DefaultAzureCredential para autenticar o cliente.

import { CosmosDBManagementClient } from "@azure/arm-cosmosdb";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new CosmosDBManagementClient(new DefaultAzureCredential(), subscriptionId);

Para ambientes de navegador, use o InteractiveBrowserCredential do pacote @azure/identity para autenticar.

import { InteractiveBrowserCredential } from "@azure/identity";
import { CosmosDBManagementClient } from "@azure/arm-cosmosdb";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const client = new CosmosDBManagementClient(credential, subscriptionId);

Pacote JavaScript

Para usar essa biblioteca de clientes no navegador, primeiro você precisa usar um empacotador. Para obter detalhes sobre como fazer isso, consulte nossa documentação de agrupamento .

Principais conceitos

CosmosDBManagementClient

CosmosDBManagementClient é a interface principal para desenvolvedores que usam a biblioteca de clientes do Azure CosmosDBManagement. Explore os métodos neste objeto cliente para entender os diferentes recursos do serviço Azure CosmosDBManagement que você pode acessar.

Solucionando problemas

Log

Habilitar o registro em log pode ajudar a descobrir informações úteis sobre falhas. Para ver um log de solicitações e respostas HTTP, defina a variável de ambiente AZURE_LOG_LEVEL como info. Como alternativa, o registro em log pode ser habilitado em runtime chamando setLogLevel no @azure/logger:

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

setLogLevel("info");

Para obter instruções mais detalhadas sobre como habilitar logs, você pode examinar os documentos do pacote @azure/agente.

Próximas etapas

Examine os exemplos de diretório para obter exemplos detalhados sobre como usar essa biblioteca.

Contribuindo

Se você quiser contribuir com essa biblioteca, leia o guia de contribuição para saber mais sobre como criar e testar o código.

  • do SDK do Microsoft Azure para JavaScript