Microsoft.MixedReality (preview:2019-12-02)

2025/02/26 • 18 updated methods

Operations_List (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Exposing Available Operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Exposing Available Operations",
    "old": "Exposing Available Operations"
  }
}

⚼ Request

GET:  /providers/Microsoft.MixedReality/operations
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the Resource Provider. ,
Required: False ,
}
[
{
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.ResourceProvider ,
Required: True ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: True ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: True ,
}
string ,
description:
{
Description: Description of operation ,
Required: True ,
}
string ,
}
,
isDataAction:
{
Description: Whether or not this is a data plane operation ,
Required: False ,
}
boolean ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
CheckNameAvailabilityLocal (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Check Name Availability for local uniqueness
Reference :  Link ¶

⚶ Changes

{
  "#id": "CheckNameAvailabilityLocal",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Check Name Availability for local uniqueness",
    "old": "Check Name Availability for local uniqueness"
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/locations/{location}/checkNameAvailability
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
location:
{
Description: The location in which uniqueness will be verified. ,
Required: True ,
}
string ,
checkNameAvailability:
{
Description: Check Name Availability Request. ,
Required: True ,
}
{
name:
{
Description: Resource Name To Verify ,
Required: True ,
}
string ,
type:
{
Description: Fully qualified resource type which includes provider namespace ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: if name Available ,
Required: True ,
}
boolean ,
reason:
{
Description: Resource Name To Verify ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: detail message ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
RemoteRenderingAccounts_ListBySubscription (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. List Remote Rendering Accounts by Subscription
Reference :  Link ¶

⚶ Changes

{
  "#id": "RemoteRenderingAccounts_ListBySubscription",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n List Remote Rendering Accounts by Subscription",
    "old": "List Remote Rendering Accounts by Subscription"
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/remoteRenderingAccounts
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources supported by the Resource Provider. ,
Required: False ,
}
[
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of resource list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
RemoteRenderingAccounts_ListByResourceGroup (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. List Resources by Resource Group
Reference :  Link ¶

⚶ Changes

{
  "#id": "RemoteRenderingAccounts_ListByResourceGroup",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n List Resources by Resource Group",
    "old": "List Resources by Resource Group"
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources supported by the Resource Provider. ,
Required: False ,
}
[
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of resource list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
RemoteRenderingAccounts_Delete (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Delete a Remote Rendering Account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RemoteRenderingAccounts_Delete",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Delete a Remote Rendering Account.",
    "old": "Delete a Remote Rendering Account."
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
RemoteRenderingAccounts_Get (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Retrieve a Remote Rendering Account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RemoteRenderingAccounts_Get",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Retrieve a Remote Rendering Account.",
    "old": "Retrieve a Remote Rendering Account."
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
RemoteRenderingAccounts_Update (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Updating a Remote Rendering Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "RemoteRenderingAccounts_Update",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Updating a Remote Rendering Account",
    "old": "Updating a Remote Rendering Account"
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
remoteRenderingAccount:
{
Description: Remote Rendering Account parameter. ,
Required: True ,
}
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
RemoteRenderingAccounts_Create (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Creating or Updating a Remote Rendering Account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RemoteRenderingAccounts_Create",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Creating or Updating a Remote Rendering Account.",
    "old": "Creating or Updating a Remote Rendering Account."
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
remoteRenderingAccount:
{
Description: Remote Rendering Account parameter. ,
Required: True ,
}
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
RemoteRenderingAccounts_GetKeys (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Get Both of the 2 Keys of a Remote Rendering Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "RemoteRenderingAccounts_GetKeys",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Get Both of the 2 Keys of a Remote Rendering Account",
    "old": "Get Both of the 2 Keys of a Remote Rendering Account"
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}/keys
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: value of primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: value of secondary key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
RemoteRenderingAccounts_RegenerateKeys (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Regenerate specified Key of a Remote Rendering Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "RemoteRenderingAccounts_RegenerateKeys",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Regenerate specified Key of a Remote Rendering Account",
    "old": "Regenerate specified Key of a Remote Rendering Account"
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}/keys
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
regenerate:
{
Description: Required information for key regeneration. ,
Required: True ,
}
{
serial:
{
Description: serial of key to be regenerated ,
Required: False ,
}
integer ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: value of primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: value of secondary key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
SpatialAnchorsAccounts_ListBySubscription (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. List Spatial Anchors Accounts by Subscription
Reference :  Link ¶

⚶ Changes

{
  "#id": "SpatialAnchorsAccounts_ListBySubscription",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n List Spatial Anchors Accounts by Subscription",
    "old": "List Spatial Anchors Accounts by Subscription"
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.MixedReality/spatialAnchorsAccounts
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources supported by the Resource Provider. ,
Required: False ,
}
[
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of resource list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
SpatialAnchorsAccounts_ListByResourceGroup (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. List Resources by Resource Group
Reference :  Link ¶

⚶ Changes

{
  "#id": "SpatialAnchorsAccounts_ListByResourceGroup",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n List Resources by Resource Group",
    "old": "List Resources by Resource Group"
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources supported by the Resource Provider. ,
Required: False ,
}
[
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of resource list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
SpatialAnchorsAccounts_Delete (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Delete a Spatial Anchors Account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SpatialAnchorsAccounts_Delete",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Delete a Spatial Anchors Account.",
    "old": "Delete a Spatial Anchors Account."
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
SpatialAnchorsAccounts_Get (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Retrieve a Spatial Anchors Account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SpatialAnchorsAccounts_Get",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Retrieve a Spatial Anchors Account.",
    "old": "Retrieve a Spatial Anchors Account."
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
SpatialAnchorsAccounts_Update (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Updating a Spatial Anchors Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "SpatialAnchorsAccounts_Update",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Updating a Spatial Anchors Account",
    "old": "Updating a Spatial Anchors Account"
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
spatialAnchorsAccount:
{
Description: Spatial Anchors Account parameter. ,
Required: True ,
}
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
SpatialAnchorsAccounts_Create (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Creating or Updating a Spatial Anchors Account.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SpatialAnchorsAccounts_Create",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Creating or Updating a Spatial Anchors Account.",
    "old": "Creating or Updating a Spatial Anchors Account."
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
spatialAnchorsAccount:
{
Description: Spatial Anchors Account parameter. ,
Required: True ,
}
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain account. ,
Required: False ,
}
string ,
accountDomain:
{
Description: Correspond domain name of certain Spatial Anchors Account ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The identity associated with this account ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: The identity type. ,
Enum:
{
SystemAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
SpatialAnchorsAccounts_GetKeys (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Get Both of the 2 Keys of a Spatial Anchors Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "SpatialAnchorsAccounts_GetKeys",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Get Both of the 2 Keys of a Spatial Anchors Account",
    "old": "Get Both of the 2 Keys of a Spatial Anchors Account"
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}/keys
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: value of primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: value of secondary key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}
SpatialAnchorsAccounts_RegenerateKeys (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Regenerate specified Key of a Spatial Anchors Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "SpatialAnchorsAccounts_RegenerateKeys",
  "Description": {
    "new": "\n\n> [!NOTE]\n>\n> **Mixed Reality retirement**\n>\n> The Mixed Reality service is now deprecated and will be retired. \n\n Regenerate specified Key of a Spatial Anchors Account",
    "old": "Regenerate specified Key of a Spatial Anchors Account"
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}/keys
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
accountName:
{
Description: Name of an Mixed Reality Account. ,
Required: True ,
}
string ,
regenerate:
{
Description: Required information for key regeneration. ,
Required: True ,
}
{
serial:
{
Description: serial of key to be regenerated ,
Required: False ,
}
integer ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
primaryKey:
{
Description: value of primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: value of secondary key. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: Describes the error in detail and provides debugging information ,
Required: True ,
}
string ,
code:
{
Description: String that can be used to programmatically identify the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the particular error ,
Required: False ,
}
string ,
details:
{
Description: An array of JSON objects that MUST contain name/value pairs for code and message, and MAY contain a name/value pair for target, as described above.The contents of this section are service-defined but must adhere to the aforementioned schema. ,
Required: False ,
}
string ,
}