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

2025/10/28 • 11 deleted methods

GetToken (removed)
Description :  Gets an access token to be used with Mixed Reality services.
Reference :  Link ¶

⚼ Request

GET:  /Accounts/{accountId}/token
{
accountId:
{
Description: The Mixed Reality account identifier. ,
Format: uuid ,
Required: True ,
}
string ,
X-MRC-CV:
{
Description: The client request correlation vector, which should be set to a new value for each request. Useful when debugging with Microsoft. ,
Required: False ,
}
string ,
api-version:
{
Description: The API version. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
ms-cv:
{
Description: The service response correlation vector, which will be a new value for every response. Useful when debugging with Microsoft. ,
}
string ,
}
,
$schema:
{
Description: Represents a token response message from the STS service. ,
}
{
AccessToken:
{
Description: An access token for the account. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (400)

{
ms-cv:
{
Description: The service response correlation vector, which will be a new value for every response. Useful when debugging with Microsoft. ,
}
string ,
www-authenticate:
{
Description: Describes the error encountered while trying to authenticate the resource. ,
}
string ,
}

⚐ Response (401)

{
ms-cv:
{
Description: The service response correlation vector, which will be a new value for every response. Useful when debugging with Microsoft. ,
}
string ,
www-authenticate:
{
Description: Describes the error encountered while trying to authenticate the resource. ,
}
string ,
}

⚐ Response (429)

{
ms-cv:
{
Description: The service response correlation vector, which will be a new value for every response. Useful when debugging with Microsoft. ,
}
string ,
www-authenticate:
{
Description: Describes the error encountered while trying to authenticate the resource. ,
}
string ,
}

⚐ Response (default)

{
ms-cv:
{
Description: The service response correlation vector, which will be a new value for every response. Useful when debugging with Microsoft. ,
}
string ,
}
Operations_List (removed)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Exposing Available Operations
Reference :  Link ¶

⚼ 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 ,
origin:
{
Description: The origin for the operation ,
Required: False ,
}
string ,
}
,
]
,
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 (removed)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Check Name Availability for global uniqueness
Reference :  Link ¶

⚼ 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 ,
}
SpatialAnchorsAccounts_ListBySubscription (removed)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. List Spatial Anchors Accounts by Subscription
Reference :  Link ¶

⚼ 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 Spatial Anchors Account data contract. ,
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 (removed)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. List Resources by Resource Group
Reference :  Link ¶

⚼ 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 Spatial Anchors Account data contract. ,
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 (removed)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Delete a Spatial Anchors Account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{spatialAnchorsAccountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
spatialAnchorsAccountName:
{
Description: Name of an Mixed Reality Spatial Anchors 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 (removed)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Retrieve a Spatial Anchors Account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{spatialAnchorsAccountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
spatialAnchorsAccountName:
{
Description: Name of an Mixed Reality Spatial Anchors 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 Spatial Anchors Account data contract. ,
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 (removed)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Updating a Spatial Anchors Account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{spatialAnchorsAccountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
spatialAnchorsAccountName:
{
Description: Name of an Mixed Reality Spatial Anchors Account. ,
Required: True ,
}
string ,
spatialAnchorsAccount:
{
Description: Spatial Anchors Account parameter. ,
Required: True ,
}
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain Spatial Anchors Account data contract. ,
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 Spatial Anchors Account data contract. ,
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 (removed)
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 ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{spatialAnchorsAccountName}
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
spatialAnchorsAccountName:
{
Description: Name of an Mixed Reality Spatial Anchors Account. ,
Required: True ,
}
string ,
spatialAnchorsAccount:
{
Description: Spatial Anchors Account parameter. ,
Required: True ,
}
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
accountId:
{
Description: unique id of certain Spatial Anchors Account data contract. ,
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 Spatial Anchors Account data contract. ,
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 Spatial Anchors Account data contract. ,
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 (removed)
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 ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{spatialAnchorsAccountName}/keys
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
spatialAnchorsAccountName:
{
Description: Name of an Mixed Reality Spatial Anchors 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 (removed)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. Regenerate 1 Key of a Spatial Anchors Account
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{spatialAnchorsAccountName}/keys
{
subscriptionId:
{
Description: Azure subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
spatialAnchorsAccountName:
{
Description: Name of an Mixed Reality Spatial Anchors Account. ,
Required: True ,
}
string ,
spatialAnchorsAccountKeyRegenerate:
{
Description: Specifying which key to be regenerated. ,
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 ,
}