az webpubsub service

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

Commands to manage Webpubsub service.

Commands

az webpubsub service broadcast

Broadcast messages to hub. Error throws if operation fails.

az webpubsub service connection

Commands to manage Webpubsub service connections.

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 group

Commands to manage Webpubsub service groups.

az webpubsub service group add-connection

Add a connection to group. Error throws if operation fails.

az webpubsub service group add-user

Add a user to group. Error throws if operation fails.

az webpubsub service group remove-connection

Remove a connection from group. Error throws if operation fails.

az webpubsub service group remove-user

Remove a user from group. Error throws if operation fails.

az webpubsub service group send

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

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. Error throws if operation fails.

az webpubsub service permission revoke

Revoke a group permission from the connection. Error throws if operation fails.

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. Error throws if operation fails.

az webpubsub service broadcast

Broadcast messages to hub. Error throws if operation fails.

az webpubsub service broadcast --hub-name
                               --name
                               --payload
                               --resource-group

Examples

Send a message to hub

az webpubsub service broadcast -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --payload MyPayload

Required Parameters

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