Remote Rendering - Update Session

Referentie

Service:: Mixed Reality

API-versie:: 2021-01-01

Hiermee wordt de maximale leasetijd van een bepaalde renderingsessie bijgewerkt.

PATCH {endpoint}/accounts/{account_id}/sessions/{session_id}?api-version=2021-01-01

URI-parameters

Name	In	Vereist	Type	Description
account_id	path	True	string (uuid)	De account-id van Azure Remote Rendering.
endpoint	path	True	string	Het eindpunt dat moet worden gebruikt, bijvoorbeeld https://remoterendering.eastus.mixedreality.azure.com. Een lijst is te vinden op https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	Een id die de renderingsessie voor het opgegeven account uniek identificeert. De id is hoofdlettergevoelig, kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens en mag niet meer dan 256 tekens bevatten.
api-version	query	True	string	De API-versie die moet worden gebruikt met de HTTP-aanvraag.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Een bearer-token dat wordt geretourneerd door de Mixed Reality Secure Token Service. Zie https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens voor meer informatie.

Aanvraagbody

Name	Vereist	Type	Description
maxLeaseTimeMinutes	True	integer	Werk bij tot het tijdstip waarop de sessie wordt uitgevoerd nadat deze de status Gereed heeft bereikt. Deze moet groter zijn dan de huidige waarde van maxLeaseTimeMinutes en kleiner dan 1440.

Antwoorden

Name	Type	Description
200 OK	session_properties	OK. Sessie is bijgewerkt.
401 Unauthorized		Ongeoorloofd. Ontbrekende of ongeldige autorisatie. Kopteksten MS-CV: string WWW-Authenticate: string
403 Forbidden		Verboden. Autorisatie is onvoldoende voor de gegeven resource. Kopteksten MS-CV: string
404 Not Found		Niet gevonden. Er bestaat geen sessie met de opgegeven sessie-id. Kopteksten MS-CV: string
422 Unprocessable Entity	error_response	Niet-verwerkte entiteit. De waarde maxLeaseTimeMinutes is ongeldig. Deze moet groter zijn dan de huidige waarde van maxLeaseTimeMinutes. Kopteksten MS-CV: string
429 Too Many Requests		Te veel aanvragen. De frequentielimiet is overschreden. Voer de aanvraag opnieuw uit na de duur die is opgegeven in de Retry-After header. Kopteksten MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Interne fout. Er is een interne fout opgetreden in de server. Het opnieuw proberen van de aanvraag kan resultaten opleveren. Kopteksten MS-CV: string

Beveiliging

Authorization

Een bearer-token dat wordt geretourneerd door de Mixed Reality Secure Token Service. Zie https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens voor meer informatie.

Type: apiKey
In: header

Voorbeelden

Update a session

Voorbeeldaanvraag

HTTP

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

{
  "maxLeaseTimeMinutes": 72
}

Voorbeeldrespons

Statuscode:: 200

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "arrInspectorPort": 50052,
  "handshakePort": 50051,
  "elapsedTimeMinutes": 10,
  "hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com",
  "maxLeaseTimeMinutes": 72,
  "size": "Standard",
  "status": "Ready",
  "error": null,
  "teraflops": 10.6
}

Statuscode:: 401

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

Statuscode:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuscode:: 404

MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuscode:: 422

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "UnprocessableEntity",
    "message": "The request was malformed."
  }
}

Statuscode:: 429

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

Statuscode:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definities

Name	Description
error	Het foutobject met details van de reden waarom de aanvraag is mislukt.
error_response	Het foutbericht met details van de reden waarom de aanvraag is mislukt.
session_properties	De eigenschappen van een renderingsessie.
session_size	De grootte van de server die wordt gebruikt voor de renderingsessie. De grootte is van invloed op het aantal veelhoeken dat door de server kan worden weergegeven. Raadpleeg https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes voor meer informatie.
session_status	De status van de renderingsessie. Terminalstatussen zijn 'Fout', 'Verlopen' en 'Gestopt'.
update_session_settings	Instellingen die worden gebruikt om de sessie bij te werken.

error

Object

Het foutobject met details van de reden waarom de aanvraag is mislukt.

Name	Type	Description
code	string	Foutcode.
details	error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innerError	error	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

error_response

Object

Het foutbericht met details van de reden waarom de aanvraag is mislukt.

Name	Type	Description
error	error	Het foutobject met details van de reden waarom de aanvraag is mislukt.

session_properties

Object

De eigenschappen van een renderingsessie.

Name	Type	Description
arrInspectorPort	integer minimum: 49152 maximum: 65534	De TCP-poort waarop het hulpprogramma Azure Remote Rendering Inspector wordt gehost.
creationTime	string (date-time)	Het tijdstip waarop de renderingsessie is gemaakt. Datum en tijd in ISO 8601-indeling.
elapsedTimeMinutes	integer	De hoeveelheid tijd in minuten dat de sessie de status Gereed heeft of heeft. De tijd wordt naar beneden afgerond op een volledige minuut.
error	error	Het foutobject met details over de opstartfout van de renderingsessie.
handshakePort	integer minimum: 49152 maximum: 65534	De TCP-poort die wordt gebruikt voor de handshake bij het tot stand brengen van een verbinding.
hostname	string	De hostnaam waaronder de renderingsessie bereikbaar is.
id	string	De id van de sessie die is opgegeven toen de sessie werd gemaakt.
maxLeaseTimeMinutes	integer	De tijd in minuten wordt de sessie uitgevoerd nadat de status Gereed is bereikt.
size	session_size	De grootte van de server die wordt gebruikt voor de renderingsessie. De grootte is van invloed op het aantal veelhoeken dat door de server kan worden weergegeven. Raadpleeg https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes voor meer informatie.
status	session_status	De status van de renderingsessie. Terminalstatussen zijn 'Fout', 'Verlopen' en 'Gestopt'.
teraflops	number (float)	De rekenkracht van de renderingsessie GPU gemeten in teraflops.

session_size

Inventarisatie

De grootte van de server die wordt gebruikt voor de renderingsessie. De grootte is van invloed op het aantal veelhoeken dat door de server kan worden weergegeven. Raadpleeg https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes voor meer informatie.

Waarde	Description
Premium	Premium-renderingsessiegrootte.
Standard	Standaardweergavesessiegrootte.

session_status

Inventarisatie

De status van de renderingsessie. Terminalstatussen zijn 'Fout', 'Verlopen' en 'Gestopt'.

Waarde	Description
Error	Er is een fout opgetreden in de renderingsessie en is onbruikbaar. Dit is een terminalstatus.
Expired	De renderingsessie voert de status Verlopen in wanneer de status Gereed langer is dan de leasetijd. Dit is een terminalstatus.
Ready	De renderingsessie is gereed voor binnenkomende verbindingen.
Starting	De renderingsessie wordt gestart, maar accepteert nog geen binnenkomende verbindingen.
Stopped	De renderingsessie is gestopt met de bewerking Sessie stoppen. Dit is een terminalstatus.

update_session_settings

Object

Instellingen die worden gebruikt om de sessie bij te werken.

Name	Type	Description
maxLeaseTimeMinutes	integer	Werk bij tot het tijdstip waarop de sessie wordt uitgevoerd nadat deze de status Gereed heeft bereikt. Deze moet groter zijn dan de huidige waarde van maxLeaseTimeMinutes en kleiner dan 1440.

Delen via

Remote Rendering - Update Session

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

Authorization

Voorbeelden

Update a session

Voorbeeldaanvraag

Voorbeeldrespons

Definities

error

error_response

session_properties

session_size

session_status

update_session_settings

Aanvullende resources