Azure RelayAPI biblioteca cliente para JavaScript - versão 4.0.0

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

Use essas APIs para gerenciar recursos do Retransmissão do Azure através do Azure Resource Manager.

Links principais:

Como começar

Ambientes com suporte no momento

Veja nossa política suporte para mais detalhes.

Pré-requisitos

Instalar o pacote @azure/arm-relay

Instale a biblioteca cliente Azure RelayAPI para JavaScript comnpm:

npm install @azure/arm-relay

Criar e autenticar um RelayAPI

Para criar um objeto cliente para acessar a API do Azure RelayAPI, você precisará do endpoint seu recurso do Azure RelayAPI e de um credentialrecurso . O cliente Azure RelayAPI pode usar credenciais do Azure Active Directory para autenticar. Você pode encontrar o endpoint para seu recurso Azure RelayAPI 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, por favor, instale o pacote @azure/identity:

npm install @azure/identity

Você também precisará registrar uma nova aplicação AAD e conceder acesso ao Azure RelayAPI atribuindo o papel adequado ao seu principal de serviço (nota: funções como não "Owner" 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 { RelayAPI } from "@azure/arm-relay";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { RelayAPI } from "@azure/arm-relay";

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

RelayAPI

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

Solução de problemas

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

Próximas Etapas 

Por favor, dê uma olhada no diretório samples para exemplos detalhados de como usar essa biblioteca.

Contributing

Se você quiser contribuir para esta biblioteca, por favor leia o guia contribuição para saber mais sobre como construir e testar o código.

  • Last updated on