Share via

az webpubsub

  • Preview
  • Reference

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.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage Webpubsub.

Commands

Name Description Type Status
az webpubsub create

Create a Webpubsub.

 Extension Preview
az webpubsub delete

Delete a Webpubsub.

 Extension Preview
az webpubsub event-handler

Commands to manage Webpubsub event handler settings.

 Extension Preview
az webpubsub event-handler clear

Clear event handler settings for WebPubSub Service.

 Extension Preview
az webpubsub event-handler hub

Commands to manage Webpubsub hub settings.

 Extension Preview
az webpubsub event-handler hub remove

Remove a hub's event handler settings.

 Extension Preview
az webpubsub event-handler hub update

Update a hub's event handler settings.

 Extension Preview
az webpubsub event-handler show

Show event handler settings for WebPubSub Service.

 Extension Preview
az webpubsub event-handler update

Update event handler settings for WebPubSub Service.

 Extension Preview
az webpubsub key

Commands to manage Webpubsub keys.

 Extension Preview
az webpubsub key regenerate

Regenerate keys for a WebPubSub Service.

 Extension Preview
az webpubsub key show

Show connetion strings and keys for a WebPubSub Service.

 Extension Preview
az webpubsub list

List Webpubsub.

 Extension Preview
az webpubsub network-rule

Commands to manage Webpubsub network rules.

 Extension Preview
az webpubsub network-rule show

Get the Network access control of WebPubSub Service.

 Extension Preview
az webpubsub network-rule update

Update the Network access control of WebPubSub Service.

 Extension Preview
az webpubsub restart

Restart a Webpubsub.

 Extension Preview
az webpubsub show

Show details of a Webpubsub.

 Extension Preview
az webpubsub update

Update a Webpubsub.

 Extension Preview

az webpubsub create

Preview

Command group 'webpubsub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

Preview

Command group 'webpubsub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

Preview

Command group 'webpubsub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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 restart

Preview

Command group 'webpubsub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

Preview

Command group 'webpubsub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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 update

Preview

Command group 'webpubsub' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a Webpubsub.

az webpubsub update [--add]
                    [--force-string]
                    [--ids]
                    [--name]
                    [--remove]
                    [--resource-group]
                    [--set]
                    [--sku {Free_F1, Standard_S1}]
                    [--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

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: []
--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.

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

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

Accepted values: Free_F1, Standard_S1
--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 signalr 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.