spatial_anchors_accounts

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

Overview

Name	spatial_anchors_accounts
Type	Resource
Id	azure.mixed_reality.spatial_anchors_accounts

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
identity	object	Identity for the resource.
kind	object	The resource model definition representing SKU
location	string	The geo-location where the resource lives
plan	object	Identity for the resource.
properties	object	Property bag.
sku	object	The resource model definition representing SKU
systemData	object	System metadata for this account
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
identity	object	Identity for the resource.
kind	object	The resource model definition representing SKU
location	string	The geo-location where the resource lives
plan	object	Identity for the resource.
properties	object	Property bag.
sku	object	The resource model definition representing SKU
systemData	object	System metadata for this account
tags	object	Resource tags.

list_by_subscription

Name	Datatype	Description
identity	object	Identity for the resource.
kind	object	The resource model definition representing SKU
location	string	The geo-location where the resource lives
plan	object	Identity for the resource.
properties	object	Property bag.
sku	object	The resource model definition representing SKU
systemData	object	System metadata for this account
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		Retrieve a Spatial Anchors Account.
list_by_resource_group	select	subscriptionId, resourceGroupName		List Resources by Resource Group
list_by_subscription	select	subscriptionId		List Spatial Anchors Accounts by Subscription
create	insert	subscriptionId, resourceGroupName, accountName		Creating or Updating a Spatial Anchors Account.
update	update	subscriptionId, resourceGroupName, accountName		Updating a Spatial Anchors Account
delete	delete	subscriptionId, resourceGroupName, accountName		Delete a Spatial Anchors Account.
regenerate_keys	exec	subscriptionId, resourceGroupName, accountName		Regenerate specified Key of a Spatial Anchors Account

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	Name of an Mixed Reality Account.
resourceGroupName	string	Name of an Azure resource group.
subscriptionId	string	The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)

SELECT examples

get

Retrieve a Spatial Anchors Account.

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

list_by_resource_group

List Resources by Resource Group

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

list_by_subscription

List Spatial Anchors Accounts by Subscription

SELECT
identity,
kind,
location,
plan,
properties,
sku,
systemData,
tags
FROM azure.mixed_reality.spatial_anchors_accounts
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creating or Updating a Spatial Anchors Account.

INSERT INTO azure.mixed_reality.spatial_anchors_accounts (
data__tags,
data__location,
data__properties,
data__identity,
data__plan,
data__sku,
data__kind,
subscriptionId,
resourceGroupName,
accountName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ identity }}',
'{{ plan }}',
'{{ sku }}',
'{{ kind }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}'
RETURNING
identity,
kind,
location,
plan,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: spatial_anchors_accounts
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the spatial_anchors_accounts resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the spatial_anchors_accounts resource.
    - name: accountName
      value: string
      description: Required parameter for the spatial_anchors_accounts resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Property bag.
    - name: identity
      value: object
      description: |
        Identity for the resource.
    - name: plan
      value: object
      description: |
        Identity for the resource.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: kind
      value: object
      description: |
        The resource model definition representing SKU

UPDATE examples

update

Updating a Spatial Anchors Account

UPDATE azure.mixed_reality.spatial_anchors_accounts
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__properties = '{{ properties }}',
data__identity = '{{ identity }}',
data__plan = '{{ plan }}',
data__sku = '{{ sku }}',
data__kind = '{{ kind }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
RETURNING
identity,
kind,
location,
plan,
properties,
sku,
systemData,
tags;

DELETE examples

delete

Delete a Spatial Anchors Account.

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

Lifecycle Methods

regenerate_keys

Regenerate specified Key of a Spatial Anchors Account

EXEC azure.mixed_reality.spatial_anchors_accounts.regenerate_keys 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required 
@@json=
'{
"serial": {{ serial }}
}'
;