Remote Rendering - Stop Session

Reference

Service:: Mixed Reality

API Version:: 2021-01-01

Stops a particular rendering session.

POST {endpoint}/accounts/{account_id}/sessions/{session_id}/:stop?api-version=2021-01-01

URI Parameters

Name	In	Required	Type	Description
account_id	path	True	string uuid	The Azure Remote Rendering account ID.
endpoint	path	True	string	The endpoint to use e.g. https://remoterendering.eastus.mixedreality.azure.com. A list can be found at https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	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.
api-version	query	True	string	The API version to be used with the HTTP request.

Request Header

Name	Required	Type	Description
Authorization	True	string	A bearer token returned by the Mixed Reality Secure Token Service. See https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens for details.

Responses

Name	Type	Description
204 No Content		NoContent. Stop request was successful. The rendering session is stopped. Headers MS-CV: string
401 Unauthorized		Unauthorized. Missing or invalid authorization. Headers MS-CV: string WWW-Authenticate: string
403 Forbidden		Forbidden. Authorization insufficient for given resource. Headers MS-CV: string
404 Not Found		Not found. No session with the provided session ID exists. Headers MS-CV: string
429 Too Many Requests		Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header. Headers MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Internal Error. Server has encountered an internal error. Retrying the request may produce successful results. Headers MS-CV: string

Security

Authorization

A bearer token returned by the Mixed Reality Secure Token Service. See https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens for details.

Type: apiKey
In: header

Examples

Stop a session

Sample request

HTTP

POST https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/sessions/contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28/:stop?api-version=2021-01-01

Sample response

Status code:: 204

MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 401

WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 429

Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "InternalServerError",
    "message": "An internal server error occurred."
  }
}

Definitions

Name	Description
error	The error object containing details of why the request failed.
error_response	The error response containing details of why the request failed.

error

The error object containing details of why the request failed.

Name	Type	Description
code	string	Error code.
details	error[]	An array of details about specific errors that led to this reported error.
innerError	error	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the particular error (e.g., the name of the property in error).

error_response

The error response containing details of why the request failed.

Name	Type	Description
error	error	The error object containing details of why the request failed.

Share via