Microsoft.MixedReality (stable:2021-01-01)

2025/02/26 • 16 updated methods

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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources supported by the Resource Provider. ,
Required: False ,
}
[
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of resource list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources supported by the Resource Provider. ,
Required: False ,
}
[
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of resource list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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 ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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 ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
RemoteRenderingAccounts_ListKeys (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. List Both of the 2 Keys of a Remote Rendering Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "RemoteRenderingAccounts_ListKeys",
  "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 Both of the 2 Keys of a Remote Rendering Account",
    "old": "List Both of the 2 Keys of a Remote Rendering Account"
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/remoteRenderingAccounts/{accountName}/listKeys
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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: The API version to be used with the HTTP 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)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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}/regenerateKeys
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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: The API version to be used with the HTTP 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)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources supported by the Resource Provider. ,
Required: False ,
}
[
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of resource list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Name of an Azure resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources supported by the Resource Provider. ,
Required: False ,
}
[
{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of resource list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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 ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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 ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Property bag. ,
Required: False ,
}
{
storageAccountName:
{
Description: The name of the storage account associated with this accountId ,
Required: False ,
}
string ,
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 ,
}
,
plan:
{
Description: The plan 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 ,
}
,
sku:
{
Description: The sku associated with this account ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
kind:
{
Description: The kind of account, if supported ,
Required: False ,
}
{
name:
{
Description: The name of the SKU. Ex - P3. It is typically a letter+number code ,
Required: True ,
}
string ,
tier:
{
Description: This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. ,
Enum:
{
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
size:
{
Description: The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ,
Required: False ,
}
string ,
family:
{
Description: If the service has different generations of hardware, for the same SKU, then that can be captured here. ,
Required: False ,
}
string ,
capacity:
{
Description: If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
systemData:
{
Description: System metadata for this account ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SpatialAnchorsAccounts_ListKeys (updated)
Description :  > [!NOTE] > > **Mixed Reality retirement** > > The Mixed Reality service is now deprecated and will be retired. List Both of the 2 Keys of a Spatial Anchors Account
Reference :  Link ¶

⚶ Changes

{
  "#id": "SpatialAnchorsAccounts_ListKeys",
  "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 Both of the 2 Keys of a Spatial Anchors Account",
    "old": "List Both of the 2 Keys of a Spatial Anchors Account"
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MixedReality/spatialAnchorsAccounts/{accountName}/listKeys
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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: The API version to be used with the HTTP 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)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
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}/regenerateKeys
{
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
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: The API version to be used with the HTTP 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)

{
error:
{
Description: An Error response. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for displaying in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}