az webpubsub service group

Note

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

Commands to manage Webpubsub service groups.

Commands

az webpubsub service group add-connection

Add a connection to group. Error throws if operation fails.

az webpubsub service group add-user

Add a user to group. Error throws if operation fails.

az webpubsub service group remove-connection

Remove a connection from group. Error throws if operation fails.

az webpubsub service group remove-user

Remove a user from group. Error throws if operation fails.

az webpubsub service group send

Send a message to group. Error throws if operation fails.

az webpubsub service group add-connection

Add a connection to group. Error throws if operation fails.

az webpubsub service group add-connection --connection-id
                                          --group-name
                                          --hub-name
                                          --name
                                          --resource-group

Required Parameters

--connection-id

The connection id.

--group-name

The group name.

--hub-name

The hub to manage.

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

az webpubsub service group add-user

Add a user to group. Error throws if operation fails.

az webpubsub service group add-user --group-name
                                    --hub-name
                                    --name
                                    --resource-group
                                    --user-id

Required Parameters

--group-name

The group name.

--hub-name

The hub to manage.

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

--user-id

The user id.

az webpubsub service group remove-connection

Remove a connection from group. Error throws if operation fails.

az webpubsub service group remove-connection --connection-id
                                             --group-name
                                             --hub-name
                                             --name
                                             --resource-group

Required Parameters

--connection-id

The connection id.

--group-name

The group name.

--hub-name

The hub to manage.

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

az webpubsub service group remove-user

Remove a user from group. Error throws if operation fails.

az webpubsub service group remove-user --hub-name
                                       --name
                                       --resource-group
                                       --user-id
                                       [--group-name]

Required Parameters

--hub-name

The hub to manage.

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

--user-id

The user id.

Optional Parameters

--group-name

The group name.

az webpubsub service group send

Send a message to group. Error throws if operation fails.

az webpubsub service group send --group-name
                                --hub-name
                                --name
                                --payload
                                --resource-group

Required Parameters

--group-name

The group name.

--hub-name

The hub to manage.

--name -n

Name of the Webpubsub.

--payload

A string payload to send.

--resource-group -g

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