Dela via


Azure Portal-klientbibliotek för JavaScript – version 1.0.0-beta.5

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

Tillåter skapande och borttagning av delade Azure-instrumentpaneler.

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-portal-paketet

Installera Azure Portal-klientbiblioteket för JavaScript med npm:

npm install @azure/arm-portal

Skapa och autentisera en Portal

Om du vill skapa ett klientobjekt för åtkomst till Azure Portal-API:et behöver endpoint du azure-portalresursen och .credential Azure Portal-klienten kan använda Azure Active Directory-autentiseringsuppgifter för att autentisera. Du hittar slutpunkten för azure-portalresursen 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-portalen 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 { Portal } = require("@azure/arm-portal");
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 Portal(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 Portal(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

Portalen

Portal är det primära gränssnittet för utvecklare som använder Azure Portal-klientbiblioteket. Utforska metoderna i det här klientobjektet för att förstå de olika funktionerna i Azure Portal-tjä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