Share via

az webpubsub event-handler hub

  • 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 event-handler hub command. Learn more about extensions.

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

Commands to manage Webpubsub hub settings.

Commands

Name Description Type Status
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 hub remove

Preview

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

Remove a hub's event handler settings.

az webpubsub event-handler hub remove --hub-name
                                      [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

Examples

Remove all event handler settings in a hub

az webpubsub event-handler hub remove -n MyWebPubSub -g MyResourceGroup --hub-name MyHub

Required Parameters

--hub-name

The hub whose event handler settings need to delete.

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 event-handler hub update

Preview

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

Update a hub's event handler settings.

az webpubsub event-handler hub update --hub-name
                                      --template
                                      [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]

Examples

Update two event handler settings in a hub

az webpubsub event-handler hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --template url-template='http://host.com user-event-pattern="MyEvent" --template url-template="http://host2.com" system-event-pattern="connect"'

Required Parameters

--hub-name

The hub whose event handler settings need to delete.

--template

Template item for event handler settings. Use key=value pattern to set properties. Supported keys are "url-template", "user-event-pattern", "system-event-pattern".

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.