Azure CompanionAPI klientbibliotek för JavaScript - version 1.0.0-beta.1

Detta paket innehåller ett isomorft SDK (körs både i Node.js och i webbläsare) för Azure CompanionAPI-klient.

Nyckellänkar:

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

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

npm install @azure/arm-napsteromniagentapi

Skapa och autentisera en CompanionAPIClient

För att skapa ett klientobjekt för att komma åt Azure CompanionAPI API:et behöver du en endpoint av din Azure CompanionAPI-resurs och en credential. Azure CompanionAPI-klienten kan använda Azure Active Directory-uppgifter för autentisering. Du kan hitta endpointen för din Azure CompanionAPI-resurs i Azure Portal.

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

Installera -paketet om du vill använda @azure/identity som visas nedan eller andra leverantörer av autentiseringsuppgifter som tillhandahålls med Azure SDKs:

npm install @azure/identity

Du behöver också registrera en ny AAD-applikation och ge tillgång till Azure CompanionAPI genom att tilldela lämplig roll till din tjänstehuvudman (observera: roller som "Owner" inte ger nödvändiga behörigheter).

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

Med hjälp av Node.js- och Node-liknande miljöer kan du använda klassen DefaultAzureCredential för att autentisera klienten.

import { CompanionAPIClient } from "@azure/arm-napsteromniagentapi";
import { DefaultAzureCredential } from "@azure/identity";

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

För webbläsarmiljöer använder du InteractiveBrowserCredential från @azure/identity-paketet för att autentisera.

import { InteractiveBrowserCredential } from "@azure/identity";
import { CompanionAPIClient } from "@azure/arm-napsteromniagentapi";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new CompanionAPIClient(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

CompanionAPIClient

CompanionAPIClientär det primära gränssnittet för utvecklare som använder Azure CompanionAPI-klientbiblioteket. Utforska metoderna på detta klientobjekt för att förstå de olika funktionerna i Azure CompanionAPI-tjänsten som du kan komma åt.

Felsökning

Loggning / Skogsavverkning

Aktivering av loggning kan hjälpa dig att hitta användbar information om fel. Om du vill se en logg med 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:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i dokument för @azure/logger-paket.

Nästa steg

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

Contributing

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

  • Last updated on