SessionHostData Class

Definition

A class representing the SessionHost data model. Represents a SessionHost definition.

public class SessionHostData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DesktopVirtualization.SessionHostData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DesktopVirtualization.SessionHostData>
type SessionHostData = class
    inherit ResourceData
    interface IJsonModel<SessionHostData>
    interface IPersistableModel<SessionHostData>
Public Class SessionHostData
Inherits ResourceData
Implements IJsonModel(Of SessionHostData), IPersistableModel(Of SessionHostData)
Inheritance
SessionHostData
Implements

Constructors

SessionHostData()

Initializes a new instance of SessionHostData.

Properties

AgentVersion

Version of agent on SessionHost.

AllowNewSession

Allow a new session.

AssignedUser

User assigned to SessionHost.

FriendlyName

Friendly name of SessionHost.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
LastHeartBeatOn

Last heart beat from SessionHost.

LastUpdatedOn

The timestamp of the last update.

Name

The name of the resource.

(Inherited from ResourceData)
ObjectId

ObjectId of SessionHost. (internal use).

OSVersion

The version of the OS on the session host.

ResourceId

Resource Id of SessionHost's underlying virtual machine.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
SessionHostHealthCheckResults

List of SessionHostHealthCheckReports.

Sessions

Number of sessions on SessionHost.

Status

Status for a SessionHost.

StatusTimestamp

The timestamp of the status.

SxsStackVersion

The version of the side by side stack on the session host.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
UpdateErrorMessage

The error message.

UpdateState

Update state of a SessionHost.

VmId

Virtual Machine Id of SessionHost's underlying virtual machine.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Explicit Interface Implementations

IJsonModel<SessionHostData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SessionHostData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SessionHostData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SessionHostData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SessionHostData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to