Share via


SessionHost Class

Definition

Represents a SessionHost definition.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.SessionHostTypeConverter))]
public class SessionHost : Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.ISessionHost, Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.SessionHostTypeConverter))>]
type SessionHost = class
    interface ISessionHost
    interface IJsonSerializable
    interface IResource
    interface IValidates
Public Class SessionHost
Implements ISessionHost, IValidates
Inheritance
SessionHost
Attributes
Implements

Constructors

SessionHost()

Creates an new SessionHost instance.

Properties

AgentVersion

Version of agent on SessionHost.

AllowNewSession

Allow a new session.

AssignedUser

User assigned to SessionHost.

FriendlyName

Friendly name of SessionHost

HealthCheckResult

List of SessionHostHealthCheckReports

Id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

LastHeartBeat

Last heart beat from SessionHost.

LastUpdateTime

The timestamp of the last update.

Name

The name of the resource

ObjectId

ObjectId of SessionHost. (internal use)

OSVersion

The version of the OS on the session host.

ResourceGroupName

Gets the resource group name

ResourceId

Resource Id of SessionHost's underlying virtual machine.

Session

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.

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Type

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

UpdateErrorMessage

The error message.

UpdateState

Update state of a SessionHost.

VirtualMachineId

Virtual Machine Id of SessionHost's underlying virtual machine.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of SessionHost.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of SessionHost.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.ISessionHost.

FromJsonString(String)

Creates a new instance of SessionHost, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of SessionHost into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to