Azure RelayAPI client library for JavaScript - versie 4.0.0

Dit pakket bevat een isomorfe SDK (draait zowel in Node.js als in browsers) voor Azure RelayAPI-client.

Gebruik deze API's om Azure Relay-bronnen te beheren via Azure Resource Manager.

Sleutelkoppelingen:

Aan de slag

Momenteel ondersteunde omgevingen

Zie ons ondersteuningsbeleid voor meer informatie.

Prerequisites

Het @azure/arm-relay-pakket installeren

Installeer de Azure RelayAPI clientbibliotheek voor JavaScript met npm:

npm install @azure/arm-relay

Een RelayAPI maken en verifiëren

Om een clientobject te maken dat toegang krijgt tot de Azure RelayAPI API, heb je de endpoint van je Azure RelayAPI-resource en een credential. De Azure RelayAPI-client kan Azure Active Directory-inloggegevens gebruiken om te authenticeren. Je kunt het eindpunt voor je Azure RelayAPI-resource vinden in het Azure Portal.

U kunt verifiëren met Azure Active Directory met behulp van een referentie uit de @azure/identiteit-bibliotheek of een bestaand AAD-token.

Als u de DefaultAzureCredential- provider wilt gebruiken die hieronder wordt weergegeven, of andere referentieproviders die zijn opgegeven bij de Azure SDK, installeert u het @azure/identity-pakket:

npm install @azure/identity

Je zult ook een nieuwe AAD-applicatie moeten registreren en toegang moeten verlenen tot Azure RelayAPI door de geschikte rol toe te wijzen aan je serviceprincipe (let op: rollen zoals "Owner" geven niet de benodigde rechten).

Raadpleeg deze handleidingvoor meer informatie over het maken van een Azure AD-toepassing.

Met Node.js- en Node-achtige omgevingen kunt u de DefaultAzureCredential-klasse gebruiken om de client te verifiëren.

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

Gebruik voor browseromgevingen de InteractiveBrowserCredential uit het @azure/identity-pakket om te verifiëren.

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

Als u deze clientbibliotheek in de browser wilt gebruiken, moet u eerst een bundelaar gebruiken. Raadpleeg onze bundeldocumentatievoor meer informatie over hoe u dit doet.

belangrijke concepten

RelayAPI

RelayAPIis de primaire interface voor ontwikkelaars die de Azure RelayAPI clientbibliotheek gebruiken. Verken de methoden op dit clientobject om de verschillende functies van de Azure RelayAPI-service te begrijpen die je kunt gebruiken.

Troubleshooting

Logboekregistratie

Het inschakelen van logboekregistratie kan helpen nuttige informatie over fouten te ontdekken. Als u een logboek met HTTP-aanvragen en -antwoorden wilt zien, stelt u de omgevingsvariabele AZURE_LOG_LEVEL in op info. U kunt logboekregistratie ook tijdens runtime inschakelen door setLogLevel aan te roepen in de @azure/logger:

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

setLogLevel("info");

Voor meer gedetailleerde instructies over het inschakelen van logboeken, kunt u de @azure/logger pakketdocumentenbekijken.

Volgende stappen 

Bekijk de voorbeelden map voor gedetailleerde voorbeelden over het gebruik van deze bibliotheek.

Bijdragen

Als u een bijdrage wilt leveren aan deze bibliotheek, leest u de gids voor bijdragen voor meer informatie over het bouwen en testen van de code.

  • Last updated on