az spatial-anchors-account

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Note

This reference is part of the mixed-reality extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az spatial-anchors-account command. Learn more about extensions.

Manage spatial anchor account with mixed reality.

Commands

az spatial-anchors-account create	Create a spatial anchors account.
az spatial-anchors-account delete	Delete a spatial anchors account.
az spatial-anchors-account key	Manage developer keys of a spatial anchors account.
az spatial-anchors-account key renew	Regenerate specified key of a spatial anchors account.
az spatial-anchors-account key show	List both of the 2 keys of a spatial anchors account.
az spatial-anchors-account list	List resources by resource group and list spatial anchors accounts by subscription.
az spatial-anchors-account show	Retrieve a spatial anchors account.
az spatial-anchors-account update	Update a spatial anchors account.

az spatial-anchors-account create

Create a spatial anchors account.

az spatial-anchors-account create --name
                                  --resource-group
                                  [--kind]
                                  [--location]
                                  [--sku]
                                  [--storage-account-name]
                                  [--tags]

Examples

Create spatial anchor account

az spatial-anchors-account create -n "MyAccount" --resource-group "MyResourceGroup"

Required Parameters

--name -n

Name of an mixed reality account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--kind

The kind of account, if supported.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--sku

The SKU associated with this account.

--storage-account-name

The name of the storage account associated with this accountId.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az spatial-anchors-account delete

Delete a spatial anchors account.

az spatial-anchors-account delete --name
                                  --resource-group

Examples

Delete spatial anchors account

az spatial-anchors-account delete -n "MyAccount" --resource-group "MyResourceGroup"

Required Parameters

--name -n

Name of an mixed reality account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az spatial-anchors-account list

List resources by resource group and list spatial anchors accounts by subscription.

az spatial-anchors-account list [--resource-group]

Examples

List spatial anchor accounts by resource group

az spatial-anchors-account list --resource-group "MyResourceGroup"

List spatial anchors accounts by subscription

az spatial-anchors-account list

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az spatial-anchors-account show

Retrieve a spatial anchors account.

az spatial-anchors-account show --name
                                --resource-group

Examples

Get spatial anchors account

az spatial-anchors-account show -n "MyAccount" --resource-group "MyResourceGroup"

Required Parameters

--name -n

Name of an mixed reality account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az spatial-anchors-account update

Update a spatial anchors account.

az spatial-anchors-account update --name
                                  --resource-group
                                  [--add]
                                  [--force-string]
                                  [--kind]
                                  [--location]
                                  [--remove]
                                  [--set]
                                  [--sku]
                                  [--storage-account-name]
                                  [--tags]

Examples

Update spatial anchors account

az spatial-anchors-account update -n "MyAccount" --resource-group "MyResourceGroup" --location "eastus2euap" --tags hero="romeo" heroine="juliet"

Required Parameters

--name -n

Name of an mixed reality account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--kind

The kind of account, if supported.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--sku

The SKU associated with this account.

--storage-account-name

The name of the storage account associated with this accountId.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.