你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

适用于 JavaScript 的 Azure 通信网络遍历客户端库 - 版本 1.0.0

Azure 通信网络遍历正在管理Azure 通信服务的令牌。

它将向用户提供 TURN 凭据。

入门

先决条件

安装

npm install @azure/communication-network-traversal
npm install @azure/communication-identity

浏览器支持

JavaScript 捆绑包

若要在浏览器中使用此客户端库,首先需要使用捆绑程序。 有关如何执行此操作的详细信息,请参阅捆绑 文档

关键概念

示例

身份验证

可以从 Azure 门户中的通信服务资源获取密钥和/或连接字符串。 获得密钥后,可以使用以下任一方法对 进行身份验证 CommunicationRelayClient

在初始化客户端之前使用 AzureKeyCredential 创建KeyCredential

import { AzureKeyCredential } from "@azure/core-auth";
import { CommunicationRelayClient } from "@azure/communication-network-traversal";

const credential = new AzureKeyCredential(KEY);
const client = new CommunicationRelayClient(ENDPOINT, credential);

使用连接字符串

import { CommunicationRelayClient } from "@azure/communication-network-traversal";

const connectionString = `endpoint=ENDPOINT;accessKey=KEY`;
const client = new CommunicationRelayClient(connectionString);

使用 TokenCredential

import { DefaultAzureCredential } from "@azure/identity";
import { CommunicationRelayClient } from "@azure/communication-network-traversal";

const credential = new DefaultAzureCredential();
const client = new CommunicationRelayClient(ENDPOINT, credential);

如果使用密钥初始化客户端,则还需要提供相应的终结点。 可以从 Azure 门户中的通信服务资源获取此终结点。

使用情况

创建 CommunicationRelayClient 实例

import { CommunicationRelayClient } from "@azure/communication-network-traversal";

const client = new CommunicationRelayClient(CONNECTION_STRING);

创建 CommunicationIdentityClient 实例以创建用户

import { CommunicationIdentityClient } from "@azure/communication-identity";

const client = new CommunicationIdentityClient(CONNECTION_STRING);

createUser使用 方法创建新用户。

const user = await client.createUser();

获取 configurationRelay

getConfigurationRelay使用 方法获取向用户提供的新 TURN 凭据

const config = relayClient.getRelayConfiguration(user);

此外,无需提供用户即可 getConfigurationRelay 调用 方法

const config = relayClient.getRelayConfiguration();

可以在调用时指定 RouteType getConfigurationRelay

const config = relayClient.getRelayConfiguration(user, "nearest");

故障排除

后续步骤

请查看 示例 目录,获取有关如何使用此库的详细示例。

贡献

若要为此库做出贡献,请阅读贡献指南,详细了解如何生成和测试代码。

曝光数