Get session hosts for a host pool

Returns the VMs that make up the pool — one row per session host with power state, agent status, drain state,
VM SKU, OS, per-host CPU and memory, and session counts.
Stored inventory rather than a live Azure read, so power and agent state are current as of each row's SyncedAt.
Describes the machines, not the users occupying them, and carries no cost data.

Path Params
uuid
required

The unique identifier of the host pool.

Query Params
string

Optional filter expression.

Supports JSON and RQL formats:

  • JSON: {"and":[{"field":"status","op":"eq","value":"Active"},{"field":"name","op":"ct","value":"Smith, John"}]}
  • RQL: and(eq(status,Active),ct(name,Smith%2C%20John)) — values are URL-decoded; encode reserved characters

Operators:
and, or, not (logical); eq, neq, ct, nct, sw, nsw, ew, new, gt, gte, lt, lte (predicate)

Fields (names are matched case-insensitively):
activeSessions, allowNewSession, cpuPercent, hostNameAlias, hostPool, hostPoolId, id, memoryPercent, name, osType, powerState, provider, region, regionId, resourceGroup, resourceGroupId, scalingLifecycleState, sessionHostResourceId, status, subscription, subscriptionId, syncedAt, totalSessions, vmResourceId, vmSku

string

Sort expression for ordering results.

Format:
field:direction,otherField:direction

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

Fields (names are matched case-insensitively):
activeSessions, allowNewSession, cpuPercent, hostNameAlias, hostPool, hostPoolId, id, memoryPercent, name, osType, powerState, provider, region, regionId, resourceGroup, resourceGroupId, scalingLifecycleState, sessionHostResourceId, status, subscription, subscriptionId, syncedAt, totalSessions, vmResourceId, vmSku

Default when omitted: name:asc.

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

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