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. Available to Templated Host Pools

templateVersionIdinteger · int32 | nullableOptional

The Template Version ID. Available to Templated Host Pools

templateTagIdinteger · int32 | nullableOptional

The Template Tag ID. Available to Templated Host Pools

maxHostsinteger · int32 | nullableOptional

The maximum number of hosts that can be created from the template. Available to Templated Personal Host Pools

preCreatedHostsinteger · int32 | nullableOptional

The maximum number of pre-created hosts. (Keep available buffer) Available to Templated Personal Host Pools

durationinteger · int32 | nullableOptional

The duration (in seconds) before the unused hosts are deleted Available to Templated Personal Host Pools

hostsToCreateinteger · int32 | nullableOptional

The number of hosts that will be created after template creation process has finished. These desktops are created only once.

autoScaleEnabledboolean | nullableOptional

Whether AutoScale is Enabled or not Available to Templated Pooled Host Pools

minServersFromTemplateinteger · int32 | nullableOptional

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

maxServersFromTemplateinteger · int32 | nullableOptional

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

workloadThresholdinteger · int32 | nullableOptional

The Workload Threshold. Default: 75

serversToAddPerRequestinteger · int32 | nullableOptional

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

workLoadDraininteger · int32 | nullableOptional

The Drain Workload. Default: 20

drainRemainsBelowSecinteger · int32 | nullableOptional

The Remaining Drain level. Default: 1 (Immediate)

removeServersAfterDrainAndPowerOffboolean | nullableOptional

Remove hosts from host pool after drain and power off.

hostNamestring | nullableRequired

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:
overwriteSizeboolean | nullableOptional

Whether Overwrite Size is Enabled or not. Available to Templated Host Pools

vmSizestring | nullableOptional

VMSize which will override the size specified in template properties. Example: Standard_B2s

Responses
post
/api/AVD/HostPool/Existing

Last updated