Share via

az webpubsub key

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

Commands to manage Webpubsub keys.

Commands

Name Description Type Status
az webpubsub key regenerate

Regenerate keys for a WebPubSub Service.

 Extension GA
az webpubsub key show

Show connetion strings and keys for a WebPubSub Service.

 Extension GA

az webpubsub key regenerate

Regenerate keys for a WebPubSub Service.

az webpubsub key regenerate --key-type {primary, salt, secondary}
                            [--ids]
                            [--name]
                            [--resource-group]
                            [--subscription]

Examples

Regenerate the primary key for a WebPubSub Service.

az webpubsub key regenerate -n MyWebPubSub -g MyResourceGroup --key-type primary --query primaryKey -o tsv

Required Parameters

--key-type

The name of access key to regenerate.

Accepted values: primary, salt, secondary

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

Show connetion strings and keys for a WebPubSub Service.

az webpubsub key show [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]

Examples

Get the primary key for a WebPubSub Service.

az webpubsub key show -n MyWebPubSub -g MyResourceGroup --query primaryKey -o tsv

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.