Поделиться через

az webpubsub

  • Ссылка

Примечание.

Эта ссылка является частью расширения webpubsub для Azure CLI (версия 2.56.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az webpubsub. Подробнее о расширениях.

Команды для управления Webpubsub.

Команды

Имя Описание Тип Состояние
az webpubsub client

Команды для управления клиентскими подключениями.

 Расширение ГА
az webpubsub client start

Запустите интерактивное подключение клиента.

 Расширение ГА
az webpubsub create

Создайте webpubsub.

 Расширение ГА
az webpubsub custom-certificate

Управление пользовательскими сертификатами WebPubSub.

 Расширение ГА
az webpubsub custom-certificate create

Создайте пользовательский сертификат службы WebPubSub.

 Расширение ГА
az webpubsub custom-certificate delete

Удалите пользовательский сертификат службы WebPubSub.

 Расширение ГА
az webpubsub custom-certificate list

Вывод списка настраиваемых сертификатов службы WebPubSub.

 Расширение ГА
az webpubsub custom-certificate show

Отображение сведений о пользовательском сертификате службы WebPubSub.

 Расширение ГА
az webpubsub custom-domain

Управление параметрами личного домена.

 Расширение ГА
az webpubsub custom-domain create

Создайте личный домен службы WebPubSub.

 Расширение ГА
az webpubsub custom-domain delete

Удаление личного домена службы WebPubSub.

 Расширение ГА
az webpubsub custom-domain list

Вывод списка настраиваемых доменов службы WebPubSub.

 Расширение ГА
az webpubsub custom-domain show

Отображение сведений о пользовательском домене службы WebPubSub.

 Расширение ГА
az webpubsub delete

Удаление webpubsub.

 Расширение ГА
az webpubsub hub

Команды для управления параметрами концентратора Webpubsub.

 Расширение ГА
az webpubsub hub create

Создайте параметры концентратора для службы WebPubSub или Web PubSub для Socket.IO в бессерверном режиме.

 Расширение ГА
az webpubsub hub delete

Удаление параметров концентратора для службы WebPubSub.

 Расширение ГА
az webpubsub hub list

Список всех параметров концентратора для службы WebPubSub.

 Расширение ГА
az webpubsub hub show

Отображение параметров концентратора для службы WebPubSub.

 Расширение ГА
az webpubsub hub update

Обновление параметров концентратора для службы WebPubSub или Web PubSub для Socket.IO в бессерверном режиме.

 Расширение ГА
az webpubsub identity

Управление параметрами управляемого удостоверения.

 Расширение ГА
az webpubsub identity assign

Назначьте управляемое удостоверение для службы WebPubSub.

 Расширение ГА
az webpubsub identity remove

Удалите управляемое удостоверение для службы WebPubSub.

 Расширение ГА
az webpubsub identity show

Показать управляемое удостоверение для службы WebPubSub.

 Расширение ГА
az webpubsub key

Команды для управления ключами Webpubsub.

 Расширение ГА
az webpubsub key regenerate

Повторно создайте ключи для службы WebPubSub.

 Расширение ГА
az webpubsub key show

Отображение строк и ключей консети для службы WebPubSub.

 Расширение ГА
az webpubsub list

Список Webpubsub.

 Расширение ГА
az webpubsub list-skus

Список всех доступных номеров SKU ресурса.

 Расширение ГА
az webpubsub list-usage

Вывод списка квот использования ресурсов по расположению.

 Расширение ГА
az webpubsub network-rule

Команды для управления правилами сети Webpubsub.

 Расширение ГА
az webpubsub network-rule ip-rule

Управление правилами IP-адресов службы WebPubSub.

 Расширение ГА
az webpubsub network-rule ip-rule add

Добавьте правило IP-адресов в службу WebPubSub.

 Расширение ГА
az webpubsub network-rule ip-rule remove

Удалите правило IP из службы WebPubSub.

 Расширение ГА
az webpubsub network-rule show

Получите управление доступом к сети службы WebPubSub.

 Расширение ГА
az webpubsub network-rule update

Обновите управление доступом к сети службы WebPubSub.

 Расширение ГА
az webpubsub replica

Управление параметрами реплики.

 Расширение ГА
az webpubsub replica create

Создайте реплику службы Webpubsub.

 Расширение ГА
az webpubsub replica delete

Удалите реплику службы WebPubSub.

 Расширение ГА
az webpubsub replica list

Вывод списка реплик службы Webpubsub.

 Расширение ГА
az webpubsub replica restart

Перезапустите реплику службы WebPubSub.

 Расширение ГА
az webpubsub replica show

Отображение сведений о реплике.

 Расширение ГА
az webpubsub replica start

Запустите реплику службы WebPubSub.

 Расширение ГА
az webpubsub replica stop

Остановите реплику службы WebPubSub.

 Расширение ГА
az webpubsub replica update

Обновите реплику службы Webpubsub.

 Расширение ГА
az webpubsub restart

Перезапустите webpubsub.

 Расширение ГА
az webpubsub service

Команды для управления службой Webpubsub.

 Расширение ГА
az webpubsub service broadcast

Широковещательные сообщения в концентратор. Ошибка вызывается, если операция завершается ошибкой.

 Расширение ГА
az webpubsub service connection

Команды для управления подключениями службы Webpubsub.

 Расширение ГА
az webpubsub service connection close

Закройте определенное клиентское подключение. Ошибка вызывается, если операция завершается ошибкой.

 Расширение ГА
az webpubsub service connection exist

Проверьте, существует ли подключение клиента.

 Расширение ГА
az webpubsub service connection send

Отправьте сообщение в подключение. Ошибка вызывается, если операция завершается ошибкой.

 Расширение ГА
az webpubsub service group

Команды для управления группами служб Webpubsub.

 Расширение ГА
az webpubsub service group add-connection

Добавьте соединение в группу. Ошибка вызывается, если операция завершается ошибкой.

 Расширение ГА
az webpubsub service group add-user

Добавьте пользователя в группу. Ошибка вызывается, если операция завершается ошибкой.

 Расширение ГА
az webpubsub service group remove-connection

Удаление подключения из группы. Ошибка вызывается, если операция завершается ошибкой.

 Расширение ГА
az webpubsub service group remove-user

Удаление пользователя из группы. Ошибка вызывается, если операция завершается ошибкой.

 Расширение ГА
az webpubsub service group send

Отправьте сообщение в группу. Ошибка вызывается, если операция завершается ошибкой.

 Расширение ГА
az webpubsub service permission

Команды для управления разрешениями службы Webpubsub.

 Расширение ГА
az webpubsub service permission check

Проверьте, имеет ли подключение разрешение на указанную группу.

 Расширение ГА
az webpubsub service permission grant

Предоставьте группе разрешение на подключение. Ошибка вызывается, если операция завершается ошибкой.

 Расширение ГА
az webpubsub service permission revoke

Отмените разрешение группы из подключения. Ошибка вызывается, если операция завершается ошибкой.

 Расширение ГА
az webpubsub service user

Команды для управления пользователями службы Webpubsub.

 Расширение ГА
az webpubsub service user exist

Проверьте, подключены ли клиентские подключения для данного пользователя.

 Расширение ГА
az webpubsub service user send

Отправьте пользователю сообщение. Ошибка вызывается, если операция завершается ошибкой.

 Расширение ГА
az webpubsub show

Отображение сведений о webpubsub.

 Расширение ГА
az webpubsub start

Запустите webpubsub.

 Расширение ГА
az webpubsub stop

Остановите webpubsub.

 Расширение ГА
az webpubsub update

Обновите webpubsub.

 Расширение ГА

az webpubsub create

Создайте webpubsub.

az webpubsub create --name
                    --resource-group
                    --sku
                    [--kind]
                    [--location]
                    [--service-mode]
                    [--tags]
                    [--unit-count]

Примеры

Создайте службу WebPubSub со стандартным номером SKU и единицей 2.

az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 2

Создайте web PubSub для Socket.IO с номером SKU premium и единицей 1.

az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Premium_P1 --unit-count 1 --kind SocketIO

Создание веб-pubSub для Socket.IO в бессерверном режиме с номером SKU уровня "Премиум" и единицей 1

az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Premium_P1 --unit-count 1 --kind SocketIO --service-mode Serverless

Обязательные параметры

--name -n

Имя webpubsub.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--sku

Имя SKU службы webpubsub. Допустимые значения: Free_F1, Standard_S1, Premium_P1.

Необязательные параметры

--kind

Тип службы webpubsub. Допустимые значения: WebPubSub, SocketIO.

--location -l

Местоположение. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--service-mode

Режим, используемый в типе: SocketIO. Допустимые значения: по умолчанию, бессерверные.

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--unit-count

Количество единиц службы webpubsub.

Default value: 1
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az webpubsub delete

Удаление webpubsub.

az webpubsub delete [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

--name -n

Имя webpubsub.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az webpubsub list

Список Webpubsub.

az webpubsub list [--resource-group]

Необязательные параметры

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az webpubsub list-skus

Список всех доступных номеров SKU ресурса.

az webpubsub list-skus [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

--name -n

Имя webpubsub.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az webpubsub list-usage

Вывод списка квот использования ресурсов по расположению.

az webpubsub list-usage --location

Обязательные параметры

--location -l

Местоположение. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az webpubsub restart

Перезапустите webpubsub.

az webpubsub restart [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

--name -n

Имя webpubsub.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az webpubsub show

Отображение сведений о webpubsub.

az webpubsub show [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

--name -n

Имя webpubsub.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az webpubsub start

Запустите webpubsub.

az webpubsub start [--ids]
                   [--name]
                   [--resource-group]
                   [--subscription]

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

--name -n

Имя webpubsub.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az webpubsub stop

Остановите webpubsub.

az webpubsub stop [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

Необязательные параметры

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

--name -n

Имя webpubsub.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

az webpubsub update

Обновите webpubsub.

az webpubsub update [--add]
                    [--client-cert-enabled {false, true}]
                    [--disable-local-auth {false, true}]
                    [--force-string]
                    [--ids]
                    [--name]
                    [--region-endpoint-enabled {false, true}]
                    [--remove]
                    [--resource-group]
                    [--service-mode]
                    [--set]
                    [--sku]
                    [--subscription]
                    [--tags]
                    [--unit-count]

Примеры

Обновите службу WebPubSub до единицы 10.

az webpubsub update -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 10

Обновите web PubSub для Socket.IO до бессерверного режима.

az webpubsub update -n MyWebPubSub -g MyResourceGroup --service-mode Serverless

Включение или отключение проверки подлинности сертификата клиента для службы WebPubSub

az webpubsub update -n MyWebPubSub -g MyResourceGroup --client-cert-enabled true

Включение или отключение локальной проверки подлинности для службы WebPubSub

az webpubsub update -n MyWebPubSub -g MyResourceGroup --disable-local-auth true

Включение или отключение конечной точки региона для службы WebPubSub

az webpubsub update -n MyWebPubSub -g MyResourceGroup --region-endpoint-enabled true

Необязательные параметры

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--client-cert-enabled

Включите или отключите проверку подлинности сертификата клиента для службы WebPubSub.

Допустимые значения: false, true
--disable-local-auth

Включите или отключите локальную проверку подлинности для службы WebPubSub.

Допустимые значения: false, true
--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Default value: False
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

--name -n

Имя webpubsub.

--region-endpoint-enabled

Включите или отключите конечную точку региона для службы WebPubSub.

Допустимые значения: false, true
--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--service-mode

Режим, используемый в типе: SocketIO. Допустимые значения: по умолчанию, бессерверные.

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Default value: []
--sku

Имя SKU службы webpubsub. Допустимые значения: Free_F1, Standard_S1, Premium_P1.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--unit-count

Количество единиц службы webpubsub.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.