Get host pools

Returns one row per host pool across all subscriptions, with identity (name, subscription, resource group, region, type)
and latest-value counts for hosts, sessions, and average CPU.
Does not include cost, memory, or AVD configuration.

Query Params
string
enum

Optional cloud provider filter. Null means all providers.

Allowed:
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):
activeSessions, assignmentType, avgCpuPercent, hasNativeScalingPlan, hasSessionHostConfig, id, name, provider, region, regionId, resourceGroup, resourceGroupId, runningHosts, stoppedHosts, subscription, subscriptionId, syncedAt, totalHosts, totalSessions, type

Default when omitted: name:asc.

string
length ≤ 512

Filter expression for filtering results.

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, assignmentType, avgCpuPercent, hasNativeScalingPlan, hasSessionHostConfig, id, name, provider, region, regionId, resourceGroup, resourceGroupId, runningHosts, stoppedHosts, subscription, subscriptionId, syncedAt, totalHosts, totalSessions, type

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