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

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.
consumedStorageUnitSizeInBytes	integer	The consumed storage unit size in bytes for the creator resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled.
storageUnits	integer	The storage units to be allocated. Integer values from 1 to 100, inclusive. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
totalStorageUnitSizeInBytes	integer	The total allocated storage unit size in bytes for the creator resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_account

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.
consumedStorageUnitSizeInBytes	integer	The consumed storage unit size in bytes for the creator resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled.
storageUnits	integer	The storage units to be allocated. Integer values from 1 to 100, inclusive. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
totalStorageUnitSizeInBytes	integer	The total allocated storage unit size in bytes for the creator resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, creator_name, subscription_id		Get a Maps Creator resource.
list_by_account	select	resource_group_name, account_name, subscription_id		Get all Creator instances for an Azure Maps Account.
create_or_update	insert	resource_group_name, account_name, creator_name, subscription_id, location, 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	resource_group_name, account_name, creator_name, subscription_id		Updates the Maps Creator resource. Only a subset of the parameters may be updated after creation, such as Tags.
create_or_update	replace	resource_group_name, account_name, creator_name, subscription_id, location, 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.
delete	delete	resource_group_name, account_name, creator_name, subscription_id		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
account_name	string	The name of the Maps Account. Required.
creator_name	string	The name of the Maps Creator instance. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Maps Creator resource.

SELECT
id,
name,
consumedStorageUnitSizeInBytes,
location,
provisioningState,
storageUnits,
systemData,
tags,
totalStorageUnitSizeInBytes,
type
FROM azure.maps.creators
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND creator_name = '{{ creator_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_account

Get all Creator instances for an Azure Maps Account.

SELECT
id,
name,
consumedStorageUnitSizeInBytes,
location,
provisioningState,
storageUnits,
systemData,
tags,
totalStorageUnitSizeInBytes,
type
FROM azure.maps.creators
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
tags,
location,
properties,
resource_group_name,
account_name,
creator_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ creator_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: creators
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the creators resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the creators resource.
  - name: creator_name
    value: "{{ creator_name }}"
    description: Required parameter for the creators resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the creators 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 Creator resource properties. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      storageUnits: {{ storageUnits }}
      totalStorageUnitSizeInBytes: {{ totalStorageUnitSizeInBytes }}
      consumedStorageUnitSizeInBytes: {{ consumedStorageUnitSizeInBytes }}

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 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND creator_name = '{{ creator_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

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

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

DELETE examples

delete

Delete a Maps Creator resource.

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