accounts

Creates, updates, deletes, gets or lists an accounts resource.

Overview

Name	accounts
Type	Resource
Id	azure.maps.accounts

Fields

The following fields are returned by SELECT queries:

list_sas

Name	Datatype	Description
accountSasToken	string	The shared access signature access token.

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
cors	object	Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service.
disableLocalAuth	boolean	Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys and Shared Access Signature Token authentication from any usage.
encryption	object	All encryption configuration for a resource.
identity	object	The managed service identities assigned to this resource.
kind	string	Get or Set Kind property. "Gen2" (Gen2)
linkedResources	array	The array of associated resources to the Maps account. Linked resource in the array cannot individually update, you must update all linked resources in the array together. These resources may be used on operations on the Azure Maps REST API. Access is controlled by the Maps Account Managed Identity(s) permissions to those resource(s).
location	string	The geo-location where the resource lives. Required.
locations	array	List of additional data processing regions for the Maps Account, which may result in requests being processed in another geography. Some features or results may be restricted to specific regions. By default, Maps REST APIs process requests according to the account location or the geographic scope _.
privateEndpointConnections	array	List of private endpoint connections associated with the Maps Account.
provisioningState	string	The provisioning state of the Maps account resource, Account updates can only be performed on terminal states. Terminal states: Succeeded and Failed.
publicNetworkAccess	string	Property to specify whether the Maps Account will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. Known values are: "enabled" and "disabled". (enabled, disabled)
sku	object	The SKU of this account. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uniqueId	string	A unique identifier for the Maps Account.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
cors	object	Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service.
disableLocalAuth	boolean	Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys and Shared Access Signature Token authentication from any usage.
encryption	object	All encryption configuration for a resource.
identity	object	The managed service identities assigned to this resource.
kind	string	Get or Set Kind property. "Gen2" (Gen2)
linkedResources	array	The array of associated resources to the Maps account. Linked resource in the array cannot individually update, you must update all linked resources in the array together. These resources may be used on operations on the Azure Maps REST API. Access is controlled by the Maps Account Managed Identity(s) permissions to those resource(s).
location	string	The geo-location where the resource lives. Required.
locations	array	List of additional data processing regions for the Maps Account, which may result in requests being processed in another geography. Some features or results may be restricted to specific regions. By default, Maps REST APIs process requests according to the account location or the geographic scope _.
privateEndpointConnections	array	List of private endpoint connections associated with the Maps Account.
provisioningState	string	The provisioning state of the Maps account resource, Account updates can only be performed on terminal states. Terminal states: Succeeded and Failed.
publicNetworkAccess	string	Property to specify whether the Maps Account will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. Known values are: "enabled" and "disabled". (enabled, disabled)
sku	object	The SKU of this account. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uniqueId	string	A unique identifier for the Maps Account.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
cors	object	Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service.
disableLocalAuth	boolean	Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys and Shared Access Signature Token authentication from any usage.
encryption	object	All encryption configuration for a resource.
identity	object	The managed service identities assigned to this resource.
kind	string	Get or Set Kind property. "Gen2" (Gen2)
linkedResources	array	The array of associated resources to the Maps account. Linked resource in the array cannot individually update, you must update all linked resources in the array together. These resources may be used on operations on the Azure Maps REST API. Access is controlled by the Maps Account Managed Identity(s) permissions to those resource(s).
location	string	The geo-location where the resource lives. Required.
locations	array	List of additional data processing regions for the Maps Account, which may result in requests being processed in another geography. Some features or results may be restricted to specific regions. By default, Maps REST APIs process requests according to the account location or the geographic scope _.
privateEndpointConnections	array	List of private endpoint connections associated with the Maps Account.
provisioningState	string	The provisioning state of the Maps account resource, Account updates can only be performed on terminal states. Terminal states: Succeeded and Failed.
publicNetworkAccess	string	Property to specify whether the Maps Account will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. Known values are: "enabled" and "disabled". (enabled, disabled)
sku	object	The SKU of this account. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uniqueId	string	A unique identifier for the Maps Account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_sas	select	resource_group_name, account_name, subscription_id		Create and list an account shared access signature token. Use this SAS token for authentication to Azure Maps REST APIs through various Azure Maps SDKs. As prerequisite to create a SAS Token. Prerequisites: 1. Create or have an existing User Assigned Managed Identity in the same Azure region as the account. 2. Create or update an Azure Maps account with the same Azure region as the User Assigned Managed Identity is placed.
get	select	resource_group_name, account_name, subscription_id		Get a Maps Account.
list_by_resource_group	select	resource_group_name, subscription_id		Get all Maps Accounts in a Resource Group.
list_by_subscription	select	subscription_id		Get all Maps Accounts in a Subscription.
create_or_update	insert	resource_group_name, account_name, subscription_id, location, sku		Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.
update	update	resource_group_name, account_name, subscription_id		Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties.
create_or_update	replace	resource_group_name, account_name, subscription_id, location, sku		Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.
delete	delete	resource_group_name, account_name, subscription_id		Delete a Maps Account.
list_keys	exec	resource_group_name, account_name, subscription_id		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.
regenerate_keys	exec	resource_group_name, account_name, subscription_id, keyType		Regenerate either the primary or secondary key for use with the Maps APIs. The old key will stop working immediately.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_name	string	The name of the Maps Account. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

