Share via

SessionHost interface

  • Reference
Package:
@azure/arm-desktopvirtualization

Represents a SessionHost definition.

Extends
Resource

Properties

agentVersion

Version of agent on SessionHost.
allowNewSession

Allow a new session.
assignedUser

User assigned to SessionHost.
friendlyName

Friendly name of SessionHost
lastHeartBeat

Last heart beat from SessionHost.
lastUpdateTime

The timestamp of the last update. NOTE: This property will not be serialized. It can only be populated by the server.
objectId

ObjectId of SessionHost. (internal use) NOTE: This property will not be serialized. It can only be populated by the server.
osVersion

The version of the OS on the session host.
resourceId

Resource Id of SessionHost's underlying virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
sessionHostHealthCheckResults

List of SessionHostHealthCheckReports NOTE: This property will not be serialized. It can only be populated by the server.
sessions

Number of sessions on SessionHost.
status

Status for a SessionHost.
statusTimestamp

The timestamp of the status. NOTE: This property will not be serialized. It can only be populated by the server.
sxSStackVersion

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

The error message.
updateState

Update state of a SessionHost.
virtualMachineId

Virtual Machine Id of SessionHost's underlying virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

agentVersion

Version of agent on SessionHost.

agentVersion?: string

Property Value

string

allowNewSession

Allow a new session.

allowNewSession?: boolean

Property Value

boolean

assignedUser

User assigned to SessionHost.

assignedUser?: string

Property Value

string

friendlyName

Friendly name of SessionHost

friendlyName?: string

Property Value

string

lastHeartBeat

Last heart beat from SessionHost.

lastHeartBeat?: Date

Property Value

Date

lastUpdateTime

The timestamp of the last update. NOTE: This property will not be serialized. It can only be populated by the server.

lastUpdateTime?: Date

Property Value

Date

objectId

ObjectId of SessionHost. (internal use) NOTE: This property will not be serialized. It can only be populated by the server.

objectId?: string

Property Value

string

osVersion

The version of the OS on the session host.

osVersion?: string

Property Value

string

resourceId

Resource Id of SessionHost's underlying virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

resourceId?: string

Property Value

string

sessionHostHealthCheckResults

List of SessionHostHealthCheckReports NOTE: This property will not be serialized. It can only be populated by the server.

sessionHostHealthCheckResults?: SessionHostHealthCheckReport[]

Property Value

SessionHostHealthCheckReport[]

sessions

Number of sessions on SessionHost.

sessions?: number

Property Value

number

status

Status for a SessionHost.

status?: string

Property Value

string

statusTimestamp

The timestamp of the status. NOTE: This property will not be serialized. It can only be populated by the server.

statusTimestamp?: Date

Property Value

Date

sxSStackVersion

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

sxSStackVersion?: string

Property Value

string

updateErrorMessage

The error message.

updateErrorMessage?: string

Property Value

string

updateState

Update state of a SessionHost.

updateState?: string

Property Value

string

virtualMachineId

Virtual Machine Id of SessionHost's underlying virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

virtualMachineId?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From Resource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type