Update host pool settings

Applies the settings the payload carries and leaves the rest as they are, so changing one setting takes
a payload with one field in it. A field left out, or sent as null, is not changed; clearing one is asked
for with its empty form, an empty string for text or an empty list for maintenance windows.
Dispatches a job that applies the change in Azure and then refreshes Foundry's copy of this host pool,
so once the job completes the change is readable back without waiting for the next inventory sync.
A cleared text setting reads back empty rather than absent, because Azure cannot remove a property it
holds, and the maintenance window time zone cannot be cleared at all.
Settings that do not apply to this pool's type may be omitted or echoed back unchanged but cannot be
given a different value, and host pool type and region cannot be changed after the pool is created.

Path Params
uuid
required

Host pool identifier

Body Params

Settings to change

Request payload for updating a host pool's settings.

string | null

Display name shown for the host pool.

string | null

Free-text description of the host pool.

int32 | null
1 to 2147483647

Maximum concurrent sessions allowed per session host. Applies to pooled host pools.

boolean | null

Whether session hosts start automatically when a user connects.

boolean | null

Whether the host pool receives preview features as a validation environment.

string | null

Custom RDP properties applied to connections, as a semicolon-delimited string.

agentUpdate
object

AVD agent update configuration for a host pool.

string
enum

Azure Virtual Desktop host pool load balancer type (ARM: loadBalancerType).

Allowed:
string
enum

Assignment strategy for personal Azure Virtual Desktop host pools.

Allowed:
Responses

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