Dela via


Azure NginxManagement client library for JavaScript - version 4.0.0

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

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

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

npm install @azure/arm-nginx

Skapa och autentisera en NginxManagementClient

För att skapa ett klientobjekt för att komma åt Azure NginxManagement API behöver du din endpoint Azure NginxManagement-resurs och en credential. Azure NginxManagement-klienten kan använda Azure Active Directory-inloggningsuppgifter för autentisering. Du kan hitta endpointen för din Azure NginxManagement-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 SDK:

npm install @azure/identity

Du måste också registrera en ny AAD-applikation och ge åtkomst till Azure NginxManagement genom att tilldela lämplig roll till din tjänstehuvudman (notera: 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 { NginxManagementClient } from "@azure/arm-nginx";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new NginxManagementClient(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 { NginxManagementClient } from "@azure/arm-nginx";

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

NginxManagementClient

NginxManagementClient är det primära gränssnittet för utvecklare som använder Azure NginxManagement-klientbiblioteket. Utforska metoderna på detta klientobjekt för att förstå de olika funktionerna i Azure NginxManagement-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 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.