az maps account keys

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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 --name
                           --key {primary, secondary}
                           --resource-group
                           [--acquire-policy-token]
                           [--change-reference]

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.

Property	Value
Accepted values:	primary, secondary

--resource-group -g

Resource group name.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

Feedback

Was this page helpful?