Remote Rendering - Create Session

Referens

Tjänst:: Mixed Reality

API-version:: 2021-01-01

Skapar en ny återgivningssession.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
account_id	path	True	string (uuid)	Konto-ID för Azure Remote Rendering.
endpoint	path	True	string	Slutpunkten som ska användas, t.ex. https://remoterendering.eastus.mixedreality.azure.com. En lista finns på https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	Ett ID som unikt identifierar återgivningssessionen för det angivna kontot. ID:t är skiftlägeskänsligt, kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 256 tecken.
api-version	query	True	string	DEN API-version som ska användas med HTTP-begäran.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En ägartoken som returneras av Tjänsten för säker token för Mixed Reality. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Begärandetext

Name	Obligatorisk	Typ	Description
maxLeaseTimeMinutes	True	integer	Tiden i minuter sessionen körs efter att ha nått tillståndet "Redo". Det måste vara mellan 0 och 1440.
size	True	session_size	Storleken på servern som används för återgivningssessionen. Storleken påverkar antalet polygoner som servern kan rendera. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.

Svar

Name	Typ	Description
200 OK	session_properties	OKEJ. Anger att det redan fanns en session med samma inställningar. Detta förväntas när sessionen skapas igen.
201 Created	session_properties	Skapad. Sessionen har skapats. Sidhuvuden MS-CV: string
400 Bad Request	error_response	Felaktig begäran. Det returnerade felobjektet beskriver vilka problem som har uppstått. Sidhuvuden MS-CV: string
401 Unauthorized		Obehörig. Auktorisering saknas eller är ogiltig. Sidhuvuden MS-CV: string WWW-Authenticate: string
403 Forbidden		Förbjuden. Auktoriseringen är otillräcklig för den angivna resursen. Sidhuvuden MS-CV: string
429 Too Many Requests		För många begäranden. Hastighetsgränsen har överskridits. Försök igen efter varaktigheten som anges i Retry-After-huvudet. Sidhuvuden MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Internt fel. Servern har påträffat ett internt fel. Ett nytt försök med begäran kan ge lyckade resultat. Sidhuvuden MS-CV: string
Other Status Codes	error_response	Konflikt. Det finns redan en renderingssession med ID:t för fjärråtergivningskontot.

Säkerhet

Authorization

En ägartoken som returneras av Tjänsten för säker token för Mixed Reality. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
I: header

Exempel

Create a rendering session

Exempelbegäran

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"
}

Exempelsvar

Statuskod:: 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
}

Statuskod:: 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
}

Statuskod:: 400

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Statuskod:: 409

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Statuskod:: 401

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

Statuskod:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Statuskod:: 429

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

Statuskod:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

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

Definitioner

Name	Description
create_session_settings	Inställningar för sessionen som ska skapas.
error	Felobjektet som innehåller information om varför begäran misslyckades.
error_response	Felsvaret innehåller information om varför begäran misslyckades.
session_properties	Egenskaperna för en återgivningssession.
session_size	Storleken på servern som används för återgivningssessionen. Storleken påverkar antalet polygoner som servern kan rendera. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.
session_status	Status för återgivningssessionen. Terminaltillstånden är "Error", "Expired" och "Stopped".

create_session_settings

Objekt

Inställningar för sessionen som ska skapas.

Name	Typ	Description
maxLeaseTimeMinutes	integer	Tiden i minuter sessionen körs efter att ha nått tillståndet "Redo". Det måste vara mellan 0 och 1440.
size	session_size	Storleken på servern som används för återgivningssessionen. Storleken påverkar antalet polygoner som servern kan rendera. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.

error

Objekt

Felobjektet som innehåller information om varför begäran misslyckades.

Name	Typ	Description
code	string	Felkod.
details	error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innerError	error	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för det specifika felet (t.ex. namnet på egenskapen i fel).

error_response

Objekt

Felsvaret innehåller information om varför begäran misslyckades.

Name	Typ	Description
error	error	Felobjektet som innehåller information om varför begäran misslyckades.

session_properties

Objekt

Egenskaperna för en återgivningssession.

Name	Typ	Description
arrInspectorPort	integer minimum: 49152 maximum: 65534	TCP-porten där verktyget Azure Remote Rendering Inspector finns.
creationTime	string (date-time)	Tiden då återgivningssessionen skapades. Datum och tid i ISO 8601-format.
elapsedTimeMinutes	integer	Hur lång tid i minuter sessionen är eller var i tillståndet "Redo". Tiden avrundas ned till en hel minut.
error	error	Felobjektet som innehåller information om återgivningssessionens startfel.
handshakePort	integer minimum: 49152 maximum: 65534	TCP-porten som används för handskakningen när du upprättar en anslutning.
hostname	string	Värdnamnet under vilket återgivningssessionen kan nås.
id	string	ID för den session som angavs när sessionen skapades.
maxLeaseTimeMinutes	integer	Tiden i minuter sessionen körs efter att ha nått tillståndet "Redo".
size	session_size	Storleken på servern som används för återgivningssessionen. Storleken påverkar antalet polygoner som servern kan rendera. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.
status	session_status	Status för återgivningssessionen. Terminaltillstånden är "Error", "Expired" och "Stopped".
teraflops	number (float)	Beräkningskraften för återgivningssessionens GPU mätt i teraflops.

session_size

Uppräkning

Storleken på servern som används för återgivningssessionen. Storleken påverkar antalet polygoner som servern kan rendera. Mer information finns i https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.

Värde	Description
Premium	Sessionsstorlek för Premium-rendering.
Standard	Standardåtergivning av sessionsstorlek.

session_status

Uppräkning

Status för återgivningssessionen. Terminaltillstånden är "Error", "Expired" och "Stopped".

Värde	Description
Error	Renderingssessionen har påträffat ett fel och kan inte användas. Det här är ett terminaltillstånd.
Expired	Renderingssessionen anger tillståndet "Har upphört att gälla" när den har varit i tillståndet "Klar" längre än dess lånetid. Det här är ett terminaltillstånd.
Ready	Återgivningssessionen är redo för inkommande anslutningar.
Starting	Återgivningssessionen startar men accepterar inte inkommande anslutningar ännu.
Stopped	Återgivningssessionen har stoppats med åtgärden "Stoppa session". Det här är ett terminaltillstånd.

Dela via

Remote Rendering - Create Session

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

Authorization

Exempel

Create a rendering session

Exempelbegäran

Exempelsvar

Definitioner

create_session_settings

error

error_response

session_properties

session_size

session_status

Ytterligare resurser