Dela via

Azure Visual Studio-resursproviderns klientbibliotek för JavaScript – version 4.0.0-beta.2

Det här paketet innehåller en isomorf SDK (körs både i Node.js och i webbläsare) för Azure Visual Studio Resource Provider-klienten.

Använd dessa API:er för att hantera Visual Studio Team Services-resurser via Azure Resource Manager. Alla åtgärder följer protokollspecifikationen HTTP/1.1, och varje åtgärd returnerar en rubrik av typen x-ms-request-id som kan användas till att hämta information om förfrågningen. Du måste se till att förfrågningarna mot de här resurserna är säkra. Mer information finns i /rest/api/index.

Källkod | Paket (NPM) | API-referensdokumentation | Prover

Komma igång

Miljöer som stöds för närvarande

Mer information finns i vår supportprincip .

Förutsättningar

Installera @azure/arm-visualstudio-paketet

Installera Klientbiblioteket för Azure Visual Studio-resursprovidern för JavaScript med npm:

npm install @azure/arm-visualstudio

Skapa och autentisera en VisualStudioResourceProviderClient

Om du vill skapa ett klientobjekt för att få åtkomst till Azure Visual Studio Resource Provider-API:et behöver du resursen endpoint för Azure Visual Studio-resursprovidern och en credential. Azure Visual Studio-resursproviderklienten kan använda Azure Active Directory-autentiseringsuppgifter för att autentisera. Du hittar slutpunkten för resursproviderresursen för Azure Visual Studio i Azure-portalen.

Du kan autentisera med Azure Active Directory med hjälp av en autentiseringsuppgift från @azure/identitetsbiblioteket eller en befintlig AAD-token.

Om du vill använda DefaultAzureCredential-providern som visas nedan eller andra leverantörer av autentiseringsuppgifter som medföljer Azure SDK installerar @azure/identity du paketet:

npm install @azure/identity

Du måste också registrera ett nytt AAD-program och bevilja åtkomst till Azure Visual Studio-resursprovidern genom att tilldela lämplig roll till tjänstens huvudnamn (obs! roller som "Owner" inte beviljar nödvändiga behörigheter). Ange värdena för klient-ID, klient-ID och klienthemlighet för AAD-programmet som miljövariabler: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET.

Mer information om hur du skapar ett Azure AD-program finns i den här guiden.

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

Om du vill använda det här klientbiblioteket i webbläsaren måste du först använda en bundler. Mer information om hur du gör detta finns i vår paketeringsdokumentation.

Viktiga begrepp

VisualStudioResourceProviderClient

VisualStudioResourceProviderClient är det primära gränssnittet för utvecklare som använder Azure Visual Studio-resursproviderns klientbibliotek. Utforska metoderna för det här klientobjektet för att förstå de olika funktionerna i Azure Visual Studio-resursprovidertjänsten som du kan komma åt.

Felsökning

Loggning

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg över HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Du kan också aktivera loggning vid körning genom att anropa setLogLevel i @azure/logger:

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

Mer detaljerade anvisningar om hur du aktiverar loggar finns i @azure-/loggningspaketdokumenten.

Nästa steg

Ta en titt på exempelkatalogen för detaljerade exempel på hur du använder det här biblioteket.

Bidra

Om du vill bidra till det här biblioteket kan du läsa bidragsguiden för att lära dig mer om hur du skapar och testar koden.

Visningar