az webpubsub

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

Commands to manage Webpubsub.

Commands

az webpubsub client

Commands to manage client connections.

az webpubsub client start

Start a interactive client connection.

az webpubsub create

Create a Webpubsub.

az webpubsub delete

Delete a Webpubsub.

az webpubsub event-handler

Commands to manage Webpubsub event handler settings.

az webpubsub event-handler clear

Clear event handler settings for WebPubSub Service.

az webpubsub event-handler hub

Commands to manage Webpubsub hub settings.

az webpubsub event-handler hub remove

Remove a hub's event handler settings.

az webpubsub event-handler hub update

Update a hub's event handler settings.

az webpubsub event-handler show

Show event handler settings for WebPubSub Service.

az webpubsub event-handler update

Update event handler settings for WebPubSub Service.

az webpubsub key

Commands to manage Webpubsub keys.

az webpubsub key regenerate

Regenerate keys for a WebPubSub Service.

az webpubsub key show

Show connetion strings and keys for a WebPubSub Service.

az webpubsub list

List Webpubsub.

az webpubsub network-rule

Commands to manage Webpubsub network rules.

az webpubsub network-rule show

Get the Network access control of WebPubSub Service.

az webpubsub network-rule update

Update the Network access control of WebPubSub Service.

az webpubsub restart

Restart a Webpubsub.

az webpubsub service

Commands to manage Webpubsub service.

az webpubsub service broadcast

Broadcast messages to hub.

az webpubsub service connection

Commands to manage Webpubsub service connections.

az webpubsub service connection close

Close a specific client connection.

az webpubsub service connection exist

Check whether client connection exists.

az webpubsub service connection send

Send a message to connection.

az webpubsub service group

Commands to manage Webpubsub service groups.

az webpubsub service group add-connection

Add a connection to group.

az webpubsub service group add-user

Add a user to group.

az webpubsub service group remove-connection

Remove a connection from group.

az webpubsub service group remove-user

Remove a user from group.

az webpubsub service group send

Send a message to group.

az webpubsub service permission

Commands to manage Webpubsub service permissions.

az webpubsub service permission check

Check if a connection has permission to the specified group.

az webpubsub service permission grant

Grant a group permission to the connection.

az webpubsub service permission revoke

Revoke a group permission from the connection.

az webpubsub service user

Commands to manage Webpubsub service users.

az webpubsub service user exist

Check if there are any client connections connected for the given user.

az webpubsub service user send

Send a message to user.

az webpubsub show

Show details of a Webpubsub.

az webpubsub update

Update a Webpubsub.

az webpubsub create

Create a Webpubsub.

az webpubsub create --name
                    --resource-group
                    --sku {Free_F1, Standard_S1}
                    [--location]
                    [--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

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

accepted values: Free_F1, Standard_S1

Optional Parameters

--location -l

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

--tags

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

--unit-count

The number of signalr service unit count.

default value: 1

az webpubsub delete

Delete a Webpubsub.

az webpubsub delete --name
                    --resource-group

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

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

az webpubsub restart

Restart a Webpubsub.

az webpubsub restart --name
                     --resource-group

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

az webpubsub show

Show details of a Webpubsub.

az webpubsub show --name
                  --resource-group

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

az webpubsub update

Update a Webpubsub.

az webpubsub update --name
                    --resource-group
                    [--add]
                    [--force-string]
                    [--remove]
                    [--set]
                    [--sku {Free_F1, Standard_S1}]
                    [--tags]
                    [--unit-count]

Examples

Update a WebPubSub Service to unit 10.

az webpubsub update -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 10

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

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

--force-string

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

--remove

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

--set

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

--sku

The sku name of the signalr service.

accepted values: Free_F1, Standard_S1
--tags

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

--unit-count

The number of signalr service unit count.