Libreria client attraversamento della rete di comunicazione di Azure per JavaScript - versione 1.0.0
L'attraversamento della rete di comunicazione di Azure gestisce i token per Servizi di comunicazione di Azure.
Fornirà le credenziali TURN a un utente.
Introduzione
Prerequisiti
- Una sottoscrizione di Azure.
- Una risorsa di Servizi di comunicazione esistente. Se è necessario creare la risorsa, è possibile usare il portale di Azure, il Azure PowerShell o l'interfaccia della riga di comando di Azure.
Installazione
npm install @azure/communication-network-traversal
npm install @azure/communication-identity
Supporto browser
JavaScript Bundle
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
Esempio
Authentication
È possibile ottenere una chiave e/o una stringa di connessione dalla risorsa di Servizi di comunicazione nel portale di Azure. Dopo aver ottenuto una chiave, è possibile autenticare con CommunicationRelayClient
uno dei metodi seguenti:
Creare KeyCredential
con AzureKeyCredential
prima di inizializzare il client
import { AzureKeyCredential } from "@azure/core-auth";
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const credential = new AzureKeyCredential(KEY);
const client = new CommunicationRelayClient(ENDPOINT, credential);
Uso di una stringa di connessione
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const connectionString = `endpoint=ENDPOINT;accessKey=KEY`;
const client = new CommunicationRelayClient(connectionString);
Uso di un oggetto TokenCredential
import { DefaultAzureCredential } from "@azure/identity";
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const credential = new DefaultAzureCredential();
const client = new CommunicationRelayClient(ENDPOINT, credential);
Se si usa una chiave per inizializzare il client, sarà necessario specificare anche l'endpoint appropriato. È possibile ottenere questo endpoint dalla risorsa di Servizi di comunicazione nel portale di Azure.
Utilizzo
Creazione di un'istanza di CommunicationRelayClient
import { CommunicationRelayClient } from "@azure/communication-network-traversal";
const client = new CommunicationRelayClient(CONNECTION_STRING);
Creazione di un'istanza di CommunicationIdentityClient per creare un utente
import { CommunicationIdentityClient } from "@azure/communication-identity";
const client = new CommunicationIdentityClient(CONNECTION_STRING);
Usare il createUser
metodo per creare un nuovo utente.
const user = await client.createUser();
Recupero della configurazioneRelay
Usare il getConfigurationRelay
metodo per ottenere nuove credenziali TURN che forniscono un utente
const config = relayClient.getRelayConfiguration(user);
È anche possibile chiamare il getConfigurationRelay
metodo senza fornire un utente
const config = relayClient.getRelayConfiguration();
È possibile specificare un oggetto RouteType durante la chiamata getConfigurationRelay
const config = relayClient.getRelayConfiguration(user, "nearest");
Risoluzione dei problemi
Passaggi successivi
Per esempi dettagliati su come usare questa libreria, vedere la directory degli esempi .
Contributo
Per contribuire a questa libreria, leggere la guida ai contributi per altre informazioni su come compilare e testare il codice.
Progetti correlati
Azure SDK for JavaScript