az webpubsub service connection

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 connection command. Learn more about extensions.

Commands to manage Webpubsub service connections.

Commands

az webpubsub service connection close

Close a specific client connection. Error throws if operation fails.

az webpubsub service connection exist

Check whether client connection exists.

az webpubsub service connection send

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

az webpubsub service connection close

Close a specific client connection. Error throws if operation fails.

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

Required Parameters

--connection-id

The connection id.

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

Check whether client connection exists.

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

Required Parameters

--connection-id

The connection id.

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

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

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

Required Parameters

--connection-id

The connection id.

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