For the complete documentation index, see llms.txt. This page is also available as Markdown.

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 · min: 1 · max: 255 · 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 · min: 1 · max: 255 · 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
201

Created

application/json; api-version=1.0

Azure Virtual Desktop Host Pool

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

enabledbooleanOptional

Whether host pool is enabled or not.

namestring · nullableOptional

The Name of the Host Pool

friendlyNamestring · nullableOptional

The Friendly Name of the Host Pool

descriptionstring · nullableOptional

The Description of the Host Pool

resourceGroupstring · nullableOptional

The Resource Group of the Host Pool

locationstring · nullableOptional

The location of the Host Pool

azureIdstring · nullableOptional

The Azure ID

workspaceIdinteger · int32Optional

The Workspace ID.

linkedDesktopApplicationGroupstring · nullableOptional

The Linked Desktop Application Group.

linkedRemoteApplicationGroupstring · nullableOptional

The Linked Remote Application Group.

inheritDefaultAgentSettingsbooleanOptional

If true, default Agent settings will be inherited.

inheritDefaultUserProfileSettingsbooleanOptional

If true, default User Profile settings will be inherited.

inheritDefaultAppPackageSettingsbooleanOptional

If true, default app package settings will be inherited.

inheritDefaultOptimizationSettingsboolean · nullableOptional

If true, default optimization settings will be inherited.

inheritDefaultActionsSettingsboolean · nullableOptional

If true, default Actions settings will be inherited.

inheritDefaultRDPPrinterSettingsbooleanOptional

If true, default Printing settings will be inherited.

inheritDefaultAutoUpgradeSettingsbooleanOptional

If true, default Auto-upgrade settings will be inherited.

post/api/AVD/HostPool/Existing