Azure RelayAPI client library for JavaScript - version 4.0.0

Ez a csomag izomorf SDK-t tartalmaz (amely Node.js-ban és böngészőkben is fut) Azure RelayAPI klienshez.

Használd ezeket az API-kat az Azure Relay erőforrások kezelésére az Azure Resource Manager-en keresztül.

Főbb hivatkozások:

Kezdő lépések

Jelenleg támogatott környezetek

További részletekért tekintse meg támogatási szabályzatunkat.

Prerequisites

Telepítse a(z) @azure/arm-relay csomagot

Install the Azure RelayAPI client library for JavaScript with npm:

npm install @azure/arm-relay

RelayAPI létrehozása és hitelesítése

Az Azure RelayAPI endpoint API-hoz szükséges ügyfélobjektum létrehozásához az Azure RelayAPI erőforrására és egy credential. Az Azure RelayAPI kliens Azure Active Directory hitelesítő adataival hitelesítheti a hitelesítést. Az Azure RelayAPI erőforrásod végpontját az Azure Portal-ban találhatod.

Az Azure Active Directoryval hitelesítést végezhet a @azure/identitáskódtárból származó hitelesítő adatokkal, vagy egy meglévő AAD-jogkivonat .

Az alább látható DefaultAzureCredential szolgáltató vagy az Azure SDK-hoz biztosított egyéb hitelesítő adatok szolgáltatójának használatához telepítse a @azure/identity csomagot:

npm install @azure/identity

Regisztrálnod kell egy új AAD alkalmazást is, és hozzáférést kell adni az Azure RelayAPI-hoz azzal, hogy a megfelelő szerepet rendeled a szolgáltatási alapvetőnek (megjegyzés: az ilyen "Owner" szerepek nem adják meg a szükséges jogosultságokat).

Az Azure AD-alkalmazások létrehozásáról az útmutató .

Node.js és csomópontszerű környezetek használatával az osztály használatával DefaultAzureCredential hitelesítheti az ügyfelet.

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);

Böngészőkörnyezetek esetén használja a InteractiveBrowserCredential csomagból a @azure/identity hitelesítéshez.

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

Ahhoz, hogy ezt az ügyfélkódtárat a böngészőben használhassa, először egy kötegelőt kell használnia. Ennek módjáról további információt a csomagküldő dokumentációbantalál.

főbb fogalmak

RelayAPI

RelayAPIaz elsődleges interfész az Azure RelayAPI klienskönyvtárat használó fejlesztők számára. Fedezze fel ezen a kliensobjektumon található módszereket, hogy megértse az Azure RelayAPI szolgáltatás különböző funkcióit, amelyeket elérhetsz.

Troubleshooting

Fakitermelés

A naplózás engedélyezése segíthet a hibákról szóló hasznos információk feltárásában. A HTTP-kérések és válaszok naplójának megtekintéséhez állítsa a környezeti változót a AZURE_LOG_LEVEL következőre info: . Alternatívaként a naplózás futásidőben is engedélyezhető a setLogLevel hívásával a @azure/logger.

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

setLogLevel("info");

A naplók engedélyezésére vonatkozó részletesebb útmutatásért tekintse meg a @azure/logger csomag dokumentációit.

Következő lépések

A kódtár használatára vonatkozó részletes példákért tekintse meg a mintákat könyvtárat.

Hozzájárulás

Ha hozzá szeretne járulni ehhez a kódtárhoz, olvassa el a közreműködői útmutatót, amelyből többet is megtudhat a kód összeállításáról és teszteléséről.