creators

Creates, updates, deletes, gets or lists a creators resource.

Overview

Name	creators
Type	Resource
Id	azure.maps.creators

Fields

The following fields are returned by SELECT queries:

get

The request was successful.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The Creator resource properties.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

list_by_account

The request was successful.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The Creator resource properties.
systemData	object	The system meta data relating to this 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, creatorName		Get a Maps Creator resource.
list_by_account	select	subscriptionId, resourceGroupName, accountName		Get all Creator instances for an Azure Maps Account
create_or_update	insert	subscriptionId, resourceGroupName, accountName, creatorName, data__properties		Create or update a Maps Creator resource. Creator resource will manage Azure resources required to populate a custom set of mapping data. It requires an account to exist before it can be created.
update	update	subscriptionId, resourceGroupName, accountName, creatorName		Updates the Maps Creator resource. Only a subset of the parameters may be updated after creation, such as Tags.
delete	delete	subscriptionId, resourceGroupName, accountName, creatorName		Delete a Maps Creator resource.

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.
creatorName	string	The name of the Maps Creator instance.
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 Creator resource.

SELECT
location,
properties,
systemData,
tags
FROM azure.maps.creators
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND creatorName = '{{ creatorName }}' -- required
;

list_by_account

Get all Creator instances for an Azure Maps Account

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

INSERT examples

create_or_update

Create or update a Maps Creator resource. Creator resource will manage Azure resources required to populate a custom set of mapping data. It requires an account to exist before it can be created.

INSERT INTO azure.maps.creators (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
accountName,
creatorName
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ creatorName }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: creators
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the creators resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the creators resource.
    - name: accountName
      value: string
      description: Required parameter for the creators resource.
    - name: creatorName
      value: string
      description: Required parameter for the creators resource.
    - name: properties
      value: object
      description: |
        The Creator resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates the Maps Creator resource. Only a subset of the parameters may be updated after creation, such as Tags.

UPDATE azure.maps.creators
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND creatorName = '{{ creatorName }}' --required
RETURNING
location,
properties,
systemData,
tags;

DELETE examples

delete

Delete a Maps Creator resource.

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