Compartilhar via

Biblioteca de clientes do AzureApiCenter para JavaScript

  • Artigo

Esse pacote contém um SDK isomórfico (executado em Node.js e em navegadores) para o cliente AzureApiCenter.

Provedor de Recursos do Centro de API do Azure.

Código-fonte | Pacote (NPM) | Documentação | de referência da APIAmostras

Introdução

Ambientes com suporte no momento

Confira nossa política de suporte para mais detalhes.

Pré-requisitos

Instalar o pacote @azure/arm-apicenter

Instale a biblioteca de clientes do AzureApiCenter para JavaScript com npm:

npm install @azure/arm-apicenter

Criar e autenticar um AzureAPICenter

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

Você pode autenticar com o Azure Active Directory usando uma credencial da biblioteca de @azure/identidade ou um Token do AAD existente.

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

npm install @azure/identity

Você também precisará registrar um novo aplicativo do AAD e conceder acesso ao AzureApiCenter atribuindo a função adequada à sua entidade de serviço (observação: funções como "Owner" não concederão as permissões necessárias). Defina os valores da ID do cliente, da ID do locatário e do segredo do cliente do aplicativo AAD como variáveis de ambiente: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

Para obter mais informações sobre como criar um aplicativo Azure AD marcar este guia.

const { AzureAPICenter } = require("@azure/arm-apicenter");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.

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

// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
//   tenantId: "<YOUR_TENANT_ID>",
//   clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new AzureAPICenter(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.

Principais conceitos

AzureAPICenter

AzureAPICenter é a interface primária para desenvolvedores que usam a biblioteca de clientes do AzureApiCenter. Explore os métodos neste objeto cliente para entender os diferentes recursos do serviço AzureApiCenter que você pode acessar.

Solução de problemas

Registro em log

A habilitação do 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 log pode ser habilitado no runtime chamando setLogLevel em @azure/logger:

const { setLogLevel } = require("@azure/logger");
setLogLevel("info");

Para obter instruções mais detalhadas sobre como habilitar logs, veja os documentos do pacote @azure/logger.

Próximas etapas

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

Contribuição

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

Impressões