Biblioteca de cliente do Azure WebPubSubManagement para JavaScript - versão 1.0.0
Este pacote contém um SDK isomórfico (executado tanto em Node.js como em browsers) para o cliente Azure WebPubSubManagement.
API REST para o Serviço WebPubSub do Azure
Código fonte | Pacote (NPM) | Documentação | de referência da APIExemplos
Introdução
Ambientes atualmente suportados
- Versões LTS do Node.js
- Versões mais recentes do Safari, Chrome, Edge e Firefox.
Pré-requisitos
- Uma subscrição do Azure.
Instalar o pacote @azure/arm-webpubsub
Instale a biblioteca de cliente Azure WebPubSubManagement para JavaScript com npm
:
npm install @azure/arm-webpubsub
Criar e autenticar um WebPubSubManagementClient
Para criar um objeto de cliente para aceder à API Azure WebPubSubManagement, precisará do endpoint
recurso do Azure WebPubSubManagement e de um credential
. O cliente Azure WebPubSubManagement pode utilizar credenciais do Azure Active Directory para autenticar.
Pode encontrar o ponto final do recurso Azure WebPubSubManagement no Portal do Azure.
Pode autenticar com o Azure Active Directory com uma credencial da biblioteca de identidades/@azure ou de um Token do AAD existente.
Para utilizar o fornecedor DefaultAzureCredential apresentado abaixo ou outros fornecedores de credenciais fornecidos com o SDK do Azure, instale o @azure/identity
pacote:
npm install @azure/identity
Também terá de registar uma nova aplicação do AAD e conceder acesso ao Azure WebPubSubManagement ao atribuir a função adequada ao seu principal de serviço (nota: funções como "Owner"
não concederão as permissões necessárias).
Defina os valores do ID do cliente, do ID do inquilino e do segredo do cliente da aplicação do AAD como variáveis de ambiente: AZURE_CLIENT_ID
, AZURE_TENANT_ID
, AZURE_CLIENT_SECRET
.
Para obter mais informações sobre como criar uma Aplicação Azure AD, consulte este guia.
const { WebPubSubManagementClient } = require("@azure/arm-webpubsub");
const { DefaultAzureCredential } = require("@azure/identity");
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new WebPubSubManagementClient(new DefaultAzureCredential(), subscriptionId);
Pacote JavaScript
Para utilizar esta biblioteca de cliente no browser, primeiro tem de utilizar um bundler. Para obter detalhes sobre como fazê-lo, consulte a nossa documentação de agrupamento.
Conceitos-chave
WebPubSubManagementClient
WebPubSubManagementClient
é a interface primária para programadores que utilizam a biblioteca de cliente Azure WebPubSubManagement. Explore os métodos neste objeto de cliente para compreender as diferentes funcionalidades do serviço Azure WebPubSubManagement a que pode aceder.
Resolução de problemas
Registo
Ativar o registo pode ajudar a descobrir informações úteis sobre falhas. Para ver um registo de pedidos HTTP e respostas, defina a variável de AZURE_LOG_LEVEL
ambiente como info
. Em alternativa, o registo pode ser ativado no runtime ao chamar setLogLevel
no @azure/logger
:
const { setLogLevel } = require("@azure/logger");
setLogLevel("info");
Para obter instruções mais detalhadas sobre como ativar registos, pode ver os documentos do pacote de @azure/logger.
Passos seguintes
Veja o diretório de exemplos para obter exemplos detalhados sobre como utilizar esta biblioteca.
Contribuir
Se quiser contribuir para esta biblioteca, leia o guia de contribuição para saber mais sobre como criar e testar o código.