Share via

az maps account keys

  • Reference

Manage Azure Maps account keys.

Commands

Name Description Type Status
az maps account keys list

Get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.

 Core GA
az maps account keys renew

Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.

 Core GA

az maps account keys list

Edit

Get the keys to use with the Maps APIs. A key is used to authenticate and authorize access to the Maps REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.

az maps account keys list --account-name
                          --resource-group

Examples

List Keys

az maps account keys list --name "myMapsAccount" --resource-group "myResourceGroup"

Required Parameters

--account-name --name -n

The name of the maps account.

--resource-group -g

Resource 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 maps account keys renew

Edit

Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.

az maps account keys renew --account-name
                           --key {primary, secondary}
                           --resource-group

Examples

Renew

az maps account keys renew --name "myMapsAccount" --key "primary" --resource-group "myResourceGroup"

Required Parameters

--account-name --name -n

The name of the maps account.

--key

Whether the operation refers to the primary or secondary key.

Accepted values: primary, secondary
--resource-group -g

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