az webpubsub service

Reference

Note

This reference is part of the webpubsub extension for the Azure CLI (version 2.39.0 or higher). The extension will automatically install the first time you run an az webpubsub service command. Learn more about extensions.

Commands to manage Webpubsub service.

Commands

Name	Description	Type	Status
az webpubsub service broadcast	Broadcast messages to hub. Error throws if operation fails.	Extension	GA
az webpubsub service connection	Commands to manage Webpubsub service connections.	Extension	GA
az webpubsub service connection close	Close a specific client connection. Error throws if operation fails.	Extension	GA
az webpubsub service connection exist	Check whether client connection exists.	Extension	GA
az webpubsub service connection send	Send a message to connection. Error throws if operation fails.	Extension	GA
az webpubsub service group	Commands to manage Webpubsub service groups.	Extension	GA
az webpubsub service group add-connection	Add a connection to group. Error throws if operation fails.	Extension	GA
az webpubsub service group add-user	Add a user to group. Error throws if operation fails.	Extension	GA
az webpubsub service group remove-connection	Remove a connection from group. Error throws if operation fails.	Extension	GA
az webpubsub service group remove-user	Remove a user from group. Error throws if operation fails.	Extension	GA
az webpubsub service group send	Send a message to group. Error throws if operation fails.	Extension	GA
az webpubsub service permission	Commands to manage Webpubsub service permissions.	Extension	GA
az webpubsub service permission check	Check if a connection has permission to the specified group.	Extension	GA
az webpubsub service permission grant	Grant a group permission to the connection. Error throws if operation fails.	Extension	GA
az webpubsub service permission revoke	Revoke a group permission from the connection. Error throws if operation fails.	Extension	GA
az webpubsub service user	Commands to manage Webpubsub service users.	Extension	GA
az webpubsub service user exist	Check if there are any client connections connected for the given user.	Extension	GA
az webpubsub service user send	Send a message to user. Error throws if operation fails.	Extension	GA

az webpubsub service broadcast

Broadcast messages to hub. Error throws if operation fails.

az webpubsub service broadcast --hub-name
                               --payload
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

Examples

Send a message to hub

az webpubsub service broadcast -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --payload MyPayload

Required Parameters

--hub-name

The hub to manage.

--payload

A string payload to send.

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Webpubsub.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.