Azure ApiManagement client library for JavaScript - versão 1.0.0-beta.1

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

Ligações principais:

Introdução

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-aigateway

Instale a biblioteca cliente Azure ApiManagement para JavaScript com npm:

npm install @azure/arm-aigateway

Criar e autenticar um ApiManagementClient

Para criar um objeto cliente para aceder à API do Azure ApiManagement, vai precisar do endpoint seu recurso Azure ApiManagement e de um credentialarquivo . O cliente Azure ApiManagement pode usar credenciais Microsoft Entra para autenticação. Pode encontrar o endpoint para o seu recurso Azure ApiManagement no portal do Azure.

Pode autenticar-se com o Microsoft Entra ID usando uma credencial da biblioteca @azure/identity ou um token Microsoft Entra 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 Microsoft Entra e conceder acesso ao Azure ApiManagement atribuindo o papel adequado ao seu principal de serviço (nota: funções como "Owner" não concedem as permissões necessárias).

Para mais informações sobre como criar uma aplicação Microsoft Entra, consulte este guia.

Usando ambientes Node.js e Node-like, você pode usar a classe DefaultAzureCredential para autenticar o cliente.

import { ApiManagementClient } from "@azure/arm-aigateway";
import { DefaultAzureCredential } from "@azure/identity";

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

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

import { InteractiveBrowserCredential } from "@azure/identity";
import { ApiManagementClient } from "@azure/arm-aigateway";

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

ApiManagementClient

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

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 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.

Contributing

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

  • Última atualização a