Validate VM settings for a host pool

post

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

Checks a VM settings payload and echoes it back enriched with resolved lookup details, without saving anything.
Send a body to test settings before committing them; omit the body to re-validate what is already stored.
A dry run only — use the save operation to persist.

Path Params

hostPoolId

uuid

required

Host pool identifier

Body Params

Optional VM settings payload to validate; when omitted, validates persisted settings

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 ≥ 1

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

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

required

Requested availability zones for session host deployment.

availabilityZones*

imageSource

string

enum

required

Image source selection for host pool VM settings.

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

required

≥ 1

Requested OS disk size in bytes.

securityType

string

enum

required

Security profile for Azure VMs.

Allowed:

secureBoot

boolean

required

Indicates whether Secure Boot is enabled.

vTpm

boolean

required

Indicates whether virtual TPM is enabled.

integrityMonitoring

boolean

required

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

Network security group preset for host pool VM settings.

Allowed:

publicInboundPorts

boolean

required

Indicates whether public inbound ports are allowed.

joinType

string

enum

required

Directory join strategy for session host VMs.

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

required

Indicates whether Intune enrollment is enabled.

200Validation succeeded and returns resolved details

400Bad request. Request payload failed validation.

401Unauthorized. User is not authenticated.

402Payment required. No active license for the organization.

403Forbidden. User does not have manage host pool settings permissions.

404Not found. The specified host pool does not exist.

500Internal server error.

503Service unavailable. License status could not be verified. Try again later.