Remote Rendering - Create Session

Referenz

Dienst:: Mixed Reality

API-Version:: 2021-01-01

Erstellt eine neue Renderingsitzung.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
account_id	path	True	string (uuid)	Die Azure Remote Rendering-Konto-ID.
endpoint	path	True	string	Der zu verwendende Endpunkt, z. B. https://remoterendering.eastus.mixedreality.azure.com. Eine Liste finden Sie unter https://docs.microsoft.com/azure/remote-rendering/reference/regions.
session_id	path	True	string	Eine ID, die die Renderingsitzung für das angegebene Konto eindeutig identifiziert. Bei der ID wird die Groß-/Kleinschreibung beachtet, kann eine beliebige Kombination aus alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten und darf nicht mehr als 256 Zeichen enthalten.
api-version	query	True	string	Die API-Version, die mit der HTTP-Anforderung verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein Bearertoken, das vom Mixed Reality Secure Token Service zurückgegeben wird. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
maxLeaseTimeMinutes	True	integer	Die Zeit in Minuten wird ausgeführt, nachdem der Zustand "Bereit" erreicht wurde. Es muss zwischen 0 und 1440 sein.
size	True	session_size	Die Größe des Servers, der für die Renderingsitzung verwendet wird. Die Größe wirkt sich auf die Anzahl der Polygone aus, die der Server rendern kann. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.

Antworten

Name	Typ	Beschreibung
200 OK	session_properties	OKAY. Gibt an, dass bereits eine Sitzung mit den gleichen Einstellungen vorhanden war. Dies wird erwartet, wenn die Sitzungserstellung erneut ausgeführt wird.
201 Created	session_properties	Erstellt. Die Sitzung wurde erfolgreich erstellt. Header MS-CV: string
400 Bad Request	error_response	Ungültige Anforderung; Das zurückgegebene Fehlerobjekt beschreibt, welche Probleme aufgetreten sind. Header MS-CV: string
401 Unauthorized		Unbefugt. Fehlende oder ungültige Autorisierung. Header MS-CV: string WWW-Authenticate: string
403 Forbidden		Verboten. Die Autorisierung ist für bestimmte Ressourcen nicht ausreichend. Header MS-CV: string
429 Too Many Requests		Zu viele Anforderungen. Das Zinslimit wurde überschritten. Wiederholen Sie die Anforderung nach der im Retry-After Header angegebenen Dauer. Header MS-CV: string Retry-After: integer
500 Internal Server Error	error_response	Interner Fehler. Auf dem Server ist ein interner Fehler aufgetreten. Das Wiederholen der Anforderung kann zu erfolgreichen Ergebnissen führen. Header MS-CV: string
Other Status Codes	error_response	Konflikt. Für das Remoterenderingkonto ist bereits eine Renderingsitzung mit der ID vorhanden.

Sicherheit

Authorization

Ein Bearertoken, das vom Mixed Reality Secure Token Service zurückgegeben wird. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.

Typ: apiKey
In: header

Beispiele

Create a rendering session

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
create_session_settings	Einstellungen der zu erstellenden Sitzung.
error	Das Fehlerobjekt, das Details enthält, warum die Anforderung fehlgeschlagen ist.
error_response	Die Fehlerantwort mit Details dazu, warum die Anforderung fehlgeschlagen ist.
session_properties	Die Eigenschaften einer Renderingsitzung.
session_size	Die Größe des Servers, der für die Renderingsitzung verwendet wird. Die Größe wirkt sich auf die Anzahl der Polygone aus, die der Server rendern kann. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.
session_status	Der Status der Renderingsitzung. Terminalzustände sind "Error", "Expired" und "Stopped".

create_session_settings

Objekt

Einstellungen der zu erstellenden Sitzung.

