Клиентская библиотека обхода коммуникационной сети Azure для JavaScript версии 1.0.0
Обход сетей коммуникации Azure управляет маркерами для Службы коммуникации Azure.
Он предоставит пользователю учетные данные TURN.
Начало работы
Предварительные требования
- Подписка Azure.
- Существующий ресурс Служб коммуникации. Если вам нужно создать ресурс, можно использовать портал Azure, Azure PowerShell или Azure CLI.
Установка
npm install @azure/communication-network-traversal
npm install @azure/communication-identity
Поддержка браузеров
Пакет JavaScript
Чтобы использовать эту клиентную библиотеку в браузере, сначала необходимо использовать средство пакетной установки. Дополнительные сведения о том, как это сделать, см. в документации по объединениям.
Основные понятия
Примеры
Аутентификация
Ключ и (или) строку подключения можно получить из ресурса Служб коммуникации на портале Azure. Получив ключ, можно выполнить проверку подлинности CommunicationRelayClient
с помощью любого из следующих методов:
Создание KeyCredential
с AzureKeyCredential
до инициализации клиента
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");
Устранение неполадок
Дальнейшие действия
Подробные примеры использования этой библиотеки см. в каталоге примеров .
Участие
Если вы хотите вносить изменения в эту библиотеку, ознакомьтесь с руководством по внесению изменений, в котором содержатся сведения о создании и тестировании кода.
Связанные проекты
Azure SDK for JavaScript