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:

get

The request was successful.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	Get or Set Kind property.
location	string	The geo-location where the resource lives
properties	object	The map account properties.
sku	object	The SKU of this account.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_resource_group

The request was successful.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	Get or Set Kind property.
location	string	The geo-location where the resource lives
properties	object	The map account properties.
sku	object	The SKU of this account.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list_by_subscription

The request was successful.

Name	Datatype	Description
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	Get or Set Kind property.
location	string	The geo-location where the resource lives
properties	object	The map account properties.
sku	object	The SKU of this account.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName		Get a Maps Account.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get all Maps Accounts in a Resource Group
list_by_subscription	select	subscriptionId		Get all Maps Accounts in a Subscription
create_or_update	insert	subscriptionId, resourceGroupName, accountName, data__sku		Create or update a Maps Account. A Maps Account holds the keys which allow access to the Maps REST APIs.
update	update	subscriptionId, resourceGroupName, accountName		Updates a Maps Account. Only a subset of the parameters may be updated after creation, such as Sku, Tags, Properties.
delete	delete	subscriptionId, resourceGroupName, accountName		Delete a Maps Account.
regenerate_keys	exec	subscriptionId, resourceGroupName, accountName, 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
accountName	string	The name of the Maps Account.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a Maps Account.

SELECT
identity,
kind,
location,
properties,
sku,
systemData,
tags
FROM azure.maps.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

list_by_resource_group

Get all Maps Accounts in a Resource Group

SELECT
identity,
kind,
location,
properties,
sku,
systemData,
tags
FROM azure.maps.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Get all Maps Accounts in a Subscription

SELECT
identity,
kind,
location,
properties,
sku,
systemData,
tags
FROM azure.maps.accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- 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 (
data__sku,
data__kind,
data__identity,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
accountName
)
SELECT 
'{{ sku }}' /* required */,
'{{ kind }}',
'{{ identity }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}'
RETURNING
identity,
kind,
location,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: accounts
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the accounts resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the accounts resource.
    - name: accountName
      value: string
      description: Required parameter for the accounts resource.
    - name: sku
      value: object
      description: |
        The SKU of this account.
    - name: kind
      value: string
      description: |
        Get or Set Kind property.
      valid_values: ['Gen2']
    - name: identity
      value: object
      description: |
        Managed service identity (system assigned and/or user assigned identities)
    - name: properties
      value: object
      description: |
        The map account properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

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 
data__tags = '{{ tags }}',
data__kind = '{{ kind }}',
data__sku = '{{ sku }}',
data__identity = '{{ identity }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
RETURNING
identity,
kind,
location,
properties,
sku,
systemData,
tags;

DELETE examples

delete

Delete a Maps Account.

DELETE FROM azure.maps.accounts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
;

Lifecycle Methods

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 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required 
@@json=
'{
"keyType": "{{ keyType }}"
}'
;