Remote Rendering - Stop Session

Référence

Service:: Mixed Reality

API Version:: 2021-01-01

Arrête une session de rendu particulière.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
account_id	path	True	string uuid	ID de compte Azure Remote Rendering.
endpoint	path	True	string	Point de terminaison à utiliser, par exemple https://remoterendering.eastus.mixedreality.azure.com. Vous trouverez une liste à l’adresse https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	ID identifiant de manière unique la session de rendu pour le compte donné. L’ID respecte la casse, peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement, et ne peut pas contenir plus de 256 caractères.
api-version	query	True	string	Version de l’API à utiliser avec la requête HTTP.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Jeton du porteur retourné par le service de jeton sécurisé Mixed Reality. Pour plus d'informations, consultez https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Réponses

Nom	Type	Description
204 No Content		NoContent. La demande d’arrêt a réussi. La session de rendu est arrêtée. Headers MS-CV: string
401 Unauthorized		Non autorisé. Autorisation manquante ou non valide. Headers MS-CV: string WWW-Authenticate: string
403 Forbidden		Interdit. Autorisation insuffisante pour une ressource donnée. Headers MS-CV: string
404 Not Found		Introuvable. Il n’existe aucune session avec l’ID de session fourni. Headers MS-CV: string
500 Internal Server Error	error_response	Erreur interne. Le serveur a rencontré une erreur interne. La nouvelle tentative de la demande peut produire des résultats réussis. Headers MS-CV: string
Other Status Codes		Trop de demandes. La limite de débit a été dépassée. Réessayez la demande après la durée indiquée dans l’en-tête Retry-After. Headers MS-CV: string Retry-After: integer

Sécurité

Authorization

Jeton du porteur retourné par le service de jeton sécurisé Mixed Reality. Pour plus d'informations, consultez https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Type: apiKey
In: header

Exemples

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

Response Body

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

Définitions

Nom	Description
error	Objet d’erreur contenant les détails de la raison de l’échec de la demande.
error_response	Réponse d’erreur contenant les détails de l’échec de la demande.

error

Objet d’erreur contenant les détails de la raison de l’échec de la demande.

Nom	Type	Description
code	string	Code d’erreur.
details	error[]	Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée.
innerError	error	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur).

error_response

Réponse d’erreur contenant les détails de l’échec de la demande.

Nom	Type	Description
error	error	Objet d’erreur contenant les détails de la raison de l’échec de la demande.

Partager via