Azure RelayAPI client library for JavaScript - versão 4.0.0

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

Use estas APIs para gerir os recursos do Azure Relay através do Azure Resource Manager.

Ligações principais:

Como Começar

Ambientes atualmente suportados

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

Pré-requisitos

  • Uma assinatura do Azure.

Instalar o pacote @azure/arm-relay

Instale a biblioteca cliente Azure RelayAPI para JavaScript com npm:

npm install @azure/arm-relay

Criar e autenticar um RelayAPI

Para criar um objeto cliente para aceder à API do Azure RelayAPI, precisará do endpoint seu recurso do Azure RelayAPI e de um credential. O cliente Azure RelayAPI pode usar credenciais do Azure Active Directory para autenticar. Pode encontrar o endpoint para o seu recurso Azure RelayAPI no portal do Azure.

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

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

npm install @azure/identity

Também terá de registar 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" concedem as permissões necessárias).

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

Usando ambientes Node.js e Node-like, 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 cliente no navegador, primeiro você precisa usar um bundler. Para obter detalhes sobre como fazer isso, consulte nossa documentação de agregação de .

Conceitos-chave

RelayAPI

RelayAPIé a interface principal para programadores que utilizam a biblioteca cliente Azure RelayAPI. Explore os métodos neste objeto cliente para compreender as diferentes funcionalidades do serviço Azure RelayAPI a que pode aceder.

Troubleshooting

Registo

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 tempo de execução 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.

Passos seguintes

Por favor, dê uma olhada no exemplos diretório para obter exemplos detalhados sobre como usar esta biblioteca.

Contribuição

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

  • Last updated on