Azure RelayAPI 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 RelayAPI-klient.

Använd dessa API:er för att hantera Azure Relay-resurser via Azure Resource Manager.

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

Installera Azure RelayAPI klientbiblioteket för JavaScript med npm:

npm install @azure/arm-relay

Skapa och autentisera en RelayAPI

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

Du kan autentisera dig med Azure Active Directory med en legitimation från biblioteket @azure/identity 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 åtkomst till Azure RelayAPI genom att tilldela lämplig roll till din tjänstehuvudman (notera: roller som "Owner" ger inte nödvändiga behörigheter).

För mer information om hur man skapar en Azure AD-applikation, kolla in denna guide.

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

import { RelayAPI } from "@azure/arm-relay";
import { DefaultAzureCredential } from "@azure/identity";

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

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

RelayAPI

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

Felsökning

Logging

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å exempelkatalogen för detaljerade exempel på hur du använder det här biblioteket.

Contributing

Om du vill bidra till detta bibliotek, läs gärna guiden bidrag för att lära dig mer om hur man bygger och testar koden.

  • Last updated on