Share via

az eventgrid topic key

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage shared access keys of a topic.

Commands

Name Description Type Status
az eventgrid topic key list

List shared access keys of a topic.

 Core GA
az eventgrid topic key list (eventgrid extension)

List shared access keys of a topic.

 Extension Preview
az eventgrid topic key regenerate

Regenerate a shared access key of a topic.

 Core GA
az eventgrid topic key regenerate (eventgrid extension)

Regenerate a shared access key of a topic.

 Extension Preview

az eventgrid topic key list

Edit

List shared access keys of a topic.

az eventgrid topic key list --name
                            --resource-group

Examples

List shared access keys of a topic (autogenerated)

az eventgrid topic key list --name MyTopic --resource-group MyResourceGroup

Required Parameters

--name -n

Name of the topic.

--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 eventgrid topic key list (eventgrid extension)

Preview

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

List shared access keys of a topic.

az eventgrid topic key list --name
                            --resource-group

Examples

List shared access keys of a topic (autogenerated)

az eventgrid topic key list --name MyTopic --resource-group MyResourceGroup

Required Parameters

--name -n

Name of the topic.

--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 eventgrid topic key regenerate

Edit

Regenerate a shared access key of a topic.

az eventgrid topic key regenerate --key-name
                                  --name
                                  --resource-group

Required Parameters

--key-name

Key name to regenerate key1 or key2.

--name -n

Name of the topic.

--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 eventgrid topic key regenerate (eventgrid extension)

Preview

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

Regenerate a shared access key of a topic.

az eventgrid topic key regenerate --key-name
                                  --name
                                  --resource-group

Required Parameters

--key-name

Key name to regenerate key1 or key2.

--name -n

Name of the topic.

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