Name	Typ	Beschreibung
maxLeaseTimeMinutes	integer	Die Zeit in Minuten wird ausgeführt, nachdem der Zustand "Bereit" erreicht wurde. Es muss zwischen 0 und 1440 sein.
size	session_size	Die Größe des Servers, der für die Renderingsitzung verwendet wird. Die Größe wirkt sich auf die Anzahl der Polygone aus, die der Server rendern kann. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.

error

Objekt

Das Fehlerobjekt, das Details enthält, warum die Anforderung fehlgeschlagen ist.

Name	Typ	Beschreibung
code	string	Fehlercode.
details	error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innerError	error	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des bestimmten Fehlers (z. B. der Name der Eigenschaft im Fehler).

error_response

Objekt

Die Fehlerantwort mit Details dazu, warum die Anforderung fehlgeschlagen ist.

Name	Typ	Beschreibung
error	error	Das Fehlerobjekt, das Details enthält, warum die Anforderung fehlgeschlagen ist.

session_properties

Objekt

Die Eigenschaften einer Renderingsitzung.

Name	Typ	Beschreibung
arrInspectorPort	integer minimum: 49152 maximum: 65534	Der TCP-Port, an dem das Azure Remote Rendering Inspector-Tool gehostet wird.
creationTime	string (date-time)	Der Zeitpunkt, zu dem die Renderingsitzung erstellt wurde. Datum und Uhrzeit im ISO 8601-Format.
elapsedTimeMinutes	integer	Der Zeitraum in Minuten, in dem die Sitzung liegt oder war im Zustand "Bereit". Die Zeit wird auf eine volle Minute aufgerundet.
error	error	Das Fehlerobjekt, das Details zum Startfehler der Renderingsitzung enthält.
handshakePort	integer minimum: 49152 maximum: 65534	Der TCP-Port, der beim Herstellen einer Verbindung für den Handshake verwendet wird.
hostname	string	Der Hostname, unter dem die Renderingsitzung erreichbar ist.
id	string	Die ID der Sitzung, die beim Erstellen der Sitzung angegeben wurde.
maxLeaseTimeMinutes	integer	Die Zeit in Minuten wird ausgeführt, nachdem der Zustand "Bereit" erreicht wurde.
size	session_size	Die Größe des Servers, der für die Renderingsitzung verwendet wird. Die Größe wirkt sich auf die Anzahl der Polygone aus, die der Server rendern kann. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.
status	session_status	Der Status der Renderingsitzung. Terminalzustände sind "Error", "Expired" und "Stopped".
teraflops	number (float)	Die Rechenleistung der Renderingsitzungs-GPU, gemessen in Teraflops.

session_size

Enumeration

Die Größe des Servers, der für die Renderingsitzung verwendet wird. Die Größe wirkt sich auf die Anzahl der Polygone aus, die der Server rendern kann. Weitere Informationen finden Sie unter https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes.

Wert	Beschreibung
Premium	Premium-Renderingsitzungsgröße.
Standard	Standardrenderingsitzungsgröße.

session_status

Enumeration

Der Status der Renderingsitzung. Terminalzustände sind "Error", "Expired" und "Stopped".

Wert	Beschreibung
Error	Bei der Renderingsitzung ist ein Fehler aufgetreten und kann nicht verwendet werden. Dies ist ein Terminalzustand.
Expired	Die Renderingsitzung wechselt in den Zustand "Abgelaufen", wenn sie länger als die Leasezeit im Zustand "Bereit" war. Dies ist ein Terminalzustand.
Ready	Die Renderingsitzung ist für eingehende Verbindungen bereit.
Starting	Die Renderingsitzung wird gestartet, akzeptiert aber noch keine eingehenden Verbindungen.
Stopped	Die Renderingsitzung wurde mit dem Vorgang "Sitzung beenden" beendet. Dies ist ein Terminalzustand.

Freigeben über

Remote Rendering - Create Session

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Authorization

Beispiele

Create a rendering session

Beispielanforderung

Beispiel für eine Antwort

Definitionen

create_session_settings

error

error_response

session_properties

session_size

session_status