Session

List AVD Host Sessions

get

Retrieve a list of Host Sessions by Site Id.

Query parameters
SiteIdinteger · int32Optional

Site Id from which to retrieve the Host VM list (optional).

UserstringOptional

The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.

Responses
chevron-right
200

Success

application/json; api-version=1.0

AVD Host System Session Information.

idstring · nullableOptional

ID of RAS Agent.

siteIdinteger · int32Optional

ID of Site.

agentStatestring · enumOptional

Agent State

Possible values:
serverTypestring · enumOptional

RAS Status Type

Possible values:
agentVerstring · nullableOptional

Agent Version.

serverstring · nullableOptional

Server name.

serverOSstring · nullableOptional

Server Operating System.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

machineIdstring · nullableOptional

Id of the machine

logLevelstring · enumOptional

RAS Log Level

Possible values:
cpuLoadinteger · int32Optional

CPU load percentage.

memLoadinteger · int32Optional

Memory load percentage.

diskReadinteger · int32Optional

Disk Read.

diskWriteinteger · int32Optional

Disk Write.

enabledbooleanOptional

Whether the object is enabled or not.

hostIPstring · nullableOptional

Host IP Address.

powerStatestring · enumOptional

Power State

Possible values:
assignmentstring · enumOptional

Host Assignment Type

Possible values:
userstring · nullableOptional

User.

disksstring · nullableOptional

Disk(s).

avdAgentstring · nullableOptional

AVD Agent name.

subnetNamestring · nullableOptional

Subnet name.

get
/api/Provider/VM/AVDHost/Session

List AVD Host Sessions by Provider Id

get

Retrieve a list of Host Sessions by Provider Id.

Path parameters
providerIdinteger · int32Required

The Provider Id from which to retrieve the Hosts.

Query parameters
UserstringOptional

The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.

Responses
chevron-right
200

Success

application/json; api-version=1.0

AVD Host System Session Information.

idstring · nullableOptional

ID of RAS Agent.

siteIdinteger · int32Optional

ID of Site.

agentStatestring · enumOptional

Agent State

Possible values:
serverTypestring · enumOptional

RAS Status Type

Possible values:
agentVerstring · nullableOptional

Agent Version.

serverstring · nullableOptional

Server name.

serverOSstring · nullableOptional

Server Operating System.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

machineIdstring · nullableOptional

Id of the machine

logLevelstring · enumOptional

RAS Log Level

Possible values:
cpuLoadinteger · int32Optional

CPU load percentage.

memLoadinteger · int32Optional

Memory load percentage.

diskReadinteger · int32Optional

Disk Read.

diskWriteinteger · int32Optional

Disk Write.

enabledbooleanOptional

Whether the object is enabled or not.

hostIPstring · nullableOptional

Host IP Address.

powerStatestring · enumOptional

Power State

Possible values:
assignmentstring · enumOptional

Host Assignment Type

Possible values:
userstring · nullableOptional

User.

disksstring · nullableOptional

Disk(s).

avdAgentstring · nullableOptional

AVD Agent name.

subnetNamestring · nullableOptional

Subnet name.

get
/api/Provider/{providerId}/VM/AVDHost/Session

Get AVD Host Session

get

Retrieve the Host Sessions.

Path parameters
providerIdinteger · int32Required

The Provider Id from which to retrieve the Hosts.

idstringRequired
Query parameters
idstringOptional

The ID of the Host for which to retrieve the status.

UserstringOptional

The username assigned to Host (optional). If empty square brackets ([]) are passed, the Host list will be filtered with those with an assigned user.

Responses
chevron-right
200

OK

application/json; api-version=1.0

AVD Host System Session Information.

idstring · nullableOptional

ID of RAS Agent.

siteIdinteger · int32Optional

ID of Site.

agentStatestring · enumOptional

Agent State

Possible values:
serverTypestring · enumOptional

RAS Status Type

Possible values:
agentVerstring · nullableOptional

Agent Version.

serverstring · nullableOptional

Server name.

serverOSstring · nullableOptional

Server Operating System.

serviceStartTimestring · nullableOptional

Service start time.

systemBootTimestring · nullableOptional

System boot time.

unhandledExceptionsinteger · int32Optional

Number of unhandled exceptions.

machineIdstring · nullableOptional

Id of the machine

logLevelstring · enumOptional

RAS Log Level

Possible values:
cpuLoadinteger · int32Optional

CPU load percentage.

memLoadinteger · int32Optional

Memory load percentage.

diskReadinteger · int32Optional

Disk Read.

diskWriteinteger · int32Optional

Disk Write.

enabledbooleanOptional

Whether the object is enabled or not.

hostIPstring · nullableOptional

Host IP Address.

powerStatestring · enumOptional

Power State

Possible values:
assignmentstring · enumOptional

Host Assignment Type

Possible values:
userstring · nullableOptional

User.

disksstring · nullableOptional

Disk(s).

avdAgentstring · nullableOptional

AVD Agent name.

subnetNamestring · nullableOptional

Subnet name.

get
/api/Provider/{providerId}/VM/{id}/AVDHost/Session