Existing

Import

post

Creates an Azure Virtual Desktop Host Pool from an existing Host Pool.

Body
siteIdinteger · int32Optional

Site ID in which to modify the specified AVD Host Pool. If the parameter is omitted, the site ID of the Licensing Server will be used.

workspaceIdinteger · int32Required

The Workspace ID.

enabledbooleanOptional

Enable or disable the AVD Host Pool upon creation. If the parameter is omitted, the AVD Host Pool is initialised as Disabled.

azureIdstring | nullableRequired

The Azure ID of the AVD Host Pool.

validationEnvironmentbooleanOptional

Whether Validation Environment is Enabled or not.

templateIdinteger · int32 | nullableOptional

The Template ID.

templateVersionIdinteger · int32 | nullableOptional

The RAS Template Version ID.

autoScaleEnabledboolean | nullableOptional

Whether AutoScale is Enabled or not

minServersFromTemplateinteger · int32Optional

The Minimum Number of Hosts added from the template. Default: 1

maxServersFromTemplateinteger · int32Optional

The Maximum Number of Hosts added from the template. Default: 2

hostNamestring | nullableOptional

The host name format. All VMs created from the template will have this name with %ID:N:S% replaced.

defaultPowerStatestring · enumOptional

Session Type

Possible values:
workloadThresholdinteger · int32Optional

The Workload Threshold. Default: 75

serversToAddPerRequestinteger · int32Optional

The amount of servers to add per request. Default: 1

workLoadDraininteger · int32Optional

The Drain Workload. Default: 20

drainRemainsBelowSecinteger · int32Optional

The Remaining Drain level. Default: 0 (Immediate)

removeServersAfterDrainAndPowerOffboolean | nullableOptional

Remove hosts from host pool after drain and power off.

Responses
post
/api/AVD/HostPool/Existing

Was this helpful?