Microsoft Azure Mixed Reality Remote Rendering allows users to create high-fidelity, immersive mixed reality experiences without the need for powerful local hardware. Through cloud-based rendering capabilities, users can offload the complex rendering processes to remote servers, enabling them to stream high-quality graphics and visuals directly to their mixed reality devices.
swagger: '2.0'
info:
description: >
Describing the [Azure Remote
Rendering](https://docs.microsoft.com/azure/remote-rendering/) REST API for
rendering sessions and asset conversions.
All requests to these APIs must be authenticated using the Secure Token
Service as described in the [Azure Remote rendering documentation chapter
about
authentication](https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens).
title: Microsoft Azure MixedRealityRemoteRendering
version: 2021-01-01-preview
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'
schemes:
- https
paths:
/accounts/{account_id}/conversions/{conversion_id}:
put:
operationId: microsoftAzureRemoterenderingCreateconversion
consumes:
- application/json
produces:
- application/json
x-ms-examples:
Create a conversion:
$ref: ./examples/CreateConversion.json
parameters:
- $ref: '#/parameters/api_version'
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/conversion_id'
- description: Request body configuring the settings for an asset conversion.
in: body
name: body
required: true
schema:
$ref: '#/definitions/create_conversion_settings'
responses:
'200':
description: >-
OK. Indicates that there was already a conversion with the same
settings present. This is expected when a conversion creation is
retried.
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/conversion'
'201':
description: Created. A new conversion was created.
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/conversion'
'400':
description: Bad Request. Returned error object describes which issues occurred.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/error_response'
'401':
description: Unauthorized. Missing or invalid authorization.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
WWW-Authenticate:
description: >-
Describes the error encountered while trying to authenticate the
resource.
type: string
'403':
description: Forbidden. Authorization insufficient for given resource.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'409':
description: >-
Conflict. A conversion already exists. An error object describes
which issues occurred.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/error_response'
'429':
description: >-
Too Many Requests. The rate limit has been exceeded. Retry the
request after the duration given in the Retry-After header.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
Retry-After:
description: >-
The minimum number of seconds to wait before not getting this
response anymore.
type: integer
'500':
description: >-
Internal Error. Server has encountered an internal error. Retrying
the request may produce successful results.
x-ms-error-response: true
schema:
$ref: '#/definitions/error_response'
tags:
- Conversion
summary: >-
Microsoft Azure Creates A Conversion Using An Asset Stored In An Azure Blob Storage Account
description: Needs a more full description created.
get:
operationId: microsoftAzureRemoterenderingGetconversion
produces:
- application/json
parameters:
- $ref: '#/parameters/api_version'
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/conversion_id'
x-ms-examples:
Get a single conversion by ID:
$ref: ./examples/GetConversion.json
responses:
'200':
description: OK.
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
Retry-After:
description: >-
Time in seconds when the status of this conversion should be
polled again
type: integer
schema:
$ref: '#/definitions/conversion'
'401':
description: Unauthorized. Missing or invalid authorization.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
WWW-Authenticate:
description: >-
Describes the error encountered while trying to authenticate the
resource.
type: string
'403':
description: Forbidden. Authorization insufficient for given resource.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'404':
description: Not found. No conversion with the provided conversion ID exists.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'429':
description: >-
Too Many Requests. The rate limit has been exceeded. Retry the
request after the duration given in the Retry-After header.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
Retry-After:
description: >-
The minimum number of seconds to wait before not getting this
response anymore.
type: integer
'500':
description: >-
Internal Error. Server has encountered an internal error. Retrying
the request may produce successful results.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/error_response'
tags:
- Conversion
summary: 'Microsoft Azure Gets The Status Of A Particular Conversion'
description: Needs a more full description created.
/accounts/{account_id}/conversions:
get:
operationId: microsoftAzureRemoterenderingListconversions
produces:
- application/json
parameters:
- $ref: '#/parameters/api_version'
- $ref: '#/parameters/account_id'
x-ms-examples:
List conversions:
$ref: ./examples/ListConversions.json
responses:
'200':
description: OK.
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/conversion_list'
'401':
description: Unauthorized. Missing or invalid authorization.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
errors to the Azure Remote Rendering team.
type: string
WWW-Authenticate:
description: >-
Describes the error encountered while trying to authenticate the
resource.
type: string
'403':
description: Forbidden. Authorization insufficient for given resource.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
errors to the Azure Remote Rendering team.
type: string
'429':
description: >-
Too Many Requests. The rate limit has been exceeded. Retry the
request after the duration given in the Retry-After header.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
errors to the Azure Remote Rendering team.
type: string
Retry-After:
description: >-
The minimum number of seconds to wait before not getting this
response anymore.
type: integer
'500':
description: >-
Internal Error. Server has encountered an internal error. Retrying
the request may produce successful results.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
errors to the Azure Remote Rendering team.
type: string
schema:
$ref: '#/definitions/error_response'
x-ms-pageable:
itemName: conversions
nextLinkName: '@nextLink'
tags:
- Conversion
summary: 'Microsoft Azure Gets A List Of All Conversions'
description: Needs a more full description created.
/accounts/{account_id}/sessions/{session_id}:
put:
operationId: microsoftAzureRemoterenderingCreatesession
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: '#/parameters/api_version'
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/session_id'
- description: Settings of the session to be created.
in: body
name: body
required: true
schema:
$ref: '#/definitions/create_session_settings'
x-ms-examples:
Create a rendering session:
$ref: ./examples/CreateSession.json
responses:
'200':
description: >-
OK. Indicates that there was already a session with the same
settings present. This is expected when session creation is retried.
schema:
$ref: '#/definitions/session_properties'
'201':
description: Created. The session was created successfully.
schema:
$ref: '#/definitions/session_properties'
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'400':
description: Bad Request. Returned error object describes which issues occurred.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/error_response'
'401':
description: Unauthorized. Missing or invalid authorization.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
WWW-Authenticate:
description: >-
Describes the error encountered while trying to authenticate the
resource.
type: string
'403':
description: Forbidden. Authorization insufficient for given resource.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'409':
description: >-
Conflict. A rendering session with the ID already exists for the
remote rendering account.
x-ms-error-response: true
schema:
$ref: '#/definitions/error_response'
'429':
description: >-
Too Many Requests. The rate limit has been exceeded. Retry the
request after the duration given in the Retry-After header.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
Retry-After:
description: >-
The minimum number of seconds to wait before not getting this
response anymore.
type: integer
'500':
description: >-
Internal Error. Server has encountered an internal error. Retrying
the request may produce successful results.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/error_response'
tags:
- Rendering Session
summary: 'Microsoft Azure Creates A New Rendering Session'
description: Needs a more full description created.
get:
operationId: microsoftAzureRemoterenderingGetsession
produces:
- application/json
parameters:
- $ref: '#/parameters/api_version'
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/session_id'
x-ms-examples:
Get a previously created session by ID:
$ref: ./examples/GetSession.json
responses:
'200':
description: OK.
schema:
$ref: '#/definitions/session_properties'
'401':
description: Unauthorized. Missing or invalid authorization.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
WWW-Authenticate:
description: >-
Describes the error encountered while trying to authenticate the
resource.
type: string
'403':
description: Forbidden. Authorization insufficient for given resource.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'404':
description: Not found. No session with the provided session ID exists.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'429':
description: >-
Too Many Requests. The rate limit has been exceeded. Retry the
request after the duration given in the Retry-After header.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
Retry-After:
description: >-
The minimum number of seconds to wait before not getting this
response anymore.
type: integer
'500':
description: >-
Internal Error. Server has encountered an internal error. Retrying
the request may produce successful results.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/error_response'
tags:
- Rendering Session
summary: 'Microsoft Azure Gets The Properties Of A Particular Rendering Session'
description: Needs a more full description created.
patch:
operationId: microsoftAzureRemoterenderingUpdatesession
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: '#/parameters/api_version'
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/session_id'
- description: Settings used to update the session.
in: body
name: body
required: true
schema:
$ref: '#/definitions/update_session_settings'
x-ms-examples:
Update a session:
$ref: ./examples/UpdateSession.json
responses:
'200':
description: OK. Session has been updated.
schema:
$ref: '#/definitions/session_properties'
'401':
description: Unauthorized. Missing or invalid authorization.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
WWW-Authenticate:
description: >-
Describes the error encountered while trying to authenticate the
resource.
type: string
'403':
description: Forbidden. Authorization insufficient for given resource.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'404':
description: Not found. No session with the provided session ID exists.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'422':
description: >-
Unprocessable Entity. The maxLeaseTimeMinutes value was invalid. It
has to be bigger than the current value of maxLeaseTimeMinutes.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/error_response'
'429':
description: >-
Too Many Requests. The rate limit has been exceeded. Retry the
request after the duration given in the Retry-After header.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
Retry-After:
description: >-
The minimum number of seconds to wait before not getting this
response anymore.
type: integer
'500':
description: >-
Internal Error. Server has encountered an internal error. Retrying
the request may produce successful results.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/error_response'
tags:
- Rendering Session
summary: 'Microsoft Azure Updates The Max Lease Time Of A Particular Rendering Session'
description: Needs a more full description created.
/accounts/{account_id}/sessions/{session_id}/:stop:
post:
operationId: microsoftAzureRemoterenderingStopsession
produces:
- application/json
parameters:
- $ref: '#/parameters/api_version'
- $ref: '#/parameters/account_id'
- $ref: '#/parameters/session_id'
x-ms-examples:
Stop a session:
$ref: ./examples/StopSession.json
responses:
'204':
description: >-
NoContent. Stop request was successful. The rendering session is
stopped.
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'401':
description: Unauthorized. Missing or invalid authorization.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
WWW-Authenticate:
description: >-
Describes the error encountered while trying to authenticate the
resource.
type: string
'403':
description: Forbidden. Authorization insufficient for given resource.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'404':
description: Not found. No session with the provided session ID exists.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'429':
description: >-
Too Many Requests. The rate limit has been exceeded. Retry the
request after the duration given in the Retry-After header.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
Retry-After:
description: >-
The minimum number of seconds to wait before not getting this
response anymore.
type: integer
'500':
description: >-
Internal Error. Server has encountered an internal error. Retrying
the request may produce successful results.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/error_response'
tags:
- Rendering Session
summary: 'Microsoft Azure Stops A Particular Rendering Session'
description: Needs a more full description created.
/accounts/{account_id}/sessions:
get:
operationId: microsoftAzureRemoterenderingListsessions
produces:
- application/json
x-ms-pageable:
itemName: sessions
nextLinkName: '@nextLink'
parameters:
- $ref: '#/parameters/api_version'
- $ref: '#/parameters/account_id'
x-ms-examples:
List sessions:
$ref: ./examples/ListSessions.json
responses:
'200':
description: >-
OK. Returns the list of sessions which are in a 'Starting' or
'Ready' state.
schema:
$ref: '#/definitions/sessions_list'
'401':
description: Unauthorized. Missing or invalid authorization.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
WWW-Authenticate:
description: >-
Describes the error encountered while trying to authenticate the
resource.
type: string
'403':
description: Forbidden. Authorization insufficient for given resource.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
'429':
description: >-
Too Many Requests. The rate limit has been exceeded. Retry the
request after the duration given in the Retry-After header.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
Retry-After:
description: >-
The minimum number of seconds to wait before not getting this
response anymore.
type: integer
'500':
description: >-
Internal Error. Server has encountered an internal error. Retrying
the request may produce successful results.
x-ms-error-response: true
headers:
MS-CV:
description: >-
Microsoft Correlation Vector. Include this value when reporting
issues.
type: string
schema:
$ref: '#/definitions/error_response'
tags:
- Rendering Session
summary: 'Microsoft Azure Gets A List Of All Rendering Sessions'
description: Needs a more full description created.
definitions:
conversion:
description: The properties of the conversion.
properties:
id:
type: string
description: The ID of the conversion supplied when the conversion was created.
settings:
$ref: '#/definitions/conversion_settings'
output:
type: object
description: >-
Information about the output of a successful conversion. Only present
when the status of the conversion is 'Succeeded'.
properties:
outputAssetUri:
type: string
description: URI of the asset generated by the conversion process.
format: uri
example: >-
https://contoso.blob.core.windows.net/arr/architecture-output/house.arrAsset
readOnly: true
readOnly: true
error:
x-nullable: true
description: The error object containing details about the conversion failure.
type: object
$ref: '#/definitions/error'
example:
status:
$ref: '#/definitions/conversion_status'
creationTime:
type: string
description: >-
The time when the conversion was created. Date and time in ISO 8601
format.
format: date-time
required:
- id
- settings
- status
- error
- creationTime
type: object
conversion_list:
description: List of conversions.
properties:
conversions:
items:
$ref: '#/definitions/conversion'
type: array
description: The list of conversions.
'@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.
type: string
readOnly: true
required:
- conversions
type: object
conversion_input_settings:
properties:
storageContainerUri:
type: string
description: >-
The URI of the Azure blob storage container containing the input
model.
format: uri
example: https://contosostorage01.blob.core.windows.net/arrinput
storageContainerReadListSas:
type: string
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.
blobPrefix:
type: string
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.
example: models/
relativeInputAssetPath:
type: string
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.
example: house.fbx
required:
- storageContainerUri
- relativeInputAssetPath
type: object
description: Conversion input settings describe the origin of conversion input.
conversion_output_settings:
properties:
storageContainerUri:
type: string
description: >-
The URI of the Azure blob storage container where the result of the
conversion should be written to.
format: uri
example: https://contosostorage01.blob.core.windows.net/arroutput
storageContainerWriteSas:
type: string
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.
blobPrefix:
type: string
description: >-
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/mixedrealityremoterendering-openapi-original.yml