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.

Commands

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

az webpubsub create

Create a Webpubsub.

az webpubsub create --name
                    --resource-group
                    --sku
                    [--kind]
                    [--location]
                    [--service-mode]
                    [--tags]
                    [--unit-count]

Examples

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

Required Parameters

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

--sku

The sku name of the webpubsub service. Allowed values: Free_F1, Standard_S1, Premium_P1.

Optional Parameters

--kind

The kind of the webpubsub service. Allowed values: WebPubSub, SocketIO.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--service-mode

The mode used in kind: SocketIO. Allowed values: Default, Serverless.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--unit-count

The number of webpubsub service unit count.

Default value: 1

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.

az webpubsub delete

Delete a Webpubsub.

az webpubsub delete [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]

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.

az webpubsub list

List Webpubsub.

az webpubsub list [--resource-group]

Optional Parameters

--resource-group -g

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

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.

az webpubsub list-skus

List all available skus of the resource.

az webpubsub list-skus [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

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.

az webpubsub list-usage

List resource usage quotas by location.

az webpubsub list-usage --location

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

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.

az webpubsub restart

Restart a Webpubsub.

az webpubsub restart [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

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.

az webpubsub show

Show details of a Webpubsub.

az webpubsub show [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

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.

az webpubsub start

Start a Webpubsub.

az webpubsub start [--ids]
                   [--name]
                   [--resource-group]
                   [--subscription]

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.

az webpubsub stop

Stop a Webpubsub.

az webpubsub stop [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

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.

az webpubsub update

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]

Examples

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

Optional Parameters

--add

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

Default value: []

--client-cert-enabled

Enable or disable client certificate authentication for a WebPubSub Service.

Accepted values: false, true

--disable-local-auth

Enable or disable local auth for a WebPubSub Service.

Accepted values: false, true

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Default value: False

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

--region-endpoint-enabled

Enable or disable region endpoint for a WebPubSub Service.

Accepted values: false, true

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Default value: []

--resource-group -g

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

--service-mode

The mode used in kind: SocketIO. Allowed values: Default, Serverless.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Default value: []

--sku

The sku name of the webpubsub service. Allowed values: Free_F1, Standard_S1, Premium_P1.

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--unit-count

The number of webpubsub service unit count.

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.