API Reference

Create or replace VM settings for a host pool

put
https://api.controlup.com/daas-iq/v1/cloud/host-pools//vm-settings

Stores the template future session hosts are built from: naming, domain join, image, VM size, disk, and network.
A full replacement, not a patch — omitted fields are cleared, so send the complete settings every time.
Adding hosts later reads these saved settings rather than taking them in the request.
Saving validates resource details and persists the template; it does not reconfigure the Azure host pool
or existing session hosts.

When new Entra session hosts are provisioned, including by autoscaling, Foundry adds
enablerdsaadauth:i:1 to the host pool's RDP properties if that property's name is absent.
Existing values, including an explicit enablerdsaadauth:i:0, and unrelated RDP properties are preserved.
General RDP defaults are applied only at pool creation. Selecting AD does not disable an existing Entra flag.

Path Params
uuid
required

Host pool identifier

Body Params

VM settings payload

Full request payload for creating or replacing VM settings for a host pool.

uuid | null

Optional cloud subscription ID for new VM, NIC, and disk deployment.

string
required
length between 1 and 64

Region code (e.g. eastus) where new session-host VMs are deployed.

string
required
length between 1 and 90
^[-\w.()]{0,89}[-\w()]$

Name of the resource group for newly deployed Compute resources (e.g. rg-avd-prod).

string
required
length ≥ 1

Template used for newly created session host VM names. An optional trailing
[#], [##], or [###] token enables zero-padded numbering.

string
required
length between 1 and 64

Primary VM size used for provisioning.

string | null

Optional fallback VM size used when the primary size is unavailable.

availabilityZones
array of strings
required

Requested availability zones for session host deployment.

availabilityZones*
string
enum
required

Image source selection for host pool VM settings.

Allowed:
string | null

Full ARM resource ID of the gallery image definition when Gallery is selected.

string | null

Full ARM resource ID of the gallery image version when Gallery is selected.

string | null

Full ARM resource ID of the source VM when Existing VM is selected.

string
required
length between 1 and 64

OS disk storage account type.

int64
required
≥ 1

Requested OS disk size in bytes.

string
enum
required

Security profile for Azure VMs.

Allowed:
boolean
required

Indicates whether Secure Boot is requested.

boolean
required

Indicates whether virtual TPM is requested.

boolean
required

Indicates whether integrity monitoring is requested.

string
required
length between 1 and 2048

Full ARM resource ID of the selected existing virtual network.

string
required
length between 1 and 2048

Full ARM resource ID of the selected subnet.

string
enum
required

Network security group preset for host pool VM settings.

Allowed:
boolean
required

Indicates whether public inbound ports are requested.

string
enum
required

Directory join strategy for session host VMs.

Allowed:
string | null

Active Directory domain for AD join scenarios.

string | null

Domain join user principal name for AD join scenarios.

string | null

Organizational unit path for AD join scenarios.

string
required
length between 1 and 256

Local administrator username configured on session hosts.

string | null

Optional FSLogix profile storage UNC path.

boolean
required

Indicates whether Intune enrollment is enabled.

tags
object | null

Up to 40 customer tags applied to created session host resources.
System tags are added separately during deployment or scaling.

appCatalogDeployGroupIds
array of uuids
required

App Catalog Deploy Group IDs this host pool resolves apps from at session-host provisioning.

appCatalogDeployGroupIds*
string | null

Optional local administrator password to set or update.

string | null

Optional domain join password used when AD join is selected.

Responses

Updated 3 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 3 months ago

Did this page help you?