Compartilhar via


Biblioteca de clientes do Provedor de Recursos do Azure Visual Studio para JavaScript – versão 4.0.0-beta.2

Esse pacote contém um SDK isomórfico (executado em Node.js e em navegadores) para o cliente do Provedor de Recursos do Azure Visual Studio.

Use essas APIs para gerenciar Visual Studio Team Services recursos por meio do Resource Manager do Azure. Todas as operações de tarefas estão em conformidade com a especificação do protocolo HTTP/1.1 e cada operação retorna um cabeçalho x-ms-request-id que pode ser usado para obter informações sobre a solicitação. Você deve verificar se as solicitações feitas a esses recursos são seguras. Para obter mais informações, consulte /rest/api/index.

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

Instale a biblioteca de clientes do Provedor de Recursos do Azure Visual Studio para JavaScript com npm:

npm install @azure/arm-visualstudio

Criar e autenticar um VisualStudioResourceProviderClient

Para criar um objeto de cliente para acessar a API do Provedor de Recursos do Azure Visual Studio, você precisará do endpoint do recurso do Provedor de Recursos do Azure Visual Studio e de um credential. O cliente do Provedor de Recursos do Azure Visual Studio pode usar as credenciais do Azure Active Directory para autenticar. Você pode encontrar o ponto de extremidade para o recurso do Provedor de Recursos do Azure Visual Studio 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 Provedor de Recursos do Azure Visual Studio 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, confira este guia.

const { VisualStudioResourceProviderClient } = require("@azure/arm-visualstudio");
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 VisualStudioResourceProviderClient(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 VisualStudioResourceProviderClient(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

VisualStudioResourceProviderClient

VisualStudioResourceProviderClient é a interface principal para desenvolvedores que usam a biblioteca de clientes do Provedor de Recursos do Azure Visual Studio. Explore os métodos neste objeto cliente para entender os diferentes recursos do serviço provedor de recursos do Azure Visual Studio que você pode acessar.

Solução de problemas

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

Dê uma olhada no 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