az webpubsub service connection
Note
This reference is part of the webpubsub extension for the Azure CLI (version 2.56.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
| Name | Description | Type | Status |
|---|---|---|---|
| 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 connection close
Close a specific client connection. Error throws if operation fails.
az webpubsub service connection close --connection-id
--hub-name
[--ids]
[--name]
[--resource-group]
[--subscription]Examples
Required Parameters
The connection id.
The hub to manage.
Optional Parameters
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 of the Webpubsub.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az webpubsub service connection exist
Check whether client connection exists.
az webpubsub service connection exist --connection-id
--hub-name
[--ids]
[--name]
[--resource-group]
[--subscription]Examples
Required Parameters
The connection id.
The hub to manage.
Optional Parameters
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 of the Webpubsub.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az webpubsub service connection send
Send a message to connection. Error throws if operation fails.
az webpubsub service connection send --connection-id
--hub-name
--payload
[--ids]
[--name]
[--resource-group]
[--subscription]Examples
Required Parameters
The connection id.
The hub to manage.
A string payload to send.
Optional Parameters
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 of the Webpubsub.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
