Share via

az webpubsub event-handler

  • 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 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 event handler settings.

Commands

Name Description Type Status
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 event-handler clear

Preview

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

Clear event handler settings for WebPubSub Service.

az webpubsub event-handler clear [--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 event-handler show

Preview

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

Show event handler settings for WebPubSub Service.

az webpubsub event-handler 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 event-handler update

Preview

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

Update event handler settings for WebPubSub Service.

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

Examples

Update event handler to handler connect event.

az webpubsub event-handler update -n MyWebPubSub -g MyResourceGroup --items '{"myHub": [{"urlTemplate": "http://host.com", "systemEventPattern": "connect"}]}'

Required Parameters

--items

A JSON-formatted string containing event handler items.

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.