Enable or disable the specified VDI Host Pool in a site.
templateIdnullable integer (int32)
Template ID, 0 = None
templateVersionIdnullable integer (int32)
Template Version ID
maxHostsnullable integer (int32)
The maximum number of hosts that can be created from the template.
preCreatedHostsnullable integer (int32)
The maximum pre-created hosts that can be created.
hostNamenullable string
The VM name format. All VMs created from the template will have this name with %ID:N:S% replaced.
defaultPowerStateDefaultPowerState (enum)
Session Type
0 = PoweredOn,1 = PoweredOff,2 = Suspended
durationnullable integer (int32)
The Duration
wildCardnullable string
A user-defined VDI Host Pool wildcard.
inheritDefaultVDIActionSettingsnullable boolean
Enable or disable the 'Inherit default Action settings' option. This will inherit Global Action settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Enable or disable the 'Inherit default user profile settings' option. This will inherit VDI User Profile settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
technologyUserProfileTech (enum)
User Profile Technology values.
0 = DoNotManage,1 = UPD,2 = FSLogix
inheritDefaultAppPackageSettingsnullable boolean
If true, default app package settings will be inherited.
Enable or disable the 'Inherit default Optimization Settings' option. This will inherit Image Optimization settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
inheritDefaultAgentSettingsnullable boolean
If true, default VDI Agent settings will be inherited.
Location where the File Transfer takes place, if and where it is allowed.
fileTransferLockLocationnullable boolean
Lock Location where the File Transfer takes place, if and where it is allowed.
enableDriveRedirectionCachenullable boolean
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.
inheritDefaultRDPPrinterSettingsnullable boolean
Enable or disable the 'Inherit default RDP printer settings' option. This will inherit Global printer settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Enable or disable the 'Remove session number from printer name' option.
inheritDefaultVDISecuritySettingsnullable boolean
Enable or disable the 'Inherit default Security settings' option. This will inherit Global Security settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
isUsersGrantedRDPermissionsnullable boolean
Grant users RD permission.
groupTypeUserGroupType (enum)
Group types to allow remote desktop access
1 = Administrators,2 = RemoteDesktopUsers
inheritDefaultAutoUpgradeSettingsnullable boolean
Enable or disable the 'Inherit default Auto-upgrade Settings' option. This will inherit Auto-upgrade settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Response
No Content
Request
Response
List
Retrieve information about one or multiple VDI Host Pools.
GET/api/VDI/HostPool
Query parameters
Response
Success
Body
idinteger (int32)
ID of the object.
adminCreatenullable string
User who created the object.
adminLastModnullable string
User who last modified the object.
timeCreatestring (date-time)
Time when the object was created.
timeLastModstring (date-time)
Time when the object was last modified.
namenullable string
Name of the VDI Host Pool
siteIdinteger (int32)
Site ID
descriptionnullable string
Description of the VDI Host Pool
enabledboolean
Whether the VDI Host Pool is enabled or not>
provisioningProvisioningSettings (object)
Host Pool Provisioning Settings
membersMembersSettings (object)
Host Pool Members Settings
templateTemplateSettings (object)
Host Pool Template Settings
inheritDefaultVDIActionSettingsboolean
If true, default Action settings will be inherited.
actionActionSettings (object)
Action Settings
inheritDefaultUserProfileSettingsboolean
If true, default User Profile settings will be inherited.
userProfileUserProfileSettings (object)
User Profile Settings
inheritDefaultAppPackageSettingsboolean
If true, default app package settings will be inherited.