SpatialAnchorsAccounts interface

Package:

@azure/arm-mixedreality

Interface representing a SpatialAnchorsAccounts.

Methods

create(string, string, SpatialAnchorsAccount, SpatialAnchorsAccountsCreateOptionalParams)	Creating or Updating a Spatial Anchors Account.
delete(string, string, SpatialAnchorsAccountsDeleteOptionalParams)	Delete a Spatial Anchors Account.
get(string, string, SpatialAnchorsAccountsGetOptionalParams)	Retrieve a Spatial Anchors Account.
listByResourceGroup(string, SpatialAnchorsAccountsListByResourceGroupOptionalParams)	List Resources by Resource Group
listBySubscription(SpatialAnchorsAccountsListBySubscriptionOptionalParams)	List Spatial Anchors Accounts by Subscription
listKeys(string, string, SpatialAnchorsAccountsListKeysOptionalParams)	List Both of the 2 Keys of a Spatial Anchors Account
regenerateKeys(string, string, AccountKeyRegenerateRequest, SpatialAnchorsAccountsRegenerateKeysOptionalParams)	Regenerate specified Key of a Spatial Anchors Account
update(string, string, SpatialAnchorsAccount, SpatialAnchorsAccountsUpdateOptionalParams)	Updating a Spatial Anchors Account

Method Details

create(string, string, SpatialAnchorsAccount, SpatialAnchorsAccountsCreateOptionalParams)

Creating or Updating a Spatial Anchors Account.

function create(resourceGroupName: string, accountName: string, spatialAnchorsAccount: SpatialAnchorsAccount, options?: SpatialAnchorsAccountsCreateOptionalParams): Promise<SpatialAnchorsAccount>

Parameters

resourceGroupName

string

Name of an Azure resource group.

accountName

string

Name of an Mixed Reality Account.

spatialAnchorsAccount

SpatialAnchorsAccount

Spatial Anchors Account parameter.

options

SpatialAnchorsAccountsCreateOptionalParams

The options parameters.

Returns

Promise<SpatialAnchorsAccount>

delete(string, string, SpatialAnchorsAccountsDeleteOptionalParams)

Delete a Spatial Anchors Account.

function delete(resourceGroupName: string, accountName: string, options?: SpatialAnchorsAccountsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of an Azure resource group.

accountName

string

Name of an Mixed Reality Account.

options

SpatialAnchorsAccountsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, SpatialAnchorsAccountsGetOptionalParams)

Retrieve a Spatial Anchors Account.

function get(resourceGroupName: string, accountName: string, options?: SpatialAnchorsAccountsGetOptionalParams): Promise<SpatialAnchorsAccount>

Parameters

resourceGroupName

string

Name of an Azure resource group.

accountName

string

Name of an Mixed Reality Account.

options

SpatialAnchorsAccountsGetOptionalParams

The options parameters.

Returns

Promise<SpatialAnchorsAccount>

listByResourceGroup(string, SpatialAnchorsAccountsListByResourceGroupOptionalParams)

List Resources by Resource Group

function listByResourceGroup(resourceGroupName: string, options?: SpatialAnchorsAccountsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SpatialAnchorsAccount, SpatialAnchorsAccount[], PageSettings>

Parameters

resourceGroupName

string

Name of an Azure resource group.

options

SpatialAnchorsAccountsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SpatialAnchorsAccount, SpatialAnchorsAccount[], PageSettings>

listBySubscription(SpatialAnchorsAccountsListBySubscriptionOptionalParams)

List Spatial Anchors Accounts by Subscription

function listBySubscription(options?: SpatialAnchorsAccountsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SpatialAnchorsAccount, SpatialAnchorsAccount[], PageSettings>

Parameters

options

SpatialAnchorsAccountsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SpatialAnchorsAccount, SpatialAnchorsAccount[], PageSettings>

listKeys(string, string, SpatialAnchorsAccountsListKeysOptionalParams)

List Both of the 2 Keys of a Spatial Anchors Account

function listKeys(resourceGroupName: string, accountName: string, options?: SpatialAnchorsAccountsListKeysOptionalParams): Promise<AccountKeys>

Parameters

resourceGroupName

string

Name of an Azure resource group.

accountName

string

Name of an Mixed Reality Account.

options

SpatialAnchorsAccountsListKeysOptionalParams

The options parameters.

Returns

Promise<AccountKeys>

regenerateKeys(string, string, AccountKeyRegenerateRequest, SpatialAnchorsAccountsRegenerateKeysOptionalParams)

Regenerate specified Key of a Spatial Anchors Account

function regenerateKeys(resourceGroupName: string, accountName: string, regenerate: AccountKeyRegenerateRequest, options?: SpatialAnchorsAccountsRegenerateKeysOptionalParams): Promise<AccountKeys>

Parameters

resourceGroupName

string

Name of an Azure resource group.

accountName

string

Name of an Mixed Reality Account.

regenerate

AccountKeyRegenerateRequest

Required information for key regeneration.

options

SpatialAnchorsAccountsRegenerateKeysOptionalParams

The options parameters.

Returns

Promise<AccountKeys>

update(string, string, SpatialAnchorsAccount, SpatialAnchorsAccountsUpdateOptionalParams)

Updating a Spatial Anchors Account

function update(resourceGroupName: string, accountName: string, spatialAnchorsAccount: SpatialAnchorsAccount, options?: SpatialAnchorsAccountsUpdateOptionalParams): Promise<SpatialAnchorsAccount>

Parameters

resourceGroupName

string

Name of an Azure resource group.

accountName

string

Name of an Mixed Reality Account.

spatialAnchorsAccount

SpatialAnchorsAccount

Spatial Anchors Account parameter.

options

SpatialAnchorsAccountsUpdateOptionalParams

The options parameters.

Returns

Promise<SpatialAnchorsAccount>