az webpubsub
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 command. Learn more about extensions.
Commands to manage Webpubsub.
Name | Description | Type | Status |
---|---|---|---|
az webpubsub client |
Commands to manage client connections. |
Extension | GA |
az webpubsub client start |
Start a interactive client connection. |
Extension | GA |
az webpubsub create |
Create a Webpubsub. |
Extension | GA |
az webpubsub custom-certificate |
Manage WebPubSub custom certificates. |
Extension | GA |
az webpubsub custom-certificate create |
Create a custom certificate of WebPubSub Service. |
Extension | GA |
az webpubsub custom-certificate delete |
Delete a custom certificate of WebPubSub Service. |
Extension | GA |
az webpubsub custom-certificate list |
List custom certificates of WebPubSub Service. |
Extension | GA |
az webpubsub custom-certificate show |
Show the detail of a custom certificate of WebPubSub Service. |
Extension | GA |
az webpubsub custom-domain |
Manage custom domain settings. |
Extension | GA |
az webpubsub custom-domain create |
Create a custom domain of WebPubSub Service. |
Extension | GA |
az webpubsub custom-domain delete |
Delete a custom domain of WebPubSub Service. |
Extension | GA |
az webpubsub custom-domain list |
List custom domains of WebPubSub Service. |
Extension | GA |
az webpubsub custom-domain show |
Show the detail of a custom domain of WebPubSub Service. |
Extension | GA |
az webpubsub delete |
Delete a Webpubsub. |
Extension | GA |
az webpubsub hub |
Commands to manage Webpubsub hub settings. |
Extension | GA |
az webpubsub hub create |
Create hub settings for WebPubSub Service or Web PubSub for Socket.IO in Serverless Mode. |
Extension | GA |
az webpubsub hub delete |
Delete hub settings for WebPubSub Service. |
Extension | GA |
az webpubsub hub list |
List all hub settings for WebPubSub Service. |
Extension | GA |
az webpubsub hub show |
Show hub settings for WebPubSub Service. |
Extension | GA |
az webpubsub hub update |
Update hub settings for WebPubSub Service or Web PubSub for Socket.IO in Serverless Mode. |
Extension | GA |
az webpubsub identity |
Manage managed identity settings. |
Extension | GA |
az webpubsub identity assign |
Assign managed identity for WebPubSub Service. |
Extension | GA |
az webpubsub identity remove |
Remove managed identity for WebPubSub Service. |
Extension | GA |
az webpubsub identity show |
Show managed identity for WebPubSub Service. |
Extension | GA |
az webpubsub key |
Commands to manage Webpubsub keys. |
Extension | GA |
az webpubsub key regenerate |
Regenerate keys for a WebPubSub Service. |
Extension | GA |
az webpubsub key show |
Show connetion strings and keys for a WebPubSub Service. |
Extension | GA |
az webpubsub list |
List Webpubsub. |
Extension | GA |
az webpubsub list-skus |
List all available skus of the resource. |
Extension | GA |
az webpubsub list-usage |
List resource usage quotas by location. |
Extension | GA |
az webpubsub network-rule |
Commands to manage Webpubsub network rules. |
Extension | GA |
az webpubsub network-rule ip-rule |
Manage WebPubSub Service IP rules. |
Extension | GA |
az webpubsub network-rule ip-rule add |
Add IP rule to WebPubSub Service. |
Extension | GA |
az webpubsub network-rule ip-rule remove |
Remove IP rule from WebPubSub Service. |
Extension | GA |
az webpubsub network-rule show |
Get the Network access control of WebPubSub Service. |
Extension | GA |
az webpubsub network-rule update |
Update the Network access control of WebPubSub Service. |
Extension | GA |
az webpubsub replica |
Manage replica settings. |
Extension | GA |
az webpubsub replica create |
Create a replica of Webpubsub Service. |
Extension | GA |
az webpubsub replica delete |
Delete a replica of WebPubSub Service. |
Extension | GA |
az webpubsub replica list |
List replicas of Webpubsub Service. |
Extension | GA |
az webpubsub replica restart |
Restart a replica of WebPubSub Service. |
Extension | GA |
az webpubsub replica show |
Show the details of a replica. |
Extension | GA |
az webpubsub replica start |
Start a replica of WebPubSub Service. |
Extension | GA |
az webpubsub replica stop |
Stop a replica of WebPubSub Service. |
Extension | GA |
az webpubsub replica update |
Update a replica of Webpubsub Service. |
Extension | GA |
az webpubsub restart |
Restart a Webpubsub. |
Extension | GA |
az webpubsub service |
Commands to manage Webpubsub service. |
Extension | GA |
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 show |
Show details of a Webpubsub. |
Extension | GA |
az webpubsub start |
Start a Webpubsub. |
Extension | GA |
az webpubsub stop |
Stop a Webpubsub. |
Extension | GA |
az webpubsub update |
Update a Webpubsub. |
Extension | GA |
Create a Webpubsub.
az webpubsub create --name
--resource-group
--sku
[--kind]
[--location]
[--service-mode]
[--tags]
[--unit-count]
Create a WebPubSub Service with Standard SKU and unit 2.
az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 2
Create a Web PubSub for Socket.IO with Premium SKU and unit 1.
az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Premium_P1 --unit-count 1 --kind SocketIO
Create a Web PubSub for Socket.IO in Serverless mode with Premium SKU and unit 1
az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Premium_P1 --unit-count 1 --kind SocketIO --service-mode Serverless
Name of the webpubsub.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The sku name of the webpubsub service. Allowed values: Free_F1, Standard_S1, Premium_P1.
The kind of the webpubsub service. Allowed values: WebPubSub, SocketIO.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
The mode used in kind: SocketIO. Allowed values: Default, Serverless.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The number of webpubsub service unit count.
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.
Delete a Webpubsub.
az webpubsub delete [--ids]
[--name]
[--resource-group]
[--subscription]
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.
List Webpubsub.
az webpubsub list [--resource-group]
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
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.
List all available skus of the resource.
az webpubsub list-skus [--ids]
[--name]
[--resource-group]
[--subscription]
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.
List resource usage quotas by location.
az webpubsub list-usage --location
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
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.
Restart a Webpubsub.
az webpubsub restart [--ids]
[--name]
[--resource-group]
[--subscription]
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.
Show details of a Webpubsub.
az webpubsub show [--ids]
[--name]
[--resource-group]
[--subscription]
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.
Start a Webpubsub.
az webpubsub start [--ids]
[--name]
[--resource-group]
[--subscription]
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.
Stop a Webpubsub.
az webpubsub stop [--ids]
[--name]
[--resource-group]
[--subscription]
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.
Update a Webpubsub.
az webpubsub update [--add]
[--client-cert-enabled {false, true}]
[--disable-local-auth {false, true}]
[--force-string]
[--ids]
[--name]
[--region-endpoint-enabled {false, true}]
[--remove]
[--resource-group]
[--service-mode]
[--set]
[--sku]
[--subscription]
[--tags]
[--unit-count]
Update a WebPubSub Service to unit 10.
az webpubsub update -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 10
Update a Web PubSub for Socket.IO to Serverless mode.
az webpubsub update -n MyWebPubSub -g MyResourceGroup --service-mode Serverless
Enable or disable client certificate authentication for a WebPubSub Service
az webpubsub update -n MyWebPubSub -g MyResourceGroup --client-cert-enabled true
Enable or disable local auth for a WebPubSub Service
az webpubsub update -n MyWebPubSub -g MyResourceGroup --disable-local-auth true
Enable or disable region endpoint for a WebPubSub Service
az webpubsub update -n MyWebPubSub -g MyResourceGroup --region-endpoint-enabled true
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>
.
Enable or disable client certificate authentication for a WebPubSub Service.
Enable or disable local auth for a WebPubSub Service.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
Enable or disable region endpoint for a WebPubSub Service.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The mode used in kind: SocketIO. Allowed values: Default, Serverless.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
The sku name of the webpubsub service. Allowed values: Free_F1, Standard_S1, Premium_P1.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
The number of webpubsub service unit count.
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.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: