az spatial-anchors-account

Note

This reference is part of the mixed-reality extension for the Azure CLI (version 2.49.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

Name	Description	Type	Status
az spatial-anchors-account create	Create a Spatial Anchors Account.	Extension	Preview
az spatial-anchors-account delete	Delete a Spatial Anchors Account.	Extension	Preview
az spatial-anchors-account key	Manage developer keys of a spatial anchors account.	Extension	Preview
az spatial-anchors-account key renew	Regenerate specified Key of a Spatial Anchors Account.	Extension	Preview
az spatial-anchors-account key show	List Both of the 2 Keys of a Spatial Anchors Account.	Extension	Preview
az spatial-anchors-account list	List Spatial Anchors Accounts by Subscription.	Extension	Preview
az spatial-anchors-account show	Get a Spatial Anchors Account.	Extension	Preview
az spatial-anchors-account update	Update a Spatial Anchors Account.	Extension	Preview

az spatial-anchors-account create

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--kind

The kind of account, if supported Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	SpatialAnchorsAccount Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	SpatialAnchorsAccount Arguments

--sku

The sku associated with this account Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	SpatialAnchorsAccount Arguments

--storage-account-name

The name of the storage account associated with this accountId.

Property	Value
Parameter group:	Properties Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	SpatialAnchorsAccount Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az spatial-anchors-account delete

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Spatial Anchors Account.

az spatial-anchors-account delete [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]

Examples

Delete spatial anchors account

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of an Mixed Reality Account.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az spatial-anchors-account list

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az spatial-anchors-account show

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a Spatial Anchors Account.

az spatial-anchors-account show [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Examples

Get spatial anchors account

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of an Mixed Reality Account.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az spatial-anchors-account update

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a Spatial Anchors Account.

az spatial-anchors-account update [--ids]
                                  [--kind]
                                  [--name]
                                  [--resource-group]
                                  [--sku]
                                  [--storage-account-name]
                                  [--subscription]
                                  [--tags]

Examples

Update spatial anchors account

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--kind

The kind of account, if supported Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	SpatialAnchorsAccount Arguments

--name -n

Name of an Mixed Reality Account.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--sku

The sku associated with this account Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	SpatialAnchorsAccount Arguments

--storage-account-name

The name of the storage account associated with this accountId.

Property	Value
Parameter group:	Properties Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	SpatialAnchorsAccount Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False