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

2025/10/28 • 8 deleted methods

RemoteRendering_CreateConversion (removed)
Description :  Creates a conversion using an asset stored in an Azure Blob Storage account.
Reference :  Link ¶

⚼ Request

PUT:  /accounts/{account_id}/conversions/{conversion_id}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
account_id:
{
Description: The Azure Remote Rendering account ID. ,
Format: uuid ,
Required: True ,
}
string ,
conversion_id:
{
Description: An ID uniquely identifying the conversion for the given account. The ID is case sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 256 characters. ,
Required: True ,
}
string ,
body:
{
Description: Request body configuring the settings for an asset conversion. ,
Required: True ,
}
{
settings:
{
Description: Conversion settings describe the origin of input files and destination of output files. ,
Required: True ,
}
{
inputLocation:
{
Description: Conversion input settings describe the origin of conversion input. ,
Required: True ,
}
{
storageContainerUri:
{
Description: The URI of the Azure blob storage container containing the input model. ,
Format: uri ,
Required: True ,
}
string ,
storageContainerReadListSas:
{
Description: An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: Only Blobs starting with this prefix will be downloaded to perform the conversion. Optional. If not provided, all Blobs from the container will be downloaded. ,
Required: False ,
}
string ,
relativeInputAssetPath:
{
Description: The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to a file with a supported file format ending. See https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion for details. ,
Required: True ,
}
string ,
}
,
outputLocation:
{
Description: Conversion output settings describe the destination of conversion output. ,
Required: True ,
}
{
storageContainerUri:
{
Description: The URI of the Azure blob storage container where the result of the conversion should be written to. ,
Format: uri ,
Required: True ,
}
string ,
storageContainerWriteSas:
{
Description: An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: A prefix which gets prepended in front of all files produced by the conversion process. Will be treated as a virtual folder. Optional. If not provided, output files will be stored at the container root. ,
Required: False ,
}
string ,
outputAssetFilename:
{
Description: The file name of the output asset. Must end in '.arrAsset'. Optional. If not provided, file name will the same name as the input asset, with '.arrAsset' extension ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The properties of the conversion. ,
}
{
id:
{
Description: The ID of the conversion supplied when the conversion was created. ,
Required: True ,
}
string ,
settings:
{
Description: Conversion settings describe the origin of input files and destination of output files. ,
Required: True ,
}
{
inputLocation:
{
Description: Conversion input settings describe the origin of conversion input. ,
Required: True ,
}
{
storageContainerUri:
{
Description: The URI of the Azure blob storage container containing the input model. ,
Format: uri ,
Required: True ,
}
string ,
storageContainerReadListSas:
{
Description: An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: Only Blobs starting with this prefix will be downloaded to perform the conversion. Optional. If not provided, all Blobs from the container will be downloaded. ,
Required: False ,
}
string ,
relativeInputAssetPath:
{
Description: The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to a file with a supported file format ending. See https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion for details. ,
Required: True ,
}
string ,
}
,
outputLocation:
{
Description: Conversion output settings describe the destination of conversion output. ,
Required: True ,
}
{
storageContainerUri:
{
Description: The URI of the Azure blob storage container where the result of the conversion should be written to. ,
Format: uri ,
Required: True ,
}
string ,
storageContainerWriteSas:
{
Description: An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: A prefix which gets prepended in front of all files produced by the conversion process. Will be treated as a virtual folder. Optional. If not provided, output files will be stored at the container root. ,
Required: False ,
}
string ,
outputAssetFilename:
{
Description: The file name of the output asset. Must end in '.arrAsset'. Optional. If not provided, file name will the same name as the input asset, with '.arrAsset' extension ,
Required: False ,
}
string ,
}
,
}
,
output:
{
Description: Information about the output of a successful conversion. Only present when the status of the conversion is 'Succeeded'. ,
Required: False ,
}
{
outputAssetUri:
{
Description: URI of the asset generated by the conversion process. ,
Format: uri ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error object containing details about the conversion failure. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
status:
{
Description: The status of the conversion. Terminal states are 'Cancelled', 'Failed', and 'Succeeded'. ,
Enum:
{
NotStarted: The conversion was created but hasn't started. ,
Running: The conversion is running. ,
Cancelled: The conversion was cancelled. This is a terminal state. ,
Failed: The conversion has failed. Check the 'error' field for more details. This is a terminal state. ,
Succeeded: The conversion has succeeded. Check the 'output' field for output asset location. This is a terminal state. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The time when the conversion was created. Date and time in ISO 8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The properties of the conversion. ,
}
{
id:
{
Description: The ID of the conversion supplied when the conversion was created. ,
Required: True ,
}
string ,
settings:
{
Description: Conversion settings describe the origin of input files and destination of output files. ,
Required: True ,
}
{
inputLocation:
{
Description: Conversion input settings describe the origin of conversion input. ,
Required: True ,
}
{
storageContainerUri:
{
Description: The URI of the Azure blob storage container containing the input model. ,
Format: uri ,
Required: True ,
}
string ,
storageContainerReadListSas:
{
Description: An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: Only Blobs starting with this prefix will be downloaded to perform the conversion. Optional. If not provided, all Blobs from the container will be downloaded. ,
Required: False ,
}
string ,
relativeInputAssetPath:
{
Description: The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to a file with a supported file format ending. See https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion for details. ,
Required: True ,
}
string ,
}
,
outputLocation:
{
Description: Conversion output settings describe the destination of conversion output. ,
Required: True ,
}
{
storageContainerUri:
{
Description: The URI of the Azure blob storage container where the result of the conversion should be written to. ,
Format: uri ,
Required: True ,
}
string ,
storageContainerWriteSas:
{
Description: An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: A prefix which gets prepended in front of all files produced by the conversion process. Will be treated as a virtual folder. Optional. If not provided, output files will be stored at the container root. ,
Required: False ,
}
string ,
outputAssetFilename:
{
Description: The file name of the output asset. Must end in '.arrAsset'. Optional. If not provided, file name will the same name as the input asset, with '.arrAsset' extension ,
Required: False ,
}
string ,
}
,
}
,
output:
{
Description: Information about the output of a successful conversion. Only present when the status of the conversion is 'Succeeded'. ,
Required: False ,
}
{
outputAssetUri:
{
Description: URI of the asset generated by the conversion process. ,
Format: uri ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error object containing details about the conversion failure. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
status:
{
Description: The status of the conversion. Terminal states are 'Cancelled', 'Failed', and 'Succeeded'. ,
Enum:
{
NotStarted: The conversion was created but hasn't started. ,
Running: The conversion is running. ,
Cancelled: The conversion was cancelled. This is a terminal state. ,
Failed: The conversion has failed. Check the 'error' field for more details. This is a terminal state. ,
Succeeded: The conversion has succeeded. Check the 'output' field for output asset location. This is a terminal state. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The time when the conversion was created. Date and time in ISO 8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}

⚐ Response (400)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The error response containing details of why the request failed. ,
}
{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (401)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
www-authenticate:
{
Description: Describes the error encountered while trying to authenticate the resource. ,
}
string ,
}

⚐ Response (403)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (409)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The error response containing details of why the request failed. ,
}
{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (429)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
retry-after:
{
Description: The minimum number of seconds to wait before not getting this response anymore. ,
}
integer ,
}

⚐ Response (500)

{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
RemoteRendering_GetConversion (removed)
Description :  Gets the status of a particular conversion.
Reference :  Link ¶

⚼ Request

GET:  /accounts/{account_id}/conversions/{conversion_id}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
account_id:
{
Description: The Azure Remote Rendering account ID. ,
Format: uuid ,
Required: True ,
}
string ,
conversion_id:
{
Description: An ID uniquely identifying the conversion for the given account. The ID is case sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 256 characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
retry-after:
{
Description: Time in seconds when the status of this conversion should be polled again ,
}
integer ,
}
,
$schema:
{
Description: The properties of the conversion. ,
}
{
id:
{
Description: The ID of the conversion supplied when the conversion was created. ,
Required: True ,
}
string ,
settings:
{
Description: Conversion settings describe the origin of input files and destination of output files. ,
Required: True ,
}
{
inputLocation:
{
Description: Conversion input settings describe the origin of conversion input. ,
Required: True ,
}
{
storageContainerUri:
{
Description: The URI of the Azure blob storage container containing the input model. ,
Format: uri ,
Required: True ,
}
string ,
storageContainerReadListSas:
{
Description: An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: Only Blobs starting with this prefix will be downloaded to perform the conversion. Optional. If not provided, all Blobs from the container will be downloaded. ,
Required: False ,
}
string ,
relativeInputAssetPath:
{
Description: The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to a file with a supported file format ending. See https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion for details. ,
Required: True ,
}
string ,
}
,
outputLocation:
{
Description: Conversion output settings describe the destination of conversion output. ,
Required: True ,
}
{
storageContainerUri:
{
Description: The URI of the Azure blob storage container where the result of the conversion should be written to. ,
Format: uri ,
Required: True ,
}
string ,
storageContainerWriteSas:
{
Description: An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: A prefix which gets prepended in front of all files produced by the conversion process. Will be treated as a virtual folder. Optional. If not provided, output files will be stored at the container root. ,
Required: False ,
}
string ,
outputAssetFilename:
{
Description: The file name of the output asset. Must end in '.arrAsset'. Optional. If not provided, file name will the same name as the input asset, with '.arrAsset' extension ,
Required: False ,
}
string ,
}
,
}
,
output:
{
Description: Information about the output of a successful conversion. Only present when the status of the conversion is 'Succeeded'. ,
Required: False ,
}
{
outputAssetUri:
{
Description: URI of the asset generated by the conversion process. ,
Format: uri ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error object containing details about the conversion failure. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
status:
{
Description: The status of the conversion. Terminal states are 'Cancelled', 'Failed', and 'Succeeded'. ,
Enum:
{
NotStarted: The conversion was created but hasn't started. ,
Running: The conversion is running. ,
Cancelled: The conversion was cancelled. This is a terminal state. ,
Failed: The conversion has failed. Check the 'error' field for more details. This is a terminal state. ,
Succeeded: The conversion has succeeded. Check the 'output' field for output asset location. This is a terminal state. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The time when the conversion was created. Date and time in ISO 8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
}

⚐ Response (401)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
www-authenticate:
{
Description: Describes the error encountered while trying to authenticate the resource. ,
}
string ,
}

⚐ Response (403)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (404)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (429)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
retry-after:
{
Description: The minimum number of seconds to wait before not getting this response anymore. ,
}
integer ,
}

⚐ Response (500)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The error response containing details of why the request failed. ,
}
{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
}
RemoteRendering_ListConversions (removed)
Description :  Gets a list of all conversions.
Reference :  Link ¶

⚼ Request

GET:  /accounts/{account_id}/conversions
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
account_id:
{
Description: The Azure Remote Rendering account ID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: List of conversions. ,
}
{
conversions:
{
Description: The list of conversions. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the conversion supplied when the conversion was created. ,
Required: True ,
}
string ,
settings:
{
Description: Conversion settings describe the origin of input files and destination of output files. ,
Required: True ,
}
{
inputLocation:
{
Description: Conversion input settings describe the origin of conversion input. ,
Required: True ,
}
{
storageContainerUri:
{
Description: The URI of the Azure blob storage container containing the input model. ,
Format: uri ,
Required: True ,
}
string ,
storageContainerReadListSas:
{
Description: An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: Only Blobs starting with this prefix will be downloaded to perform the conversion. Optional. If not provided, all Blobs from the container will be downloaded. ,
Required: False ,
}
string ,
relativeInputAssetPath:
{
Description: The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to a file with a supported file format ending. See https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion for details. ,
Required: True ,
}
string ,
}
,
outputLocation:
{
Description: Conversion output settings describe the destination of conversion output. ,
Required: True ,
}
{
storageContainerUri:
{
Description: The URI of the Azure blob storage container where the result of the conversion should be written to. ,
Format: uri ,
Required: True ,
}
string ,
storageContainerWriteSas:
{
Description: An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies. ,
Required: False ,
}
string ,
blobPrefix:
{
Description: A prefix which gets prepended in front of all files produced by the conversion process. Will be treated as a virtual folder. Optional. If not provided, output files will be stored at the container root. ,
Required: False ,
}
string ,
outputAssetFilename:
{
Description: The file name of the output asset. Must end in '.arrAsset'. Optional. If not provided, file name will the same name as the input asset, with '.arrAsset' extension ,
Required: False ,
}
string ,
}
,
}
,
output:
{
Description: Information about the output of a successful conversion. Only present when the status of the conversion is 'Succeeded'. ,
Required: False ,
}
{
outputAssetUri:
{
Description: URI of the asset generated by the conversion process. ,
Format: uri ,
Required: False ,
}
string ,
}
,
error:
{
Description: The error object containing details about the conversion failure. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
status:
{
Description: The status of the conversion. Terminal states are 'Cancelled', 'Failed', and 'Succeeded'. ,
Enum:
{
NotStarted: The conversion was created but hasn't started. ,
Running: The conversion is running. ,
Cancelled: The conversion was cancelled. This is a terminal state. ,
Failed: The conversion has failed. Check the 'error' field for more details. This is a terminal state. ,
Succeeded: The conversion has succeeded. Check the 'output' field for output asset location. This is a terminal state. ,
}
,
Required: True ,
}
enum ,
creationTime:
{
Description: The time when the conversion was created. Date and time in ISO 8601 format. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
@nextLink:
{
Description: If more conversions are available this field will contain a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (401)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting errors to the Azure Remote Rendering team. ,
}
string ,
www-authenticate:
{
Description: Describes the error encountered while trying to authenticate the resource. ,
}
string ,
}

⚐ Response (403)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting errors to the Azure Remote Rendering team. ,
}
string ,
}

⚐ Response (429)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting errors to the Azure Remote Rendering team. ,
}
string ,
retry-after:
{
Description: The minimum number of seconds to wait before not getting this response anymore. ,
}
integer ,
}

⚐ Response (500)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting errors to the Azure Remote Rendering team. ,
}
string ,
}
,
$schema:
{
Description: The error response containing details of why the request failed. ,
}
{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
}
RemoteRendering_CreateSession (removed)
Description :  Creates a new rendering session.
Reference :  Link ¶

⚼ Request

PUT:  /accounts/{account_id}/sessions/{session_id}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
account_id:
{
Description: The Azure Remote Rendering account ID. ,
Format: uuid ,
Required: True ,
}
string ,
session_id:
{
Description: An ID uniquely identifying the rendering session for the given account. The ID is case sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 256 characters. ,
Required: True ,
}
string ,
body:
{
Description: Settings of the session to be created. ,
Required: True ,
}
{
maxLeaseTimeMinutes:
{
Description: The time in minutes the session will run after reaching the 'Ready' state. It has to be between 0 and 1440. ,
Required: True ,
}
integer ,
size:
{
Description: The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details. ,
Enum:
{
Standard: Standard rendering session size. ,
Premium: Premium rendering session size. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ID of the session supplied when the session was created. ,
Required: True ,
}
string ,
arrInspectorPort:
{
Description: The TCP port at which the Azure Remote Rendering Inspector tool is hosted. ,
Required: False ,
}
integer ,
handshakePort:
{
Description: The TCP port used for the handshake when establishing a connection. ,
Required: False ,
}
integer ,
elapsedTimeMinutes:
{
Description: Amount of time in minutes the session is or was in the 'Ready' state. Time is rounded down to a full minute. ,
Required: False ,
}
integer ,
hostname:
{
Description: The hostname under which the rendering session is reachable. ,
Required: False ,
}
string ,
maxLeaseTimeMinutes:
{
Description: The time in minutes the session will run after reaching the 'Ready' state. ,
Required: False ,
}
integer ,
size:
{
Description: The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details. ,
Enum:
{
Standard: Standard rendering session size. ,
Premium: Premium rendering session size. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'. ,
Enum:
{
Error: The rendering session has encountered an error, and is unusable. This is a terminal state. ,
Expired: The rendering session enters the 'Expired' state when it has been in the 'Ready' state longer than its lease time. This is a terminal state. ,
Starting: The rendering session is starting, but not accepting incoming connections yet. ,
Ready: The rendering session is ready for incoming connections. ,
Stopped: The rendering session has been stopped with the 'Stop Session' operation. This is a terminal state. ,
}
,
Required: True ,
}
enum ,
teraflops:
{
Description: The computational power of the rendering session GPU measured in teraflops. ,
Format: float ,
Required: False ,
}
number ,
error:
{
Description: The error object containing details about the rendering session startup failure. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
creationTime:
{
Description: The time when the rendering session was created. Date and time in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The properties of a rendering session. ,
}
{
id:
{
Description: The ID of the session supplied when the session was created. ,
Required: True ,
}
string ,
arrInspectorPort:
{
Description: The TCP port at which the Azure Remote Rendering Inspector tool is hosted. ,
Required: False ,
}
integer ,
handshakePort:
{
Description: The TCP port used for the handshake when establishing a connection. ,
Required: False ,
}
integer ,
elapsedTimeMinutes:
{
Description: Amount of time in minutes the session is or was in the 'Ready' state. Time is rounded down to a full minute. ,
Required: False ,
}
integer ,
hostname:
{
Description: The hostname under which the rendering session is reachable. ,
Required: False ,
}
string ,
maxLeaseTimeMinutes:
{
Description: The time in minutes the session will run after reaching the 'Ready' state. ,
Required: False ,
}
integer ,
size:
{
Description: The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details. ,
Enum:
{
Standard: Standard rendering session size. ,
Premium: Premium rendering session size. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'. ,
Enum:
{
Error: The rendering session has encountered an error, and is unusable. This is a terminal state. ,
Expired: The rendering session enters the 'Expired' state when it has been in the 'Ready' state longer than its lease time. This is a terminal state. ,
Starting: The rendering session is starting, but not accepting incoming connections yet. ,
Ready: The rendering session is ready for incoming connections. ,
Stopped: The rendering session has been stopped with the 'Stop Session' operation. This is a terminal state. ,
}
,
Required: True ,
}
enum ,
teraflops:
{
Description: The computational power of the rendering session GPU measured in teraflops. ,
Format: float ,
Required: False ,
}
number ,
error:
{
Description: The error object containing details about the rendering session startup failure. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
creationTime:
{
Description: The time when the rendering session was created. Date and time in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (400)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The error response containing details of why the request failed. ,
}
{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (401)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
www-authenticate:
{
Description: Describes the error encountered while trying to authenticate the resource. ,
}
string ,
}

⚐ Response (403)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (409)

{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (429)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
retry-after:
{
Description: The minimum number of seconds to wait before not getting this response anymore. ,
}
integer ,
}

⚐ Response (500)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The error response containing details of why the request failed. ,
}
{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
}
RemoteRendering_GetSession (removed)
Description :  Gets the properties of a particular rendering session.
Reference :  Link ¶

⚼ Request

GET:  /accounts/{account_id}/sessions/{session_id}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
account_id:
{
Description: The Azure Remote Rendering account ID. ,
Format: uuid ,
Required: True ,
}
string ,
session_id:
{
Description: An ID uniquely identifying the rendering session for the given account. The ID is case sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 256 characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the session supplied when the session was created. ,
Required: True ,
}
string ,
arrInspectorPort:
{
Description: The TCP port at which the Azure Remote Rendering Inspector tool is hosted. ,
Required: False ,
}
integer ,
handshakePort:
{
Description: The TCP port used for the handshake when establishing a connection. ,
Required: False ,
}
integer ,
elapsedTimeMinutes:
{
Description: Amount of time in minutes the session is or was in the 'Ready' state. Time is rounded down to a full minute. ,
Required: False ,
}
integer ,
hostname:
{
Description: The hostname under which the rendering session is reachable. ,
Required: False ,
}
string ,
maxLeaseTimeMinutes:
{
Description: The time in minutes the session will run after reaching the 'Ready' state. ,
Required: False ,
}
integer ,
size:
{
Description: The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details. ,
Enum:
{
Standard: Standard rendering session size. ,
Premium: Premium rendering session size. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'. ,
Enum:
{
Error: The rendering session has encountered an error, and is unusable. This is a terminal state. ,
Expired: The rendering session enters the 'Expired' state when it has been in the 'Ready' state longer than its lease time. This is a terminal state. ,
Starting: The rendering session is starting, but not accepting incoming connections yet. ,
Ready: The rendering session is ready for incoming connections. ,
Stopped: The rendering session has been stopped with the 'Stop Session' operation. This is a terminal state. ,
}
,
Required: True ,
}
enum ,
teraflops:
{
Description: The computational power of the rendering session GPU measured in teraflops. ,
Format: float ,
Required: False ,
}
number ,
error:
{
Description: The error object containing details about the rendering session startup failure. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
creationTime:
{
Description: The time when the rendering session was created. Date and time in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (401)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
www-authenticate:
{
Description: Describes the error encountered while trying to authenticate the resource. ,
}
string ,
}

⚐ Response (403)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (404)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (429)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
retry-after:
{
Description: The minimum number of seconds to wait before not getting this response anymore. ,
}
integer ,
}

⚐ Response (500)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The error response containing details of why the request failed. ,
}
{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
}
RemoteRendering_UpdateSession (removed)
Description :  Updates the max lease time of a particular rendering session.
Reference :  Link ¶

⚼ Request

PATCH:  /accounts/{account_id}/sessions/{session_id}
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
account_id:
{
Description: The Azure Remote Rendering account ID. ,
Format: uuid ,
Required: True ,
}
string ,
session_id:
{
Description: An ID uniquely identifying the rendering session for the given account. The ID is case sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 256 characters. ,
Required: True ,
}
string ,
body:
{
Description: Settings used to update the session. ,
Required: True ,
}
{
maxLeaseTimeMinutes:
{
Description: Update to the time the session will run after it reached the 'Ready' state. It has to be larger than the current value of maxLeaseTimeMinutes and less than 1440. ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (200)

{
id:
{
Description: The ID of the session supplied when the session was created. ,
Required: True ,
}
string ,
arrInspectorPort:
{
Description: The TCP port at which the Azure Remote Rendering Inspector tool is hosted. ,
Required: False ,
}
integer ,
handshakePort:
{
Description: The TCP port used for the handshake when establishing a connection. ,
Required: False ,
}
integer ,
elapsedTimeMinutes:
{
Description: Amount of time in minutes the session is or was in the 'Ready' state. Time is rounded down to a full minute. ,
Required: False ,
}
integer ,
hostname:
{
Description: The hostname under which the rendering session is reachable. ,
Required: False ,
}
string ,
maxLeaseTimeMinutes:
{
Description: The time in minutes the session will run after reaching the 'Ready' state. ,
Required: False ,
}
integer ,
size:
{
Description: The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details. ,
Enum:
{
Standard: Standard rendering session size. ,
Premium: Premium rendering session size. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'. ,
Enum:
{
Error: The rendering session has encountered an error, and is unusable. This is a terminal state. ,
Expired: The rendering session enters the 'Expired' state when it has been in the 'Ready' state longer than its lease time. This is a terminal state. ,
Starting: The rendering session is starting, but not accepting incoming connections yet. ,
Ready: The rendering session is ready for incoming connections. ,
Stopped: The rendering session has been stopped with the 'Stop Session' operation. This is a terminal state. ,
}
,
Required: True ,
}
enum ,
teraflops:
{
Description: The computational power of the rendering session GPU measured in teraflops. ,
Format: float ,
Required: False ,
}
number ,
error:
{
Description: The error object containing details about the rendering session startup failure. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
creationTime:
{
Description: The time when the rendering session was created. Date and time in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (401)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
www-authenticate:
{
Description: Describes the error encountered while trying to authenticate the resource. ,
}
string ,
}

⚐ Response (403)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (404)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (429)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
retry-after:
{
Description: The minimum number of seconds to wait before not getting this response anymore. ,
}
integer ,
}

⚐ Response (422)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The error response containing details of why the request failed. ,
}
{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (500)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The error response containing details of why the request failed. ,
}
{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
}
RemoteRendering_StopSession (removed)
Description :  Stops a particular rendering session.
Reference :  Link ¶

⚼ Request

POST:  /accounts/{account_id}/sessions/{session_id}/:stop
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
account_id:
{
Description: The Azure Remote Rendering account ID. ,
Format: uuid ,
Required: True ,
}
string ,
session_id:
{
Description: An ID uniquely identifying the rendering session for the given account. The ID is case sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 256 characters. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (401)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
www-authenticate:
{
Description: Describes the error encountered while trying to authenticate the resource. ,
}
string ,
}

⚐ Response (403)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (404)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (429)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
retry-after:
{
Description: The minimum number of seconds to wait before not getting this response anymore. ,
}
integer ,
}

⚐ Response (500)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The error response containing details of why the request failed. ,
}
{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
}
RemoteRendering_ListSessions (removed)
Description :  Gets a list of all rendering sessions.
Reference :  Link ¶

⚼ Request

GET:  /accounts/{account_id}/sessions
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
account_id:
{
Description: The Azure Remote Rendering account ID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sessions:
{
Description: The list of rendering sessions. Does not include sessions in 'Stopped' state. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the session supplied when the session was created. ,
Required: True ,
}
string ,
arrInspectorPort:
{
Description: The TCP port at which the Azure Remote Rendering Inspector tool is hosted. ,
Required: False ,
}
integer ,
handshakePort:
{
Description: The TCP port used for the handshake when establishing a connection. ,
Required: False ,
}
integer ,
elapsedTimeMinutes:
{
Description: Amount of time in minutes the session is or was in the 'Ready' state. Time is rounded down to a full minute. ,
Required: False ,
}
integer ,
hostname:
{
Description: The hostname under which the rendering session is reachable. ,
Required: False ,
}
string ,
maxLeaseTimeMinutes:
{
Description: The time in minutes the session will run after reaching the 'Ready' state. ,
Required: False ,
}
integer ,
size:
{
Description: The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details. ,
Enum:
{
Standard: Standard rendering session size. ,
Premium: Premium rendering session size. ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'. ,
Enum:
{
Error: The rendering session has encountered an error, and is unusable. This is a terminal state. ,
Expired: The rendering session enters the 'Expired' state when it has been in the 'Ready' state longer than its lease time. This is a terminal state. ,
Starting: The rendering session is starting, but not accepting incoming connections yet. ,
Ready: The rendering session is ready for incoming connections. ,
Stopped: The rendering session has been stopped with the 'Stop Session' operation. This is a terminal state. ,
}
,
Required: True ,
}
enum ,
teraflops:
{
Description: The computational power of the rendering session GPU measured in teraflops. ,
Format: float ,
Required: False ,
}
number ,
error:
{
Description: The error object containing details about the rendering session startup failure. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
creationTime:
{
Description: The time when the rendering session was created. Date and time in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
@nextLink:
{
Description: If more rendering sessions are available this field will contain a URL where the next batch of sessions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API. ,
Required: False ,
}
string ,
}

⚐ Response (401)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
www-authenticate:
{
Description: Describes the error encountered while trying to authenticate the resource. ,
}
string ,
}

⚐ Response (403)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}

⚐ Response (429)

{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
retry-after:
{
Description: The minimum number of seconds to wait before not getting this response anymore. ,
}
integer ,
}

⚐ Response (500)

{
$headers:
{
ms-cv:
{
Description: Microsoft Correlation Vector. Include this value when reporting issues. ,
}
string ,
}
,
$schema:
{
Description: The error response containing details of why the request failed. ,
}
{
error:
{
Description: The error object containing details of why the request failed. ,
Required: True ,
}
{
code:
{
Description: Error code. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
target:
{
Description: The target of the particular error (e.g., the name of the property in error). ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
}
,
}
,
}