Host Pool

List

get

Retrieve a list of Azure Virtual Desktop Host Pools.

Query parameters
namestringOptional

the Name of the Azure Virtual Desktop Host Pool

siteIdinteger · int32Optional

The Site ID for which to retrieve the Azure Virtual Desktop HostPool.

Responses
get
/api/AVD/HostPool

Create

post

Creates a new Azure Virtual Desktop Host Pool.

Body
namestring | nullableRequired

The name of the AVD Host Pool.

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.

descriptionstring | nullableOptional

Description of the AVD Host Pool.

enabledbooleanOptional

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

friendlyNamestring | nullableOptional

Friendly name of the AVD Host Pool.

resourceGroupstring | nullableRequired

Resource Group of the AVD Host Pool.

locationstring | nullableRequired

Location of the AVD Host Pool.

poolTypestring · enumRequired

Pool Type

Possible values:
limitHostsinteger · int32Optional

The Limit of session on host. Default: Pooled: 50, Personal: 1 (always).

publishingTypestring · enumRequired

Publishing Type

Possible values:
loadBalancerTypestring · enumRequired

Load Balancer Type

Possible values:
powerOnHostbooleanOptional

Whether Power On Host is Enabled or not.

validationEnvironmentbooleanOptional

Whether Validation Environment is Enabled or not.

provisioningTypestring · enumRequired

Provisioning Type

Possible values:
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

Get

get

Retrieve the Azure Virtual Desktop Host Pool.

Path parameters
idinteger · int32Required

The ID of the Azure Virtual Desktop Host Pool.

Responses
get
/api/AVD/HostPool/{id}

Update

put

Modifies an Azure Virtual Desktop Host Pool.

Path parameters
idinteger · int32Required

The ID of the Azure Virtual Desktop Host Pool to modify.

Body
namestring | nullableOptional

The new name of the Azure Virtual Desktop Host Pool settings.

friendlyNamestring | nullableOptional

The new Friendly Name of the Azure Virtual Desktop Host Pool settings.

descriptionstring | nullableOptional

The new description of the Azure Virtual Desktop Host Pool settings.

enabledboolean | nullableOptional

Enable or disable the specified AVD Host Pool in a site.

powerOnHostboolean | nullableOptional

Whether Power On Host is Enabled or not.

validationEnvironmentboolean | nullableOptional

Whether Validation Environment is Enabled or not.

limitHostsinteger · int32 | nullableOptional

The Limit of session on host.

defaultLicenseTypestring · enumOptional

The AVD License Type

Possible values:
loadBalancerTypestring · enumOptional

Load Balancer Type

Possible values:
technologystring · enumOptional

User Profile Technology values.

Possible values:
disconnectActiveSessionAfterinteger · int32 | nullableOptional

Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.

logoffDisconnectedSessionAfterinteger · int32 | nullableOptional

Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.

sessionReadinessTimeoutinteger · int32 | nullableOptional

Session readiness timeout (in seconds). Accepted values: 20-3600 seconds.

allowRemoteExecboolean | nullableOptional

Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.

allowURLAndMailRedirectionstring · enumOptional

URL and Mail Redirection values.

Possible values:
supportShellURLNamespaceObjectsboolean | nullableOptional

Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.

manageRDPTransportProtocolstring · enumOptional

Manage RDP transport protocol.

Possible values:
dragAndDropModestring · enumOptional

Drag and drop redirection values.

Possible values:
fileTransferModestring · enumOptional

File Transfer Control modes.

Possible values:
fileTransferLocationstring | nullableOptional

Location where the File Transfer takes place, if and where it is allowed.

fileTransferLockLocationboolean | nullableOptional

Lock Location where the File Transfer takes place, if and where it is allowed.

enableDriveRedirectionCacheboolean | nullableOptional

Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.

sessionActionstring · enumOptional

Session Action type

Possible values:
performActionstring · enumOptional

Perform Action type

Possible values:
performActionAfterSecinteger · int32 | nullableOptional

Perform action after (in seconds)

templateIdinteger · int32 | nullableOptional

The Template ID.

templateVersionIdinteger · int32 | nullableOptional

The RAS Template Version ID.

autoScaleEnabledboolean | nullableOptional

Whether AutoScale is Enabled or not.

minServersFromTemplateinteger · int32 | nullableOptional

The Minimum Number of Hosts added to the template.

maxServersFromTemplateinteger · int32 | nullableOptional

The Maximum Number of Hosts added to the template.

hostNamestring | nullableOptional

The Host Name Format. All Host Names must adhere to this format : '{text}-%ID:{number}%'

defaultPowerStatestring · enumOptional

Session Type

Possible values:
workloadThresholdinteger · int32 | nullableOptional

The Workload Threshold.

serversToAddPerRequestinteger · int32 | nullableOptional

The amount of servers to add per request.

workLoadDraininteger · int32 | nullableOptional

The Drain Workload.

drainRemainsinteger · int32 | nullableOptional

The Remaining Drain level.

overwriteSizeboolean | nullableOptional

Whether Overwrite Size is Enabled or not.

removeServersAfterDrainAndPowerOffboolean | nullableOptional

Remove hosts from host pool after drain and power off.

printerNameFormatstring · enumOptional

Printer Name Format

Possible values:
removeSessionNumberFromPrinterNameboolean | nullableOptional

Specifies if 'Remove session number from printer name' option is enabled or disabled.

removeClientNameFromPrinterNameboolean | nullableOptional

Specifies if 'Remove client name from printer name' option is enabled or disabled.

appMonitorboolean | nullableOptional

Specifies if 'Enable applications monitoring' option is enabled or disabled.

manageRDPShortpathboolean | nullableOptional

Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

useRDPShortpathboolean | nullableOptional

Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

useSmallerPortRangeboolean | nullableOptional

Specifies if 'Use Smaller Port' option is enabled or disabled.

minRDPShortpathPortinteger · int32 | nullableOptional

The minimum RDP Shortpath Port.

maxRDPShortpathPortinteger · int32 | nullableOptional

The maximum RDP Shortpath Port.

inheritDefaultAgentSettingsboolean | nullableOptional

If true, default AVD Agent settings will be inherited.

inheritDefaultUserProfileSettingsboolean | nullableOptional

If true, default User Profile settings will be inherited.

inheritDefaultAppPackageSettingsboolean | nullableOptional

If true, default Application Package settings will be inherited.

inheritDefaultOptimizationSettingsboolean | nullableOptional

If true, default Optimization settings will be inherited.

inheritDefaultActionsSettingsboolean | nullableOptional

If true, default Action settings will be inherited.

inheritDefaultRDPPrinterSettingsboolean | nullableOptional

If true, default Printing settings will be inherited.

inheritDefaultAutoUpgradeSettingsboolean | nullableOptional

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

Responses
204

No Content

No content

put
/api/AVD/HostPool/{id}

No content

Remove

delete

Removes an Azure Virtual Desktop Host Pool.

Path parameters
idinteger · int32Required

The ID of the Azure Virtual Desktop Host Pool to remove.

Responses
204

No Content

No content

delete
/api/AVD/HostPool/{id}

No content

Was this helpful?