Azure RelayAPI client library for JavaScript - versione 4.0.0

Questo pacchetto contiene un SDK isomorfo (che funziona sia in Node.js che nei browser) per Azure client RelayAPI.

Usa queste API per gestire le risorse di Inoltro di Azure tramite Azure Resource Manager.

Collegamenti chiave:

Come iniziare

Ambienti attualmente supportati

Per altri dettagli, vedere i criteri di supporto .

Prerequisiti

Installare il pacchetto @azure/arm-relay

Installa la libreria client Azure RelayAPI per JavaScript con npm:

npm install @azure/arm-relay

Creare ed autenticare un RelayAPI

Per creare un oggetto client per accedere all'API Azure RelayAPI, avrai bisogno della endpoint tua risorsa Azure RelayAPI e di un credential. Il client Azure RelayAPI può utilizzare le credenziali di Azure Active Directory per autenticarsi. Puoi trovare l'endpoint per la tua risorsa Azure RelayAPI nell'portale di Azure.

È possibile eseguire l'autenticazione con Azure Active Directory usando credenziali dalla libreria di di @azure/identità o un token AAD esistente.

Per usare il provider DefaultAzureCredential illustrato di seguito o altri provider di credenziali forniti con Azure SDK, installare il pacchetto :

npm install @azure/identity

Dovrai anche registrare una nuova applicazione AAD e concedere l'accesso ad Azure RelayAPI assegnando il ruolo appropriato al tuo principale di servizio (nota: ruoli come questo "Owner" non concederanno i permessi necessari).

Per altre informazioni su come creare un'applicazione Azure AD, vedere questa guida.

Usando Node.js e ambienti simili a Node, è possibile usare la classe DefaultAzureCredential per autenticare il client.

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

Per gli ambienti del browser, usare il InteractiveBrowserCredential dal pacchetto di @azure/identity per l'autenticazione.

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

Pacchetto JavaScript

Per usare questa libreria client nel browser, è prima necessario usare un bundler. Per informazioni dettagliate su come eseguire questa operazione, vedere la documentazione di creazione di bundle .

Concetti chiave

RelayAPI

RelayAPIè l'interfaccia principale per gli sviluppatori che utilizzano la libreria client Azure RelayAPI. Esplora i metodi su questo oggetto client per comprendere le diverse funzionalità del servizio Azure RelayAPI a cui puoi accedere.

Troubleshooting

Registrazione

L'abilitazione della registrazione può aiutare a individuare informazioni utili sugli errori. Per visualizzare un log di richieste e risposte HTTP, impostare la variabile di ambiente AZURE_LOG_LEVEL su info. In alternativa, la registrazione può essere abilitata in fase di esecuzione chiamando setLogLevel nel @azure/logger:

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

setLogLevel("info");

Per istruzioni più dettagliate su come abilitare i log, è possibile esaminare la documentazione del pacchetto @azure/logger.

Passaggi successivi

Per esempi dettagliati su come usare questa libreria, vedere gli esempi di directory.

Contribuire

Per contribuire a questa libreria, leggere la guida contribuire per altre informazioni su come compilare e testare il codice.

  • Last updated on