az webpubsub

  • Ссылка

Примечание.

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

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

Команды

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

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

 Расширение Общедоступная версия
az webpubsub client start

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

 Расширение Общедоступная версия
az webpubsub create

Создайте webpubsub.

 Расширение Общедоступная версия
az webpubsub delete

Удаление webpubsub.

 Расширение Общедоступная версия
az webpubsub hub

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

 Расширение Общедоступная версия
az webpubsub hub create

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

 Расширение Общедоступная версия
az webpubsub hub delete

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

 Расширение Общедоступная версия
az webpubsub hub list

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

 Расширение Общедоступная версия
az webpubsub hub show

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

 Расширение Общедоступная версия
az webpubsub hub update

Обновление параметров концентратора для службы 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 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 show

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

 Расширение Общедоступная версия
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 update

Обновите webpubsub.

 Расширение Общедоступная версия

az webpubsub create

Создайте webpubsub.

az webpubsub create --name
                    --resource-group
                    --sku
                    [--kind]
                    [--location]
                    [--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

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

--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

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

--tags

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

--unit-count

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

значение по умолчанию: 1
Глобальные параметры
--debug

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: 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
значение по умолчанию: 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
значение по умолчанию: 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
значение по умолчанию: 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

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

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

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

--help -h

Отображение этого справочного сообщения и выход.

--only-show-errors

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

--output -o

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

допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
значение по умолчанию: 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
значение по умолчанию: 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
значение по умолчанию: json
--query

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

--subscription

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

--verbose

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

az webpubsub update

Обновите webpubsub.

az webpubsub update [--add]
                    [--force-string]
                    [--ids]
                    [--name]
                    [--remove]
                    [--resource-group]
                    [--set]
                    [--sku]
                    [--subscription]
                    [--tags]
                    [--unit-count]

Примеры

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

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

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

--add

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

значение по умолчанию: []
--force-string

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

значение по умолчанию: False
--ids

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

--name -n

Имя webpubsub.

--remove

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

значение по умолчанию: []
--resource-group -g

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

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<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
значение по умолчанию: json
--query

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

--subscription

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

--verbose

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