Create or replace VM settings for a host pool

put

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

Path Params

hostPoolId

uuid

required

Host pool identifier

Body Params

VM settings payload

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

deploymentRegion

string

required

length between 1 and 64

Region code (e.g. eastus) where session hosts are deployed.
Drives region-sensitive compatibility validation and the deployment location.

deploymentResourceGroupName

string

required

length between 1 and 90

^[-\w.()]{0,89}[-\w()]$

Name of the resource group session hosts are deployed into (e.g. rg-avd-prod).
Resolved within the subscription that owns the host pool.

vmNamingPrefix

string

required

length between 1 and 11

Prefix used for newly created session host VM names.

primaryVmSize

string

required

length between 1 and 64

Primary VM size used for provisioning.

alternativeVmSize

string | null

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

availabilityZones

array of strings | null

Requested availability zones for session host deployment.

availabilityZones

imageSource

string

enum

required

Allowed:

imageResourceId

string | null

Full ARM resource ID of the gallery image when gallery image source is used.

imageVersionResourceId

string | null

Full ARM resource ID of the gallery image version when gallery image source is used.

existingVmResourceId

string | null

Full ARM resource ID of the existing VM when existing VM image source is used.

osDiskStorageAccountType

string

required

length between 1 and 64

OS disk storage account type.

osDiskSizeBytes

int64

≥ 1

Requested OS disk size in bytes.

securityType

string

enum

required

Allowed:

secureBoot

boolean

Indicates whether Secure Boot is enabled.

vTpm

boolean

Indicates whether virtual TPM is enabled.

integrityMonitoring

boolean

Indicates whether integrity monitoring is enabled.

virtualNetworkResourceId

string

required

length between 1 and 2048

Full ARM resource ID of the virtual network.

subnetResourceId

string

required

length between 1 and 2048

Full ARM resource ID of the subnet (identifies both the virtual network and subnet).

networkSecurityGroup

string

enum

required

Allowed:

publicInboundPorts

boolean

Indicates whether public inbound ports are allowed.

joinType

string

enum

required

Allowed:

adDomain

string | null

Active Directory domain for AD join scenarios.

domainJoinUpn

string | null

Domain join user principal name for AD join scenarios.

ouPath

string | null

Organizational unit path for AD join scenarios.

localAdminUsername

string

required

length between 1 and 256

Local administrator username configured on session hosts.

profileStoragePath

string | null

Optional FSLogix profile storage UNC path.

intuneEnrollment

boolean

Indicates whether Intune enrollment is enabled.

200Returns the saved VM settings

400Request payload failed validation

401Request is not authenticated

403Caller does not have permission to manage host pool VM settings

404Specified host pool was not found