az maps account

Manage Azure Maps accounts.

Commands

Name	Description	Type	Status
az maps account create	Create a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.	Core	GA
az maps account delete	Delete a Maps Account.	Core	GA
az maps account keys	Manage Azure Maps account keys.	Core	GA
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 list	Show all maps accounts in a subscription or in a resource group.	Core	GA
az maps account show	Show the details of a maps account.	Core	GA
az maps account update	Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties.	Core	GA

az maps account create

Create a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.

az maps account create --account-name --name
                       --resource-group
                       --sku {G2, S0, S1}
                       [--accept-tos]
                       [--disable-local-auth {false, true}]
                       [--kind {Gen1, Gen2}]
                       [--linked-resources]
                       [--tags]
                       [--type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                       [--user-identities]

Examples

Create Account with Managed Identities

az maps account create --type "SystemAssigned, UserAssigned" --user-identities "{\"/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName\":{}}" --kind "Gen2" --disable-local-auth false --linked-resources id="/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/mystorageacc" unique-name="myBatchStorageAccount" --linked-resources id="/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.Storage/accounts/mystorageacc" unique-name="myBlobDataSource" --tags test="true" --account-name "myMapsAccount" --resource-group "myResourceGroup" --sku "S0"

Create Gen1 Account

az maps account create --kind "Gen1" --disable-local-auth false --tags test="true" --account-name "myMapsAccount" --resource-group "myResourceGroup" --sku "S0"

Create Gen2 Account

az maps account create --kind "Gen2" --disable-local-auth true --tags test="true" --account-name "myMapsAccount" --resource-group "myResourceGroup" --sku "S0"

Required Parameters

--account-name --name -n

The name of the maps account.

--resource-group -g

Resource group name.

--sku -s

The name of the SKU, in standard format (such as S0).

Property	Value
Parameter group:	Sku Arguments
Accepted values:	G2, S0, S1

Optional Parameters

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

--accept-tos

You must agree to the License and Privacy Statement to create an account.

--disable-local-auth

Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys authentication from any usage.

Property	Value
Accepted values:	false, true

--kind

Get or Set Kind property.

Property	Value
Accepted values:	Gen1, Gen2

--linked-resources

Sets the resources to be used for Managed Identities based operations for the Map account resource.

Usage: --linked-resources unique-name=XX id=XX

unique-name: Required. A provided name which uniquely identifies the linked resource. id: Required. ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}'.

Multiple actions can be specified by using more than one --linked-resources argument.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--type

The identity type.

Property	Value
Parameter group:	Identity Arguments
Accepted values:	None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned

--user-identities

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Expected value: json-string/@json-file.

Property	Value
Parameter group:	Identity 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

az maps account delete

Delete a Maps Account.

az maps account delete [--account-name --name]
                       [--ids]
                       [--resource-group]
                       [--subscription]

Examples

DeleteAccount

az maps account delete --name "myMapsAccount" --resource-group "myResourceGroup"

Optional Parameters

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

--account-name --name -n

The name of the maps account.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Resource group name.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az maps account list

Show all maps accounts in a subscription or in a resource group.

az maps account list [--resource-group]

Optional Parameters

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

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

Show the details of a maps account.

az maps account show [--account-name --name]
                     [--ids]
                     [--resource-group]
                     [--subscription]

Examples

Show the details of a maps account. (autogenerated)

az maps account show --name MyMapsAccount --resource-group MyResourceGroup

Optional Parameters

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

--account-name --name -n

The name of the maps account.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Resource group name.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az maps account update

Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties.

az maps account update --sku {G2, S0, S1}
                       [--account-name --name]
                       [--disable-local-auth {false, true}]
                       [--ids]
                       [--kind {Gen1, Gen2}]
                       [--linked-resources]
                       [--resource-group]
                       [--subscription]
                       [--tags]
                       [--type {None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned}]
                       [--user-identities]

Examples

Update Account Managed Identities

az maps account update --type "SystemAssigned, UserAssigned" --user-identities "{\"/subscriptions/21a9967a-e8a9-4656-a70b-96ff1c4d05a0/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName\":{}}" --kind "Gen2" --linked-resources id="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}" unique-name="myBatchStorageAccount" --account-name "myMapsAccount" --resource-group "myResourceGroup" --sku "S1"

Update Account Tags

az maps account update --tags specialTag="true" --account-name "myMapsAccount" --resource-group "myResourceGroup" --sku "S0"

Update to Gen1 Account

az maps account update --kind "Gen1" --account-name "myMapsAccount" --resource-group "myResourceGroup" --sku "S0"

Update to Gen2 Account

az maps account update --kind "Gen2" --account-name "myMapsAccount" --resource-group "myResourceGroup" --sku "S0"

Required Parameters

--sku -s

The name of the SKU, in standard format (such as S0).

Property	Value
Parameter group:	Sku Arguments
Accepted values:	G2, S0, S1

Optional Parameters

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

--account-name --name -n

The name of the maps account.

Property	Value
Parameter group:	Resource Id Arguments

--disable-local-auth

Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys authentication from any usage.

Property	Value
Accepted values:	false, true

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

Property	Value
Parameter group:	Resource Id Arguments

--kind

Get or Set Kind property.

Property	Value
Accepted values:	Gen1, Gen2

--linked-resources

Sets the resources to be used for Managed Identities based operations for the Map account resource.

Usage: --linked-resources unique-name=XX id=XX

unique-name: Required. A provided name which uniquely identifies the linked resource. id: Required. ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}'.

Multiple actions can be specified by using more than one --linked-resources argument.

--resource-group -g

Resource group name.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

--type

The identity type.

Property	Value
Parameter group:	Identity Arguments
Accepted values:	None, SystemAssigned, SystemAssigned, UserAssigned, UserAssigned

--user-identities

The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Expected value: json-string/@json-file.

Property	Value
Parameter group:	Identity 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False