API Reference

Get user sessions for a host pool

get
https://api.controlup.com/daas-iq/v1/cloud/host-pools//user-sessions

Returns the people currently logged in to the pool — one row per user session, across all of its session hosts.
In Azure AVD this includes Active, Pending, and Disconnected sessions: any session where the user has not logged off.
Describes the occupants, not the machines they are running on.

Path Params
uuid
required

The unique identifier of the host pool.

Query Params
string
length ≤ 256

Sort specification string.

Format:
field:direction,otherField:direction

Directions: asc, desc, ascending, descending — defaults to ascending when omitted

Fields (names are matched case-insensitively):
activeDirectoryUserName, applicationType, currentStateDuration, currentStateStartTime, id, sessionDuration, sessionEndTime, sessionHostId, sessionHostName, sessionHostNameAlias, sessionName, sessionNumericAlias, sessionStartTime, sessionState, userPrincipalName

Default when omitted: sessionStartTime:desc.

int32
1 to 2147483647

The page number to retrieve (1-based). Default: 1.

int32
1 to 100

The number of items per page (1-100). Default: 50.

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?