Azure CommunicationServiceManagement biblioteca cliente para JavaScript - versão 5.0.0

Este pacote contém um SDK isomorfo (roda tanto em Node.js quanto em navegadores) para Azure cliente CommunicationServiceManagement.

API REST para Serviços de E-mail/Domínios/Listas de Supressão

Links de chave:

Como começar

Ambientes com suporte no momento

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

Pré-requisitos

Instalar o pacote @azure/arm-communication

Instale a biblioteca cliente Azure CommunicationServiceManagement para JavaScript com npm:

npm install @azure/arm-communication

Criar e autenticar um CommunicationServiceManagementClient

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

Você pode autenticar com Azure Active Directory usando uma credencial da biblioteca @azure/identity ou um Token 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 uma nova aplicação AAD e conceder acesso ao Azure CommunicationServiceManagement atribuindo o papel adequado ao seu principal de serviço (nota: funções como "Owner" não concederão as permissões necessárias).

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

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

import { CommunicationServiceManagementClient } from "@azure/arm-communication";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { CommunicationServiceManagementClient } from "@azure/arm-communication";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new CommunicationServiceManagementClient(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 .

Conceitos principais

ClienteCommunicationServiceManagementT

CommunicationServiceManagementClient é a interface principal para desenvolvedores que utilizam a biblioteca cliente Azure CommunicationServiceManagement. Explore os métodos neste objeto cliente para entender os diferentes recursos do serviço Azure CommunicationServiceManagement que você pode acessar.

Troubleshooting

Logging

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 consultar os documentos do pacote @azure/logger.

Próximas Etapas 

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

Contributing

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