@datafire/azure_mixedreality_spatial_anchors v3.0.0

@datafire/azure_mixedreality_spatial_anchors

Client library for Mixed Reality

Installation and Usage

npm install --save @datafire/azure_mixedreality_spatial_anchors

let azure_mixedreality_spatial_anchors = require('@datafire/azure_mixedreality_spatial_anchors').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Mixed Reality Resource Provider Spatial Anchors Resource API

Actions

SpatialAnchorsAccounts_ListBySubscription

List Spatial Anchors Accounts by Subscription

azure_mixedreality_spatial_anchors.SpatialAnchorsAccounts_ListBySubscription({
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • api-version required string: Version of the API to be used with the client request.

Output

• output SpatialAnchorsAccountPage

SpatialAnchorsAccounts_ListByResourceGroup

List Resources by Resource Group

azure_mixedreality_spatial_anchors.SpatialAnchorsAccounts_ListByResourceGroup({
  "subscriptionId": "",
  "resourceGroupName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • api-version required string: Version of the API to be used with the client request.

Output

• output SpatialAnchorsAccountPage

SpatialAnchorsAccounts_Delete

Delete a Spatial Anchors Account.

azure_mixedreality_spatial_anchors.SpatialAnchorsAccounts_Delete({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Name of an Mixed Reality Account.
  • api-version required string: Version of the API to be used with the client request.

Output

Output schema unknown

SpatialAnchorsAccounts_Get

Retrieve a Spatial Anchors Account.

azure_mixedreality_spatial_anchors.SpatialAnchorsAccounts_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Name of an Mixed Reality Account.
  • api-version required string: Version of the API to be used with the client request.

Output

• output SpatialAnchorsAccount

SpatialAnchorsAccounts_Update

Updating a Spatial Anchors Account

azure_mixedreality_spatial_anchors.SpatialAnchorsAccounts_Update({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "spatialAnchorsAccount": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Name of an Mixed Reality Account.
  • spatialAnchorsAccount required SpatialAnchorsAccount
  • api-version required string: Version of the API to be used with the client request.

Output

• output SpatialAnchorsAccount

SpatialAnchorsAccounts_Create

Creating or Updating a Spatial Anchors Account.

azure_mixedreality_spatial_anchors.SpatialAnchorsAccounts_Create({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "spatialAnchorsAccount": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Name of an Mixed Reality Account.
  • spatialAnchorsAccount required SpatialAnchorsAccount
  • api-version required string: Version of the API to be used with the client request.

Output

• output SpatialAnchorsAccount

SpatialAnchorsAccounts_GetKeys

Get Both of the 2 Keys of a Spatial Anchors Account

azure_mixedreality_spatial_anchors.SpatialAnchorsAccounts_GetKeys({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Name of an Mixed Reality Account.
  • api-version required string: Version of the API to be used with the client request.

Output

• output object: Developer Keys of account
  • primaryKey string: value of primary key.
  • secondaryKey string: value of secondary key.

SpatialAnchorsAccounts_RegenerateKeys

Regenerate specified Key of a Spatial Anchors Account

azure_mixedreality_spatial_anchors.SpatialAnchorsAccounts_RegenerateKeys({
  "subscriptionId": "",
  "resourceGroupName": "",
  "accountName": "",
  "regenerate": {},
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Azure subscription ID.
  • resourceGroupName required string: Name of an Azure resource group.
  • accountName required string: Name of an Mixed Reality Account.
  • regenerate required object: Request for account key regeneration
    • serial integer (values: 1, 2): serial of key to be regenerated
  • api-version required string: Version of the API to be used with the client request.

Output

• output object: Developer Keys of account
  • primaryKey string: value of primary key.
  • secondaryKey string: value of secondary key.

Definitions

SpatialAnchorsAccount

• SpatialAnchorsAccount object: SpatialAnchorsAccount Response.
  • properties object: Common Properties shared by Mixed Reality Accounts
    • accountDomain string: Correspond domain name of certain Spatial Anchors Account
    • accountId string: unique id of certain account.
  • location required string: The geo-location where the resource lives
  • tags object: Resource tags.
  • 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
  • type string: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

SpatialAnchorsAccountPage

• SpatialAnchorsAccountPage object: Result of the request to get resource collection. It contains a list of resources and a URL link to get the next set of results.
  • nextLink string: URL to get the next set of resource list results if there are any.
  • value array: List of resources supported by the Resource Provider.
    • items SpatialAnchorsAccount