Remote Rendering - Create Session

Service:

Mixed Reality

API-versie:

2021-01-01

Hiermee maakt u een nieuwe renderingsessie.

PUT {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 de Azure Remote Rendering.
endpoint	path	True	string	Het eindpunt dat moet worden gebruikt, bijvoorbeeld https://remoterendering.eastus.mixedreality.azure.com. Een lijst vindt u 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 een willekeurige 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	De tijd in minuten dat de sessie wordt uitgevoerd nadat de status Gereed is bereikt. Het moet tussen 0 en 1440 zijn.
size	True	session_size	De grootte van de server die wordt gebruikt voor de renderingsessie. De grootte is van invloed op het aantal veelhoeken dat de server kan weergeven. Raadpleeg voor https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes meer informatie.

Antwoorden

Name	Type	Description
200 OK	session_properties	OK. Geeft aan dat er al een sessie met dezelfde instellingen aanwezig was. Dit wordt verwacht wanneer opnieuw wordt geprobeerd een sessie te maken.
201 Created	session_properties	Gemaakt. De sessie is gemaakt. Kopteksten MS-CV: string
400 Bad Request	error_response	Ongeldige aanvraag. Het geretourneerde foutobject beschrijft welke problemen zijn opgetreden. Kopteksten MS-CV: string
401 Unauthorized		Onbevoegd. Ontbrekende of ongeldige autorisatie. Kopteksten MS-CV: string WWW-Authenticate: string
403 Forbidden		Verboden. Autorisatie is onvoldoende voor de opgegeven resource. 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 op de server. Het opnieuw proberen van de aanvraag kan succesvolle resultaten opleveren. Kopteksten MS-CV: string
Other Status Codes	error_response	Conflict. Er bestaat al een renderingsessie met de id voor het remote rendering-account.

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

Create a rendering session

Voorbeeldaanvraag

HTTP

PUT 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": 60,
  "size": "Standard"
}

Voorbeeldrespons

Statuscode:

201

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}

Statuscode:

200

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28",
  "creationTime": "2020-11-11T11:11:11.111Z",
  "maxLeaseTimeMinutes": 60,
  "size": "Standard",
  "status": "Starting",
  "error": null
}

Statuscode:

400

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Statuscode:

409

MS-CV: dKEFmka2kkSlDmp/af+sOw

{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}

Statuscode:

401

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

Statuscode:

403

MS-CV: dKEFmka2kkSlDmp/af+sOw

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
create_session_settings	Instellingen van de sessie die moet worden gemaakt.
error	Het foutobject met details over waarom de aanvraag is mislukt.
error_response	Het foutantwoord met details over 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 de server kan weergeven. Raadpleeg voor https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes meer informatie.
session_status	De status van de renderingsessie. Terminalstatussen zijn 'Fout', 'Verlopen' en 'Gestopt'.

create_session_settings

Instellingen van de sessie die moet worden gemaakt.

Name	Type	Description
maxLeaseTimeMinutes	integer	De tijd in minuten dat de sessie wordt uitgevoerd nadat de status Gereed is bereikt. Het moet tussen 0 en 1440 zijn.
size	session_size	De grootte van de server die wordt gebruikt voor de renderingsessie. De grootte is van invloed op het aantal veelhoeken dat de server kan weergeven. Raadpleeg voor https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes meer informatie.

error

Het foutobject met details over waarom de aanvraag is mislukt.

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

error_response

Het foutantwoord met details over waarom de aanvraag is mislukt.

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

session_properties

De eigenschappen van een renderingsessie.

Name	Type	Description
arrInspectorPort	integer	De TCP-poort waarop het hulpprogramma Azure Remote Rendering Inspector wordt gehost.
creationTime	string	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 fout bij het starten van de renderingsessie.
handshakePort	integer	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 dat de sessie wordt 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 de server kan weergeven. Raadpleeg voor https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes meer informatie.
status	session_status	De status van de renderingsessie. Terminalstatussen zijn 'Fout', 'Verlopen' en 'Gestopt'.
teraflops	number	De rekenkracht van de GPU van de renderingsessie, gemeten in teraflops.

session_size

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

Name	Type	Description
Premium	string	Premium-renderingsessiegrootte.
Standard	string	Standaardgrootte van renderingsessies.

session_status

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

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