Краткое руководство. Подключение к экземпляру Azure Web PubSub из CLI
В этом кратком руководстве показано, как подключиться к экземпляру Azure Web PubSub и опубликовать сообщения для подключенных клиентов с помощью Azure CLI.
Если у вас еще нет подписки Azure, создайте бесплатную учетную запись Azure, прежде чем начинать работу.
Необходимые компоненты
Используйте среду Bash в Azure Cloud Shell. Дополнительные сведения см . в кратком руководстве по Bash в Azure Cloud Shell.
Если вы предпочитаете выполнять справочные команды CLI локально, установите Azure CLI. Если вы работаете в Windows или macOS, Azure CLI можно запустить в контейнере Docker. Дополнительные сведения см. в статье Как запустить Azure CLI в контейнере Docker.
Если вы используете локальную установку, выполните вход в Azure CLI с помощью команды az login. Чтобы выполнить аутентификацию, следуйте инструкциям в окне терминала. Сведения о других возможностях, доступных при входе, см. в статье Вход с помощью Azure CLI.
Установите расширение Azure CLI при первом использовании, когда появится соответствующий запрос. Дополнительные сведения о расширениях см. в статье Использование расширений с Azure CLI.
Выполните команду az version, чтобы узнать установленную версию и зависимые библиотеки. Чтобы обновиться до последней версии, выполните команду az upgrade.
- Для работы с этим кратким руководством требуется Azure CLI версии 2.22.0 или более поздней. Если вы используете Azure Cloud Shell, последняя версия уже установлена.
Создание или изменение группы ресурсов
Группа ресурсов — это логический контейнер, в котором происходит развертывание ресурсов Azure и управление ими. Используйте команду az group create, чтобы создать группу ресурсов с именем myResourceGroup в расположенииeastus.
az group create --name myResourceGroup --location EastUS
Создание экземпляра Web PubSub
Запустите az extension add to install or upgrade the webpubsub extension to the current version.
az extension add --upgrade --name webpubsub
Используйте команду azure CLI az webpubsub create , чтобы создать web PubSub в созданной группе ресурсов. Следующая команда создает ресурс Free Web PubSub в группе ресурсов myResourceGroup в EastUS:
Важно!
Каждый ресурс Web PubSub должен иметь уникальное имя. В следующих примерах замените <your-unique-resource-name> именем своей службы Web PubSub.
az webpubsub create --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --location "EastUS" --sku Free_F1
В выходных данных команды будут показаны свойства созданного ресурса. Запишите значения двух указанных ниже свойств.
- Имя ресурса: имя, которое вы ввели для указанного выше параметра
--name. - hostName: в примере имя узла
<your-unique-resource-name>.webpubsub.azure.com/.
На данном этапе любые операции в этом новом ресурсе могут выполняться только с использованием вашей учетной записи Azure.
Экспериментирование с экземпляром
Подключение к службе
Используйте команду интерфейса командной строки Azure az webpubsub client для запуска клиентского подключения через WebSocket к службе, созданной на предыдущем шаге, с указанием следующих сведений:
- Имя концентратора: строка от 1 до 127 символов. Строка должна начинаться с букв
(a-z, A-Z)и содержать только буквы и цифры(0-9, a-z, A-Z)или символ подчеркивания(_).
Концентратор — это логический набор связанных подключений WebSocket. Подробные сведения о данных концепциях приведены в разделе О концентраторах, группах и подключениях.
Важно!
Замените <your-unique-resource-name> на имя ресурса Web PubSub, созданного на предыдущих шагах.
- Имя концентратора: myHub1.
- Имя группы ресурсов: myResourceGroup.
- Идентификатор пользователя: user1.
az webpubsub client start --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --user-id "user1"
Как видно, команда установила WebSocket-подключение к службе Web PubSub, и вы получили JSON-сообщение о том, что служба успешно подключена и назначена с уникальным connectionId:
{"type":"system","event":"connected","userId":"user1","connectionId":"<your_unique_connection_id>"}
Проверьте работу службы, попробовав присоединиться к группам с помощью joingroup <group-name> и отправить им сообщения с помощью sendtogroup <group-name>:
joingroup group1
sendtogroup group1 hello
Публикация сообщений и управление клиентами
Azure CLI также предоставляет команды az webpubsub service для управления подключениями клиентов.
Откройте другую команду CLI, и вы сможете рассылать сообщения клиентам:
- Имя концентратора: myHub1.
- Имя группы ресурсов: myResourceGroup.
az webpubsub service broadcast --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --payload "Hello World"
Вернитесь к предыдущей команде CLI, и вы увидите, что клиент получил сообщение:
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
Кроме того, можно вывести список всех доступных команд, используя параметр --help, и поэкспериментировать с перечисленными командами.
az webpubsub service --help
Следующие шаги
В этом кратком руководстве представлено общее описание того, как подключиться к службе Web PubSub и публиковать сообщения на подключенных клиентах.
В реальных приложениях вы можете использовать пакеты SDK на различных языках для создания собственного приложения. Мы также предоставляем расширения функций, позволяющие легко создавать бессерверные приложения.
Используйте эти ресурсы для начала создания собственного приложения: