Condividi tramite

Libreria client del provider di risorse di Azure Visual Studio per JavaScript - versione 4.0.0-beta.2

  • Articolo

Questo pacchetto contiene un SDK isomorfico (eseguito sia in Node.js che nei browser) per il client del provider di risorse di Azure Visual Studio.

Usare queste API per gestire le risorse Visual Studio Team Services tramite il Resource Manager di Azure. Tutte le operazioni relative alle attività sono conformi alla specifica del protocollo HTTP/1.1 e ogni operazione restituisce un'intestazione x-ms-request-id che può essere usata per ottenere informazioni sulla richiesta. È necessario assicurarsi che le richieste effettuate per tali risorse siano sicure. Per altre informazioni, vedere /rest/api/index.

Codice | sorgente Pacchetto (NPM) | Documentazione | di riferimento sulle APICampioni

Introduzione

Ambienti attualmente supportati

Per altre informazioni, vedere i criteri di supporto.

Prerequisiti

Installare il pacchetto @azure/arm-visualstudio

Installare la libreria client del provider di risorse di Azure Visual Studio per JavaScript con npm:

npm install @azure/arm-visualstudio

Creare e autenticare un oggetto VisualStudioResourceProviderClient

Per creare un oggetto client per accedere all'API del provider di risorse di Azure Visual Studio, è necessario disporre endpoint della risorsa del provider di risorse di Azure Visual Studio e di un .credential Il client del provider di risorse di Azure Visual Studio può usare le credenziali di Azure Active Directory per l'autenticazione. È possibile trovare l'endpoint per la risorsa del provider di risorse di Azure Visual Studio nel portale di Azure.

È possibile eseguire l'autenticazione con Azure Active Directory usando credenziali dalla libreria @azure/identità o da un token AAD esistente.

Per usare il provider DefaultAzureCredential illustrato di seguito o altri provider di credenziali forniti con Azure SDK, installare il @azure/identity pacchetto:

npm install @azure/identity

Sarà anche necessario registrare una nuova applicazione AAD e concedere l'accesso al provider di risorse di Azure Visual Studio assegnando il ruolo appropriato all'entità servizio(nota: i ruoli, "Owner" ad esempio, non concedono le autorizzazioni necessarie). Impostare i valori dell'ID client, dell'ID tenant e del segreto client dell'applicazione AAD come variabili di ambiente: AZURE_CLIENT_ID, , AZURE_TENANT_IDAZURE_CLIENT_SECRET.

Per altre informazioni su come creare un'applicazione Azure AD, vedere questa guida.

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);

JavaScript Bundle

Per usare questa libreria client nel browser, è prima necessario usare un bundler. Per informazioni dettagliate su come eseguire questa operazione, vedere la documentazione di creazione di bundle.

Concetti chiave

VisualStudioResourceProviderClient

VisualStudioResourceProviderClient è l'interfaccia principale per gli sviluppatori che usano la libreria client del provider di risorse di Azure Visual Studio. Esplorare i metodi in questo oggetto client per comprendere le diverse funzionalità del servizio provider di risorse di Azure Visual Studio a cui è possibile accedere.

Risoluzione dei problemi

Registrazione

L'abilitazione della registrazione consente di individuare informazioni utili sugli errori. Per visualizzare un log di richieste e risposte HTTP, impostare la variabile di ambiente AZURE_LOG_LEVEL su info. In alternativa, la registrazione può essere abilitata in fase di esecuzione chiamando setLogLevel in @azure/logger:

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

Per istruzioni più dettagliate su come abilitare i log, è possibile esaminare la documentazione del pacchetto di @azure/logger.

Passaggi successivi

Per esempi dettagliati su come usare questa libreria, vedere la directory degli esempi .

Contributo

Per contribuire a questa libreria, leggere la guida ai contributi per altre informazioni su come compilare e testare il codice.

Impression