Struct RenderingSessionProperties

  • Article

Properties of a rendering session.

This information can be queried through RenderingSession.GetPropertiesAsync.

struct Microsoft::Azure::RemoteRendering::RenderingSessionProperties

Fields

Status

See RenderingSessionStatus.

Microsoft::Azure::RemoteRendering::RenderingSessionStatus Status{};

Size

See RenderingSessionVmSize.

Microsoft::Azure::RemoteRendering::RenderingSessionVmSize Size{};

Hostname

The name of the host machine on which the session is running.

std::string Hostname{};

Message

Session message.

If the RenderingSessionProperties.Status is RenderingSessionStatus.Error or RenderingSessionStatus.Expired, the message may contain additional information.

std::string Message{};

SizeString

String representation of the server size.

std::string SizeString{};

See also

Id

A string holding a unique ID for the session.

std::string Id{};

ElapsedTimeInMinutes

How long the session has been active (in minutes).

int32_t ElapsedTimeInMinutes{};

MaxLeaseInMinutes

The currently set lease duration for the session, in minutes. If RenderingSessionProperties.ElapsedTimeInMinutes reaches this value, the session will be shut down automatically.

int32_t MaxLeaseInMinutes{};

See also

HandshakePort

Session handshake port.

int32_t HandshakePort{};

ArrInspectorPort

ArrInspector port.

int32_t ArrInspectorPort{};

See also