list_sas

Create and list an account shared access signature token. Use this SAS token for authentication to Azure Maps REST APIs through various Azure Maps SDKs. As prerequisite to create a SAS Token. Prerequisites: 1. Create or have an existing User Assigned Managed Identity in the same Azure region as the account. 2. Create or update an Azure Maps account with the same Azure region as the User Assigned Managed Identity is placed.

SELECT
accountSasToken
FROM azure.maps.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get a Maps Account.

SELECT
id,
name,
cors,
disableLocalAuth,
encryption,
identity,
kind,
linkedResources,
location,
locations,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type,
uniqueId
FROM azure.maps.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get all Maps Accounts in a Resource Group.

SELECT
id,
name,
cors,
disableLocalAuth,
encryption,
identity,
kind,
linkedResources,
location,
locations,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type,
uniqueId
FROM azure.maps.accounts
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Get all Maps Accounts in a Subscription.

SELECT
id,
name,
cors,
disableLocalAuth,
encryption,
identity,
kind,
linkedResources,
location,
locations,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type,
uniqueId
FROM azure.maps.accounts
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

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

INSERT INTO azure.maps.accounts (
tags,
location,
properties,
sku,
kind,
identity,
resource_group_name,
account_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}' /* required */,
'{{ kind }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: accounts
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the accounts resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the accounts resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the accounts resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The map account properties.
    value:
      uniqueId: "{{ uniqueId }}"
      disableLocalAuth: {{ disableLocalAuth }}
      provisioningState: "{{ provisioningState }}"
      linkedResources:
        - uniqueName: "{{ uniqueName }}"
          id: "{{ id }}"
      cors:
        corsRules:
          - allowedOrigins: "{{ allowedOrigins }}"
      encryption:
        infrastructureEncryption: "{{ infrastructureEncryption }}"
        customerManagedKeyEncryption:
          keyEncryptionKeyIdentity:
            identityType: "{{ identityType }}"
            userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
            federatedClientId: "{{ federatedClientId }}"
            delegatedIdentityClientId: "{{ delegatedIdentityClientId }}"
          keyEncryptionKeyUrl: "{{ keyEncryptionKeyUrl }}"
      locations:
        - locationName: "{{ locationName }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            groupIds:
              - "{{ groupIds }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
  - name: sku
    description: |
      The SKU of this account. Required.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      Get or Set Kind property. "Gen2"
    valid_values: ['Gen2']
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

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

UPDATE azure.maps.accounts
SET 
tags = '{{ tags }}',
kind = '{{ kind }}',
sku = '{{ sku }}',
identity = '{{ identity }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure.maps.accounts
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
sku = '{{ sku }}',
kind = '{{ kind }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND sku = '{{ sku }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Delete a Maps Account.

DELETE FROM azure.maps.accounts
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_keys

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.

EXEC azure.maps.accounts.list_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_keys

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

EXEC azure.maps.accounts.regenerate_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;