# Existing

## Import

> Creates an Azure Virtual Desktop Host Pool from an existing Host Pool.\<br />

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/AVD/HostPool/Existing":{"post":{"tags":["0-Infrastructure/AVD/Host Pool//0-Basic Operations"],"summary":"Import","description":"Creates an Azure Virtual Desktop Host Pool from an existing Host Pool.<br />","operationId":"c7cd50a7-ba60-43e9-b4a5-fb0b0116f25f","requestBody":{"description":"Azure Virtual Desktop Host Pool settings.","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ExistingAVDHostPool"}}}},"responses":{"201":{"description":"Created","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/AVDHostPool"}}}},"400":{"description":"Bad Request","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"ExistingAVDHostPool":{"required":["azureId","hostName","workspaceId"],"type":"object","properties":{"siteId":{"type":"integer","description":"<para type=\"description\">Site ID in which to modify the specified AVD Host Pool.</para>\r\n<para type=\"description\">If the parameter is omitted, the site ID of the Licensing Server will be used.</para>","format":"int32"},"workspaceId":{"type":"integer","description":"<para type=\"description\">The Workspace ID.</para>","format":"int32"},"enabled":{"type":"boolean","description":"<para type=\"description\">Enable or disable the AVD Host Pool upon creation.</para>\r\n<para type=\"description\">If the parameter is omitted, the AVD Host Pool is initialised as Disabled.</para>"},"azureId":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">The Azure ID of the AVD Host Pool.</para>","nullable":true},"validationEnvironment":{"type":"boolean","description":"<para type=\"description\">Whether Validation Environment is Enabled or not.</para>"},"templateId":{"type":"integer","description":"<para type=\"description\">The Template ID.</para>\r\n<para type=\"description\">Available to Templated Host Pools</para>","format":"int32","nullable":true},"templateVersionId":{"type":"integer","description":"<para type=\"description\">The Template Version ID.</para>\r\n<para type=\"description\">Available to Templated Host Pools</para>","format":"int32","nullable":true},"templateTagId":{"type":"integer","description":"<para type=\"description\">The Template Tag ID.</para>\r\n<para type=\"description\">Available to Templated Host Pools</para>","format":"int32","nullable":true},"maxHosts":{"type":"integer","description":"<para type=\"description\">The maximum number of hosts that can be created from the template.</para>\r\n<para type=\"description\">Available to Templated Personal Host Pools</para>","format":"int32","nullable":true},"preCreatedHosts":{"type":"integer","description":"<para type=\"description\">The maximum number of pre-created hosts. (Keep available buffer)</para>\r\n<para type=\"description\">Available to Templated Personal Host Pools</para>","format":"int32","nullable":true},"duration":{"type":"integer","description":"<para type=\"description\">The duration (in seconds) before the unused hosts are deleted</para>\r\n<para type=\"description\">Available to Templated Personal Host Pools</para>","format":"int32","nullable":true},"hostsToCreate":{"type":"integer","description":"<para type=\"description\">The number of hosts that will be created after template creation process has finished. These desktops are created only once.</para>","format":"int32","nullable":true},"autoScaleEnabled":{"type":"boolean","description":"<para type=\"description\">Whether AutoScale is Enabled or not</para>\r\n<para type=\"description\">Available to Templated Pooled Host Pools</para>","nullable":true},"minServersFromTemplate":{"type":"integer","description":"<para type=\"description\">The Minimum Number of Hosts added from the template. </para>\r\n<para type=\"description\">Default: 1</para>","format":"int32","nullable":true},"maxServersFromTemplate":{"type":"integer","description":"<para type=\"description\">The Maximum Number of Hosts added from the template.</para>\r\n<para type=\"description\">Default: 2</para>","format":"int32","nullable":true},"workloadThreshold":{"type":"integer","description":"<para type=\"description\">The Workload Threshold.</para>\r\n<para type=\"description\">Default: 75</para>","format":"int32","nullable":true},"serversToAddPerRequest":{"type":"integer","description":"<para type=\"description\">The amount of servers to add per request.</para>\r\n<para type=\"description\">Default: 1</para>","format":"int32","nullable":true},"workLoadDrain":{"type":"integer","description":"<para type=\"description\">The Drain Workload.</para>\r\n<para type=\"description\">Default: 20</para>","format":"int32","nullable":true},"drainRemainsBelowSec":{"type":"integer","description":"<para type=\"description\">The Remaining Drain level.</para>\r\n<para type=\"description\">Default: 1 (Immediate)</para>","format":"int32","nullable":true},"removeServersAfterDrainAndPowerOff":{"type":"boolean","description":"<para type=\"description\">Remove hosts from host pool after drain and power off.</para>","nullable":true},"hostName":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">The host name format. All VMs created from the template will have this name with %ID:N:S% replaced.</para>","nullable":true},"defaultPowerState":{"$ref":"#/components/schemas/DefaultPowerState"},"overwriteSize":{"type":"boolean","description":"<para type=\"description\">Whether Overwrite Size is Enabled or not.</para>\r\n<para type=\"description\">Available to Templated Host Pools</para>","nullable":true},"vmSize":{"type":"string","description":"<para type=\"description\">VMSize which will override the size specified in template properties.</para>\r\n<para type=\"description\">Example: Standard_B2s</para>","nullable":true}},"additionalProperties":false},"DefaultPowerState":{"enum":[["0 = PoweredOn","1 = PoweredOff","2 = Suspended"]],"type":"string","description":"<para type=\"synopsis\">Session Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"AVDHostPool":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"siteId":{"type":"integer","description":"<para type=\"description\">The site ID associated with the Host Pool.</para>","format":"int32"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether host pool is enabled or not.</para>"},"name":{"type":"string","description":"<para type=\"description\">The Name of the Host Pool</para>","nullable":true},"friendlyName":{"type":"string","description":"<para type=\"description\">The Friendly Name of the Host Pool</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">The Description of the Host Pool</para>","nullable":true},"resourceGroup":{"type":"string","description":"<para type=\"description\">The Resource Group of the Host Pool</para>","nullable":true},"location":{"type":"string","description":"<para type=\"description\">The location of the Host Pool</para>","nullable":true},"azureId":{"type":"string","description":"<para type=\"description\">The Azure ID</para>","nullable":true},"workspaceId":{"type":"integer","description":"<para type=\"description\">The Workspace ID.</para>","format":"int32"},"linkedDesktopApplicationGroup":{"type":"string","description":"<para type=\"description\">The Linked Desktop Application Group.</para>","nullable":true},"linkedRemoteApplicationGroup":{"type":"string","description":"<para type=\"description\">The Linked Remote Application Group.</para>","nullable":true},"configuration":{"$ref":"#/components/schemas/Configuration"},"templateSettings":{"$ref":"#/components/schemas/TemplateSettings"},"provisioningSettings":{"$ref":"#/components/schemas/AVDProvisioningSettings"},"assignments":{"type":"array","items":{"$ref":"#/components/schemas/Assignment"},"description":"<para type=\"description\">The Azure Virtual Desktop Host Pool Assignment Settings</para>","nullable":true},"inheritDefaultAgentSettings":{"type":"boolean","description":"<para type=\"description\">If true, default Agent settings will be inherited.</para>"},"agent":{"$ref":"#/components/schemas/HostPoolAgentSettings"},"inheritDefaultUserProfileSettings":{"type":"boolean","description":"<para type=\"description\">If true, default User Profile settings will be inherited.</para>"},"userProfile":{"$ref":"#/components/schemas/UserProfileSettings"},"inheritDefaultAppPackageSettings":{"type":"boolean","description":"<para type=\"description\">If true, default app package settings will be inherited.</para>"},"appPackagesAssigned":{"$ref":"#/components/schemas/AppPackagesAssigned"},"inheritDefaultOptimizationSettings":{"type":"boolean","description":"<para type=\"description\">If true, default optimization settings will be inherited.</para>","nullable":true},"optimization":{"$ref":"#/components/schemas/ImageOptimization"},"inheritDefaultActionsSettings":{"type":"boolean","description":"<para type=\"description\">If true, default Actions settings will be inherited.</para>","nullable":true},"action":{"$ref":"#/components/schemas/ActionSettings"},"inheritDefaultRDPPrinterSettings":{"type":"boolean","description":"<para type=\"description\">If true, default Printing settings will be inherited.</para>"},"rdpPrinter":{"$ref":"#/components/schemas/RDPPrinterSettings"},"inheritDefaultAutoUpgradeSettings":{"type":"boolean","description":"<para type=\"description\">If true, default Auto-upgrade settings will be inherited.</para>"},"autoUpgrade":{"$ref":"#/components/schemas/AutoUpgradeSettings"},"avdAgent":{"$ref":"#/components/schemas/AVDAgent"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Azure Virtual Desktop Host Pool</para>\r\n<para type=\"description\"></para>"},"Configuration":{"type":"object","properties":{"poolType":{"$ref":"#/components/schemas/PoolType"},"publishingType":{"$ref":"#/components/schemas/PublishingType"},"provisioningType":{"$ref":"#/components/schemas/ProvisioningType"},"loadBalancerType":{"$ref":"#/components/schemas/LoadBalancerType"},"powerOnHost":{"type":"boolean","description":"<para type=\"description\">Whether Power On Host is Enabled or not.</para>"},"validationEnvironment":{"type":"boolean","description":"<para type=\"description\">Whether Validation Environment is Enabled or not.</para>"},"limitHosts":{"type":"integer","description":"<para type=\"description\">The Limit of session on host.</para>\r\n<para type=\"description\">Available to Pooled Host Pools</para>","format":"int32","nullable":true},"defaultLicenseType":{"$ref":"#/components/schemas/AVDLicenseType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">AVD Configuration Settings</para>\r\n<para type=\"description\"></para>"},"PoolType":{"enum":[["0 = Pooled","1 = Personal"]],"type":"string","description":"<para type=\"synopsis\">Pool Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"PublishingType":{"enum":[["0 = RemoteApp","1 = Desktop"]],"type":"string","description":"<para type=\"synopsis\">Publishing Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProvisioningType":{"enum":[["0 = Template","1 = Standalone"]],"type":"string","description":"<para type=\"synopsis\">Provisioning Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"LoadBalancerType":{"enum":[["0 = BreadthFirst","1 = DepthFirst","2 = Persistent"]],"type":"string","description":"<para type=\"synopsis\">Load Balancer Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"AVDLicenseType":{"enum":[["0 = DoNotConfigure","1 = WindowsClient","2 = WindowsServer"]],"type":"string","description":"<para type=\"synopsis\">The AVD License Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"TemplateSettings":{"type":"object","properties":{"templateId":{"type":"integer","description":"<para type=\"description\">Template ID</para>","format":"int32"},"templateVersionId":{"type":"integer","description":"<para type=\"description\">Template Version ID</para>","format":"int32"},"templateTagId":{"type":"integer","description":"<para type=\"description\">Template Tag ID</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Host Pool Template Settings</para>\r\n<para type=\"description\"></para>"},"AVDProvisioningSettings":{"type":"object","properties":{"hostName":{"type":"string","description":"<para type=\"description\">The Host name format. All Host created from the template will have this name with %ID:N:S% replaced.</para>","nullable":true},"defaultPowerState":{"$ref":"#/components/schemas/DefaultPowerState"},"maxHosts":{"type":"integer","description":"<para type=\"description\">The maximum number of hosts that can be created from the template.</para>\r\n<para type=\"description\">Available to Templated Personal Host Pools</para>","format":"int32","nullable":true},"preCreatedHosts":{"type":"integer","description":"<para type=\"description\">The maximum number of pre-created hosts. (Keep available buffer)</para>\r\n<para type=\"description\">Available to Templated Personal Host Pools</para>","format":"int32","nullable":true},"duration":{"type":"integer","description":"<para type=\"description\">The duration (in seconds) before the unused hosts are deleted</para>\r\n<para type=\"description\">Available to Templated Personal Host Pools</para>","format":"int32","nullable":true},"autoScale":{"$ref":"#/components/schemas/AutoScale"},"overwriteSize":{"type":"boolean","description":"<para type=\"description\">Whether Overwrite Size is Enabled or not. (Override size)</para>"},"vmSize":{"$ref":"#/components/schemas/AVDVMSize"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Azure Virtual Desktop Host Pool Provisioning Settings</para>\r\n<para type=\"description\">Available to Templated Host Pools</para>"},"AutoScale":{"type":"object","properties":{"autoScaleEnabled":{"type":"boolean","description":"<para type=\"description\">Whether AutoScale is Enabled or not.</para>"},"minServersFromTemplate":{"type":"integer","description":"<para type=\"description\">The Minimum Number of Hosts added to the template.</para>","format":"int32"},"maxServersFromTemplate":{"type":"integer","description":"<para type=\"description\">The Maximum Number of Hosts added to the template.</para>","format":"int32"},"workloadThreshold":{"type":"integer","description":"<para type=\"description\">The Workload Threshold.</para>","format":"int32"},"serversToAddPerRequest":{"type":"integer","description":"<para type=\"description\">The amount of servers to add per request.</para>","format":"int32"},"workLoadDrain":{"type":"integer","description":"<para type=\"description\">The Drain Workload.</para>","format":"int32"},"drainRemainsBelowSec":{"type":"integer","description":"<para type=\"description\">The Remaining Drain level. (Seconds)</para>","format":"int32"},"removeServersAfterDrainAndPowerOff":{"type":"boolean","description":"<para type=\"description\">Remove hosts from host pool after drain and power off.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">AVD AutoScale Settings</para>\r\n<para type=\"description\">Available to Templated Pooled Host Pools</para>"},"AVDVMSize":{"type":"object","properties":{"vmSize":{"type":"string","description":"<para type=\"description\">VM Size</para>","nullable":true},"offering":{"type":"string","description":"<para type=\"description\">Offering</para>","nullable":true},"family":{"type":"string","description":"<para type=\"description\">Family</para>","nullable":true},"vcpUs":{"type":"integer","description":"<para type=\"description\">Virtual CPUs</para>","format":"int32"},"ram":{"type":"string","description":"<para type=\"description\">RAM (GiB)</para>","nullable":true},"dataDisk":{"type":"integer","description":"<para type=\"description\">Data Disk Count</para>","format":"int32"},"maximumIOPS":{"type":"string","description":"<para type=\"description\">Maximum IOPS</para>","nullable":true},"tempStorage":{"type":"integer","description":"<para type=\"description\">Temparary Storage (MB)</para>","format":"int32"},"premiumDiskSupport":{"$ref":"#/components/schemas/BinaryChoice"}},"additionalProperties":false,"description":"<para type=\"synopsis\">AVD VM Size</para>\r\n<para type=\"description\"></para>"},"BinaryChoice":{"enum":[["0 = No","1 = Yes"]],"type":"string","description":"<para type=\"synopsis\">Binary Choice.</para>\r\n<para type=\"description\"></para>","format":"int32"},"Assignment":{"type":"object","properties":{"account":{"type":"string","description":"<para type=\"description\">The name of the user/group account the filter is added to.</para>","nullable":true},"type":{"$ref":"#/components/schemas/UserType"},"sid":{"type":"string","description":"<para type=\"description\">The SID of the user/group account the filter is added to.</para>","nullable":true},"azureActiveDirectory":{"type":"string","description":"<para type=\"description\">Azure Active Directory</para>","nullable":true},"azureActiveDirectoryId":{"type":"string","description":"<para type=\"description\">Azure Active Directory Id</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">AVD Host Pool Assignment Settings</para>\r\n<para type=\"description\"></para>"},"UserType":{"enum":[["1 = User","2 = Group","3 = ForeignSecurityPrincipal","4 = Computer"]],"type":"string","description":"<para type=\"synopsis\">User Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"HostPoolAgentSettings":{"type":"object","properties":{"disconnectActiveSessionAfter":{"type":"integer","description":"<para type=\"description\">Disconnect active session after (in seconds). 0 for 'Never'.</para>","format":"int32"},"logoffDisconnectedSessionAfter":{"type":"integer","description":"<para type=\"description\">Logoff disconnected session after (in seconds). 0 for 'Never'; 1 for 'Immediate'.</para>","format":"int32"},"sessionReadinessTimeout":{"type":"integer","description":"<para type=\"description\">Session readiness timeout (in seconds).</para>","format":"int32"},"allowURLAndMailRedirection":{"$ref":"#/components/schemas/AllowURLAndMailRedirection"},"supportShellURLNamespaceObjects":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.</para>"},"dragAndDropMode":{"$ref":"#/components/schemas/DragAndDropModeValue"},"allowRemoteExec":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.</para>"},"manageRDPTransportProtocol":{"$ref":"#/components/schemas/ManageRDPTransportProtocol"},"fileTransferMode":{"$ref":"#/components/schemas/FileTransferControlMode"},"fileTransferLocation":{"type":"string","description":"<para type=\"description\">Location where the File Transfer takes place, if and where it is allowed.</para>","nullable":true},"fileTransferLockLocation":{"type":"boolean","description":"<para type=\"description\">Lock Location where the File Transfer takes place, if and where it is allowed.</para>"},"enableDriveRedirectionCache":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.</para>"},"enableZOrder":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Enable Z-Order' option is enabled or disabled. (Experimental)</para>"},"manageRDPShortpath":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Allow RDP Shortpath' option is enabled or disabled.</para>"},"appMonitor":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Allow Application Monitoring' option is enabled or disabled.</para>\r\n<para type=\"description\">Available to Pooled Host Pools</para>","nullable":true},"useRDPShortpath":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Allow RDP Shortpath' option is enabled or disabled.</para>"},"useSmallerPortRange":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Use Smaller Port' option is enabled or disabled.</para>"},"minRDPShortpathPort":{"type":"integer","description":"<para type=\"description\">The minimum RDP Shortpath Port.</para>","format":"int32"},"maxRDPShortpathPort":{"type":"integer","description":"<para type=\"description\">The maximum RDP Shortpath Port.</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Azure Virtual Desktop Host Pool Agent Settings</para>\r\n<para type=\"description\"></para>"},"AllowURLAndMailRedirection":{"enum":[["0 = Disabled","1 = Enabled","2 = EnabledWithAppRegistration"]],"type":"string","description":"<para type=\"synopsis\">URL and Mail Redirection values.</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"DragAndDropModeValue":{"enum":[["0 = Disabled","1 = ClientToServer","2 = ServerToClient","3 = Bidirectional"]],"type":"string","description":"<para type=\"synopsis\">Drag and drop redirection values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ManageRDPTransportProtocol":{"enum":[["0 = Disabled","1 = BothUDPTCP","2 = OnlyTCP","3 = EitherUDPTCP"]],"type":"string","description":"<para type=\"synopsis\">Manage RDP transport protocol.</para>\r\n<para type=\"description\"></para>","format":"int32"},"FileTransferControlMode":{"enum":[["0 = Disabled","1 = ClientToServer","2 = ServerToClient","3 = Bidirectional"]],"type":"string","description":"<para type=\"synopsis\">File Transfer Control modes.</para>\r\n<para type=\"description\"></para>","format":"int32"},"UserProfileSettings":{"type":"object","properties":{"technology":{"$ref":"#/components/schemas/UserProfileTech"},"fsLogix":{"$ref":"#/components/schemas/FSLogixSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">User Profile Settings</para>\r\n<para type=\"description\"></para>"},"UserProfileTech":{"enum":[["0 = DoNotManage","1 = UPD","2 = FSLogix"]],"type":"string","description":"<para type=\"synopsis\">User Profile Technology values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"FSLogixSettings":{"type":"object","properties":{"profileContainer":{"$ref":"#/components/schemas/ProfileContainerSettings"},"officeContainer":{"$ref":"#/components/schemas/OfficeContainerSettings"},"generalSettings":{"$ref":"#/components/schemas/FSLogixGeneralSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FXLogix Settings</para>\r\n<para type=\"description\"></para>"},"ProfileContainerSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Specifies if the Container is enabled or disabled.</para>"},"locationType":{"$ref":"#/components/schemas/LocationType"},"vhdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'VHD Locations'.</para>","nullable":true},"ccdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'CCDLocations'.</para>","nullable":true},"profileDiskFormat":{"$ref":"#/components/schemas/ProfileDiskFormat"},"allocationType":{"$ref":"#/components/schemas/AllocationType"},"defaultSize":{"type":"integer","description":"<para type=\"description\">Specifies the 'Default size'.</para>","format":"int32"},"userInclusionList":{"type":"array","items":{"$ref":"#/components/schemas/UserFilter"},"description":"<para type=\"description\">Specifies the 'User Inclusion List'.</para>","nullable":true},"userExclusionList":{"type":"array","items":{"$ref":"#/components/schemas/UserFilter"},"description":"<para type=\"description\">Specifies the 'User Exclusion List'.</para>","nullable":true},"cloudCache":{"$ref":"#/components/schemas/CloudCacheSettings"},"customizeProfileFolders":{"type":"boolean","description":"<para type=\"description\">Specifies whether the 'Customize Profile Folders' is enabled or disabled.</para>"},"excludeCommonFolders":{"$ref":"#/components/schemas/ExcludeCommonFolders"},"folderInclusionList":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'Folder Inclusion List'.</para>","nullable":true},"folderExclusionList":{"type":"array","items":{"$ref":"#/components/schemas/FolderExclusion"},"description":"<para type=\"description\">Specifies the 'Folder Exclusion List'.</para>","nullable":true},"advancedSettings":{"$ref":"#/components/schemas/ProfileContainerAdvancedSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Profile Container Settings</para>\r\n<para type=\"description\"></para>"},"LocationType":{"enum":[["0 = SMBLocation","1 = CloudCache"]],"type":"string","description":"<para type=\"synopsis\">Location Type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProfileDiskFormat":{"enum":[["0 = VHD","1 = VHDX"]],"type":"string","description":"<para type=\"synopsis\">Profile Disk Format values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"AllocationType":{"enum":[["0 = Dynamic","1 = Full"]],"type":"string","description":"<para type=\"synopsis\">Allocation Type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"UserFilter":{"type":"object","properties":{"account":{"type":"string","description":"<para type=\"description\">The name of the user/group account the filter is added to.</para>","nullable":true},"type":{"$ref":"#/components/schemas/UserType"},"sid":{"type":"string","description":"<para type=\"description\">The SID of the user/group account the filter is added to.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">User filter</para>\r\n<para type=\"description\"></para>"},"CloudCacheSettings":{"type":"object","properties":{"useMaxCacheSizeInMBs":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Max cache size in MBs' option is enabled or disabled.</para>"},"maxCacheSizeInMBs":{"type":"integer","description":"<para type=\"description\">Specifies the 'Max cache size in MBs'.</para>","format":"int32"},"useClearCacheOnLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Clear cache on logoff' option is enabled or disabled.</para>"},"clearCacheOnLogoff":{"$ref":"#/components/schemas/EnableState"},"useHealthyProvidersRequiredForRegister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Healthy providers required for register' option is enabled or disabled.</para>"},"healthyProvidersRequiredForRegister":{"type":"integer","description":"<para type=\"description\">Specifies the 'Healthy providers required for register'.</para>","format":"int32"},"useHealthyProvidersRequiredForUnregister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.</para>"},"healthyProvidersRequiredForUnregister":{"type":"integer","description":"<para type=\"description\">Specifies the 'Healthy providers required for unregister'.</para>","format":"int32"},"useUnregisterTimeout":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Unregister timeout' option is enabled or disabled.</para>"},"unregisterTimeout":{"type":"integer","description":"<para type=\"description\">Specifies the 'Unregister timeout'.</para>","format":"int32"},"useClearCacheOnForcedUnregister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.</para>"},"clearCacheOnForcedUnregister":{"$ref":"#/components/schemas/EnableState"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Cloud Cache Settings</para>\r\n<para type=\"description\"></para>"},"EnableState":{"enum":[["0 = Disable","1 = Enable"]],"type":"string","description":"<para type=\"synopsis\">Enable State values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ExcludeCommonFolders":{"enum":[["1 = Contacts","2 = Desktop","4 = Documents","8 = Links","16 = MusicPodcasts","32 = PicturesVideos","64 = FoldersLowIntegProcesses","128 = Downloads"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Exclude Common Folders.</para>\r\n<para type=\"description\"></para>","format":"int32"},"FolderExclusion":{"type":"object","properties":{"folder":{"type":"string","description":"<para type=\"description\">Specifies the 'Folder' path.</para>","nullable":true},"excludeFolderCopy":{"$ref":"#/components/schemas/ExcludeFolderCopy"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Folder Exclusion Settings</para>\r\n<para type=\"description\"></para>"},"ExcludeFolderCopy":{"enum":[["0 = None","1 = CopyBase","2 = CopyBack"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Exclude Folder Copy values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProfileContainerAdvancedSettings":{"type":"object","properties":{"useLockedRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.</para>"},"lockedRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Number of locked VHD(X) retries'.</para>","format":"int32"},"useLockedRetryInterval":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.</para>"},"lockedRetryInterval":{"type":"integer","description":"<para type=\"description\">Specifies the 'Delay between locked VHD(X) retries'.</para>","format":"int32"},"useAccessNetworkAsComputerObject":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Access network as computer object' option is enabled or disabled.</para>"},"accessNetworkAsComputerObject":{"$ref":"#/components/schemas/EnableState"},"useAttachVHDSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.</para>"},"attachVHDSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'SDDL used when attaching the VHD'.</para>","nullable":true},"useDiffDiskParentFolderPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Diff disk parent folder path' option is enabled or disabled.</para>"},"diffDiskParentFolderPath":{"type":"string","description":"<para type=\"description\">Specifies the 'Diff disk parent folder path'.</para>","nullable":true},"useFlipFlopProfileDirectoryName":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.</para>"},"flipFlopProfileDirectoryName":{"$ref":"#/components/schemas/EnableState"},"useNoProfileContainingFolder":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.</para>"},"noProfileContainingFolder":{"$ref":"#/components/schemas/EnableState"},"useOutlookCachedMode":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.</para>"},"outlookCachedMode":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithFailure":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with failures' option is enabled or disabled.</para>"},"preventLoginWithFailure":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithTempProfile":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.</para>"},"preventLoginWithTempProfile":{"$ref":"#/components/schemas/EnableState"},"useReAttachRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach retry limit' option is enabled or disabled.</para>"},"reAttachRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach retry limit'.</para>","format":"int32"},"useReAttachIntervalSeconds":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach interval' option is enabled or disabled.</para>"},"reAttachIntervalSeconds":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach interval'.</para>","format":"int32"},"useRemoveOrphanedOSTFilesOnLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.</para>"},"removeOrphanedOSTFilesOnLogoff":{"$ref":"#/components/schemas/EnableState"},"useRoamSearch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Search roaming feature mode' option is enabled or disabled.</para>"},"roamSearch":{"$ref":"#/components/schemas/RoamSearch"},"useSIDDirNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.</para>"},"sidDirNameMatch":{"type":"string","description":"<para type=\"description\">Specifies the 'User-to-Profile matching pattern'.</para>","nullable":true},"useSIDDirNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile folder naming pattern' option is enabled or disabled.</para>"},"sidDirNamePattern":{"type":"string","description":"<para type=\"description\">Specifies the 'Profile folder naming pattern'.</para>","nullable":true},"useSIDDirSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.</para>"},"sidDirSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'Use SSDL on creation of SID container folder'.</para>","nullable":true},"useVHDNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.</para>"},"vhdNameMatch":{"type":"string","description":"<para type=\"description\">Specifies the 'Profile VHD(X) file matching pattern'.</para>","nullable":true},"useVHDNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.</para>"},"vhdNamePattern":{"type":"string","description":"<para type=\"description\">Specifies the 'Naming pattern for new VHD(X) files'.</para>","nullable":true},"useVHDXSectorSize":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHDX sector size' option is enabled or disabled.</para>"},"vhdxSectorSize":{"$ref":"#/components/schemas/VHDXSectorSize"},"useVolumeWaitTimeMS":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Volume wait time' option is enabled or disabled.</para>"},"volumeWaitTimeMS":{"type":"integer","description":"<para type=\"description\">Specifies the 'Volume wait time'.</para>","format":"int32"},"useIgnoreNonAVD":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled.</para>"},"ignoreNonAVD":{"$ref":"#/components/schemas/IgnoreNonAVD"},"useRedirectType":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Redirect type' option is enabled or disabled.</para>"},"redirectType":{"$ref":"#/components/schemas/RedirectType"},"useKeepLocalDir":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Keep local profiles' option is enabled or disabled.</para>"},"keepLocalDir":{"$ref":"#/components/schemas/EnableState"},"useDeleteLocalProfileWhenVHDShouldApply":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.</para>"},"deleteLocalProfileWhenVHDShouldApply":{"$ref":"#/components/schemas/EnableState"},"useProfileDirSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.</para>"},"profileDirSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'Custom SDDL for profile directory'.</para>","nullable":true},"useProfileType":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile type' option is enabled or disabled.</para>"},"profileType":{"$ref":"#/components/schemas/ProfileType"},"useSetTempToLocalPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.</para>"},"setTempToLocalPath":{"$ref":"#/components/schemas/TempFolderRedirectionMode"},"useCleanOutNotifications":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Clean out notifications' option is enabled or disabled.</para>"},"cleanOutNotifications":{"$ref":"#/components/schemas/EnableState"},"useInstallAppxPackages":{"type":"boolean","description":"<para type=\"description\">Specifies if the Install Appx packages' option is enabled or disabled.</para>"},"installAppxPackages":{"$ref":"#/components/schemas/EnableState"},"useRebootOnUserLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.</para>"},"rebootOnUserLogoff":{"$ref":"#/components/schemas/EnableState"},"useRoamIdentity":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Roam identity' option is enabled or disabled.</para>"},"roamIdentity":{"$ref":"#/components/schemas/EnableState"},"useShutdownOnUserLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.</para>"},"shutdownOnUserLogoff":{"$ref":"#/components/schemas/EnableState"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Profile Container Advanced Settings</para>\r\n<para type=\"description\"></para>"},"RoamSearch":{"enum":[["0 = Disable","1 = SingleUser","2 = MultiUser"]],"type":"string","description":"<para type=\"synopsis\">Roam search values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"VHDXSectorSize":{"enum":[["0 = SystemDefault","512 = Size_512","4096 = Size_4096"]],"type":"string","description":"<para type=\"synopsis\">Enable State values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"IgnoreNonAVD":{"enum":[["0 = AnySession","1 = AVDSessions"]],"type":"string","description":"<para type=\"synopsis\">Ignore non-AVD values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"RedirectType":{"enum":[["1 = Legacy","2 = Advanced"]],"type":"string","description":"<para type=\"synopsis\">Redirect type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProfileType":{"enum":[["0 = NormalProfile","1 = OnlyRWProfile","2 = OnlyROProfile","3 = RWROProfile"]],"type":"string","description":"<para type=\"synopsis\">Profile Type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"TempFolderRedirectionMode":{"enum":[["0 = TakeNoAction","1 = RedirectTempAndTmp","2 = RedirectINetCache","3 = RedirectTempTmpAndINetCache"]],"type":"string","description":"<para type=\"synopsis\">Temporary Folder Redirection Mode values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"OfficeContainerSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Specifies if the Container is enabled or disabled.</para>"},"locationType":{"$ref":"#/components/schemas/LocationType"},"vhdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'VHD Locations'.</para>","nullable":true},"ccdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'CCDLocations'.</para>","nullable":true},"profileDiskFormat":{"$ref":"#/components/schemas/ProfileDiskFormat"},"allocationType":{"$ref":"#/components/schemas/AllocationType"},"defaultSize":{"type":"integer","description":"<para type=\"description\">Specifies the 'Default size'.</para>","format":"int32"},"userInclusionList":{"type":"array","items":{"$ref":"#/components/schemas/UserFilter"},"description":"<para type=\"description\">Specifies the 'User Inclusion List'.</para>","nullable":true},"userExclusionList":{"type":"array","items":{"$ref":"#/components/schemas/UserFilter"},"description":"<para type=\"description\">Specifies the 'User Exclusion List'.</para>","nullable":true},"cloudCache":{"$ref":"#/components/schemas/CloudCacheSettings"},"advancedSettings":{"$ref":"#/components/schemas/OfficeContainerAdvancedSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Office Container Settings</para>\r\n<para type=\"description\"></para>"},"OfficeContainerAdvancedSettings":{"type":"object","properties":{"useLockedRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.</para>"},"lockedRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Number of locked VHD(X) retries'.</para>","format":"int32"},"useLockedRetryInterval":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.</para>"},"lockedRetryInterval":{"type":"integer","description":"<para type=\"description\">Specifies the 'Delay between locked VHD(X) retries'.</para>","format":"int32"},"useAccessNetworkAsComputerObject":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Access network as computer object' option is enabled or disabled.</para>"},"accessNetworkAsComputerObject":{"$ref":"#/components/schemas/EnableState"},"useAttachVHDSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.</para>"},"attachVHDSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'SDDL used when attaching the VHD'.</para>","nullable":true},"useDiffDiskParentFolderPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Diff disk parent folder path' option is enabled or disabled.</para>"},"diffDiskParentFolderPath":{"type":"string","description":"<para type=\"description\">Specifies the 'Diff disk parent folder path'.</para>","nullable":true},"useFlipFlopProfileDirectoryName":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.</para>"},"flipFlopProfileDirectoryName":{"$ref":"#/components/schemas/EnableState"},"useNoProfileContainingFolder":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.</para>"},"noProfileContainingFolder":{"$ref":"#/components/schemas/EnableState"},"useOutlookCachedMode":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.</para>"},"outlookCachedMode":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithFailure":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with failures' option is enabled or disabled.</para>"},"preventLoginWithFailure":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithTempProfile":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.</para>"},"preventLoginWithTempProfile":{"$ref":"#/components/schemas/EnableState"},"useReAttachRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach retry limit' option is enabled or disabled.</para>"},"reAttachRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach retry limit'.</para>","format":"int32"},"useReAttachIntervalSeconds":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach interval' option is enabled or disabled.</para>"},"reAttachIntervalSeconds":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach interval'.</para>","format":"int32"},"useRemoveOrphanedOSTFilesOnLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.</para>"},"removeOrphanedOSTFilesOnLogoff":{"$ref":"#/components/schemas/EnableState"},"useRoamSearch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Search roaming feature mode' option is enabled or disabled.</para>"},"roamSearch":{"$ref":"#/components/schemas/RoamSearch"},"useSIDDirNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.</para>"},"sidDirNameMatch":{"type":"string","description":"<para type=\"description\">Specifies the 'User-to-Profile matching pattern'.</para>","nullable":true},"useSIDDirNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile folder naming pattern' option is enabled or disabled.</para>"},"sidDirNamePattern":{"type":"string","description":"<para type=\"description\">Specifies the 'Profile folder naming pattern'.</para>","nullable":true},"useSIDDirSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.</para>"},"sidDirSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'Use SSDL on creation of SID container folder'.</para>","nullable":true},"useVHDNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.</para>"},"vhdNameMatch":{"type":"string","description":"<para type=\"description\">Specifies the 'Profile VHD(X) file matching pattern'.</para>","nullable":true},"useVHDNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.</para>"},"vhdNamePattern":{"type":"string","description":"<para type=\"description\">Specifies the 'Naming pattern for new VHD(X) files'.</para>","nullable":true},"useVHDXSectorSize":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHDX sector size' option is enabled or disabled.</para>"},"vhdxSectorSize":{"$ref":"#/components/schemas/VHDXSectorSize"},"useVolumeWaitTimeMS":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Volume wait time' option is enabled or disabled.</para>"},"volumeWaitTimeMS":{"type":"integer","description":"<para type=\"description\">Specifies the 'Volume wait time'.</para>","format":"int32"},"useIgnoreNonAVD":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled.</para>"},"ignoreNonAVD":{"$ref":"#/components/schemas/IgnoreNonAVD"},"useRedirectType":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Redirect type' option is enabled or disabled.</para>"},"redirectType":{"$ref":"#/components/schemas/RedirectType"},"useIncludeOfficeActivation":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Office Activation' option is enabled or disabled.</para>"},"includeOfficeActivation":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneDrive":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneDrive' option is enabled or disabled.</para>"},"includeOneDrive":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneNote":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneNote' option is enabled or disabled.</para>"},"includeOneNote":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneNoteUWP":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneNote UWP' option is enabled or disabled.</para>"},"includeOneNoteUWP":{"$ref":"#/components/schemas/EnableState"},"useIncludeOutlook":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Outlook' option is enabled or disabled.</para>"},"includeOutlook":{"$ref":"#/components/schemas/EnableState"},"useIncludeOutlookPersonalization":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Outlook Personalization' option is enabled or disabled.</para>"},"includeOutlookPersonalization":{"$ref":"#/components/schemas/EnableState"},"useIncludeSharepoint":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Sharepoint' option is enabled or disabled.</para>"},"includeSharepoint":{"$ref":"#/components/schemas/EnableState"},"useIncludeTeams":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Teams' option is enabled or disabled.</para>"},"includeTeams":{"$ref":"#/components/schemas/EnableState"},"useMirrorLocalOSTToVHD":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.</para>"},"mirrorLocalOSTToVHD":{"$ref":"#/components/schemas/MirrorLocalOSTToVHD"},"useNumSessionVHDsToKeep":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.</para>"},"numSessionVHDsToKeep":{"type":"integer","description":"<para type=\"description\">Specifies the 'Number of Session VHDs to Keep'.</para>","format":"int32"},"useOutlookFolderPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Outlook Folder Path' option is enabled or disabled.</para>"},"outlookFolderPath":{"type":"string","description":"<para type=\"description\">Specifies the 'Outlook Folder Path'.</para>","nullable":true},"useRefreshUserPolicy":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Refresh User Policy' option is enabled or disabled.</para>"},"refreshUserPolicy":{"$ref":"#/components/schemas/EnableState"},"useVHDAccessMode":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHD Access Mode' option is enabled or disabled.</para>"},"vhdAccessMode":{"$ref":"#/components/schemas/VHDAccessMode"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Office Container Advanced Settings</para>\r\n<para type=\"description\"></para>"},"MirrorLocalOSTToVHD":{"enum":[["0 = DoNothing","1 = Copy","2 = Move"]],"type":"string","description":"<para type=\"synopsis\">Mirror Local OST-VHD values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"VHDAccessMode":{"enum":[["0 = NormalDirectAccess","1 = DiffDiskNetwork","2 = DiffDiskLocal","3 = UniqueVHDPerSession"]],"type":"string","description":"<para type=\"synopsis\">VHD Access Mode values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"FSLogixGeneralSettings":{"type":"object","properties":{"appServices":{"$ref":"#/components/schemas/AppServicesSettings"},"cloudCacheGeneral":{"$ref":"#/components/schemas/CloudCacheGeneralSettings"},"logging":{"$ref":"#/components/schemas/FSLogixLoggingSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix General Settings</para>\r\n<para type=\"description\"></para>"},"AppServicesSettings":{"type":"object","properties":{"useCleanupInvalidSessions":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.</para>"},"cleanupInvalidSessions":{"$ref":"#/components/schemas/EnableState"},"useRoamRecycleBin":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Roam recycle bin' option is enabled or disabled.</para>"},"roamRecycleBin":{"$ref":"#/components/schemas/EnableState"},"useVHDCompactDisk":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHD compact disk' option is enabled or disabled.</para>"},"vhdCompactDisk":{"$ref":"#/components/schemas/EnableState"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix App Services Settings</para>\r\n<para type=\"description\"></para>"},"CloudCacheGeneralSettings":{"type":"object","properties":{"useCacheDirectory":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Cache directory' option is enabled or disabled.</para>"},"cacheDirectory":{"type":"string","description":"<para type=\"description\">Specifies the 'Cache directory'.</para>","nullable":true},"useWriteCacheDirectory":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Write cache directory' option is enabled or disabled.</para>"},"writeCacheDirectory":{"type":"string","description":"<para type=\"description\">Specifies the 'Write cache directory'.</para>","nullable":true},"useProxyDirectory":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Proxy directory' option is enabled or disabled.</para>"},"proxyDirectory":{"type":"string","description":"<para type=\"description\">Specifies the 'Proxy directory'.</para>","nullable":true},"useSilenceACLWarning":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Silence ACL warning' option is enabled or disabled.</para>"},"silenceACLWarning":{"$ref":"#/components/schemas/EnableState"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Cloud Cache General Settings</para>\r\n<para type=\"description\"></para>"},"FSLogixLoggingSettings":{"type":"object","properties":{"logEnabled":{"$ref":"#/components/schemas/FSLogixLogEnabled"},"logLevel":{"$ref":"#/components/schemas/FSLogixLogLevel"},"logFileKeepingPeriod":{"type":"integer","description":"<para type=\"description\">Specifies the 'Log keeping period in days'. Default: '2'.</para>","format":"int32"},"logDirectory":{"type":"string","description":"<para type=\"description\">Specifies the 'Log directory'. Default: '%ProgramData%\\FSLogix\\Logs'.</para>","nullable":true},"robocopyLogPath":{"type":"string","description":"<para type=\"description\">Specifies the 'Robocopy log path'.</para>","nullable":true},"logSpecificComponents":{"$ref":"#/components/schemas/LogSpecificComponents"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Logging Settings</para>\r\n<para type=\"description\"></para>"},"FSLogixLogEnabled":{"enum":[["0 = Disable","1 = Specific","2 = All"]],"type":"string","description":"<para type=\"synopsis\">Log enabled values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"FSLogixLogLevel":{"enum":[["0 = Debug","1 = Information","2 = Warning","3 = Error"]],"type":"string","description":"<para type=\"synopsis\">FSLogix log level values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"LogSpecificComponents":{"enum":[["1 = ProfileConfigTool","2 = IEPlugin","4 = RuleEditor","8 = JavaRuleEditor","16 = FSLogixAgentService","32 = Profile","64 = JavaLauncher","128 = OfficeContainer","256 = RuleCompilation","512 = FontVisibility","1024 = Network","2048 = PrinterVisibility","4096 = ADSComputerGroup","8192 = DriverInterface","16384 = WindowsSearchRoaming","32768 = WindowsSearchPlugin","65536 = ProcessStartMonitor"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Log specific components values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"AppPackagesAssigned":{"type":"object","properties":{"applicationPackagesAssigned":{"type":"array","items":{"$ref":"#/components/schemas/AppPackageAssigned"},"description":"<para type=\"synopsis\">List of Application Packages Assigned</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Application Packages Assigned</para>\r\n<para type=\"description\"></para>"},"AppPackageAssigned":{"type":"object","properties":{"version":{"type":"string","description":"<para type=\"description\">Application version</para>","nullable":true},"tagName":{"type":"string","description":"<para type=\"description\">Application version tag name</para>","nullable":true},"tagId":{"type":"integer","description":"<para type=\"description\">Application version tag ID</para>","format":"int32","nullable":true},"packageName":{"type":"string","description":"<para type=\"description\">Assigned application package name</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Application Package Assigned</para>\r\n<para type=\"description\"></para>"},"ImageOptimization":{"type":"object","properties":{"enableOptimization":{"type":"boolean","description":"<para type=\"synopsis\">Whether Optimization is enabled or not</para>\r\n<para type=\"description\"></para>"},"optimizationType":{"$ref":"#/components/schemas/OptimizationTypeEnum"},"windowsDefenderATP":{"$ref":"#/components/schemas/WindowsDefenderATP"},"windowsComponents":{"$ref":"#/components/schemas/WindowsComponents"},"windowsDefenderATPEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Defender ATP is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsComponentsEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Components is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsServicesEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Services is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsScheduledTasksEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Scheduled Task is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsAdvancedOptionsEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Advanced Options is enabled or not</para>\r\n<para type=\"description\"></para>"},"networkPerformanceEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Network Performance is enabled or not</para>\r\n<para type=\"description\"></para>"},"registryEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Registry is enabled or not</para>\r\n<para type=\"description\"></para>"},"visualEffectsEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Visual Effects is enabled or not</para>\r\n<para type=\"description\"></para>"},"diskCleanupEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Disk Cleanup is enabled or not</para>\r\n<para type=\"description\"></para>"},"customScriptEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Custom Script is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsServices":{"$ref":"#/components/schemas/WindowsServices"},"windowsAdvancedOptions":{"$ref":"#/components/schemas/WindowsAdvancedOptions"},"networkPerformance":{"$ref":"#/components/schemas/NetworkPerformance"},"customScript":{"$ref":"#/components/schemas/CustomScript"},"diskCleanup":{"$ref":"#/components/schemas/DiskCleanup"},"visualEffects":{"$ref":"#/components/schemas/VisualEffects"},"windowsScheduledTasks":{"$ref":"#/components/schemas/WindowsScheduledTasks"},"registry":{"$ref":"#/components/schemas/Registries"},"uwpApps":{"$ref":"#/components/schemas/UWPApps"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization</para>\r\n<para type=\"description\"></para>"},"OptimizationTypeEnum":{"enum":[["0 = Automatic","1 = Manual"]],"type":"string","description":"<para type=\"synopsis\">Optimization Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowsDefenderATP":{"type":"object","properties":{"winDefATPTurnOffOn":{"$ref":"#/components/schemas/WindowsDefenderATPEnable"},"disableRealTimeProtection":{"type":"boolean","description":"<para type=\"synopsis\">Disable Real Time Protection</para>\r\n<para type=\"description\"></para>"},"excludeFolders":{"type":"array","items":{"type":"string"},"description":"<para type=\"synopsis\">Exclude Folders List</para>\r\n<para type=\"description\"></para>","nullable":true},"excludeProcesses":{"type":"array","items":{"type":"string"},"description":"<para type=\"synopsis\">Exclude Processes</para>\r\n<para type=\"description\"></para>","nullable":true},"excludeExtension":{"type":"array","items":{"type":"string"},"description":"<para type=\"synopsis\">Exclude Extensions</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Defender ATP</para>\r\n<para type=\"description\"></para>"},"WindowsDefenderATPEnable":{"enum":[["0 = TurnOffWindowsDefenderATP","1 = TurnOnWindowsDefenderATP"]],"type":"string","description":"<para type=\"synopsis\">Windows enable options</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowsComponents":{"type":"object","properties":{"windowsComponentsList":{"type":"array","items":{"$ref":"#/components/schemas/WindowsComponent"},"description":"<para type=\"synopsis\">Windows Components List</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Components</para>\r\n<para type=\"description\"></para>"},"WindowsComponent":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DetailsType"},"componentName":{"type":"string","description":"<para type=\"synopsis\">Windows Components Name</para>\r\n<para type=\"description\"></para>","nullable":true},"displayName":{"type":"string","description":"<para type=\"synopsis\">Windows Components Display Name</para>\r\n<para type=\"description\"></para>","nullable":true},"aliases":{"type":"string","description":"<para type=\"synopsis\">Windows Components Aliases</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image optimization windows component</para>\r\n<para type=\"description\"></para>"},"DetailsType":{"enum":[["0 = Predefined","1 = Custom"]],"type":"string","description":"<para type=\"synopsis\">Details Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowsServices":{"type":"object","properties":{"windowsServicesList":{"type":"array","items":{"$ref":"#/components/schemas/WindowsService"},"description":"<para type=\"synopsis\">Windows Services List</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Services</para>\r\n<para type=\"description\"></para>"},"WindowsService":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DetailsType"},"serviceName":{"type":"string","description":"<para type=\"synopsis\">Windows Services Name</para>\r\n<para type=\"description\"></para>","nullable":true},"displayName":{"type":"string","description":"<para type=\"synopsis\">Windows Services Display Name</para>\r\n<para type=\"description\"></para>","nullable":true},"aliases":{"type":"string","description":"<para type=\"synopsis\">Windows Service Aliases</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image optimization windows services</para>\r\n<para type=\"description\"></para>"},"WindowsAdvancedOptions":{"type":"object","properties":{"partialStartLayoutContent":{"type":"string","description":"<para type=\"synopsis\">Partial Start menu layout</para>\r\n<para type=\"description\"></para>","nullable":true},"hibernate":{"type":"boolean","description":"<para type=\"synopsis\">Whether Hibernate is enabled or not</para>\r\n<para type=\"description\"></para>"},"teleCollection":{"type":"boolean","description":"<para type=\"synopsis\">Whether TeleCollection is enabled or not</para>\r\n<para type=\"description\"></para>"},"systemRestore":{"type":"boolean","description":"<para type=\"synopsis\">Whether System Restore is enabled or not</para>\r\n<para type=\"description\"></para>"},"additionalErrorReport":{"type":"boolean","description":"<para type=\"synopsis\">Whether Additional Error Reporting is enabled or not</para>\r\n<para type=\"description\"></para>"},"tiles":{"type":"boolean","description":"<para type=\"synopsis\">Whether Tiles is enabled or not</para>\r\n<para type=\"description\"></para>"},"cortana":{"type":"boolean","description":"<para type=\"synopsis\">Whether Cortana is enabled or not</para>\r\n<para type=\"description\"></para>"},"microsoftConsumerExperience":{"type":"boolean","description":"<para type=\"synopsis\">Whether Microsoft Consumer Experience is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsTips":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Tips is enabled or not</para>\r\n<para type=\"description\"></para>"},"commonProgramGroups":{"type":"boolean","description":"<para type=\"synopsis\">Whether Common Program Groups is enabled or not</para>\r\n<para type=\"description\"></para>"},"partialStartMenu":{"type":"boolean","description":"<para type=\"synopsis\">Whether Partial Start Menu is enabled or not</para>\r\n<para type=\"description\"></para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Advanced Options</para>\r\n<para type=\"description\"></para>"},"NetworkPerformance":{"type":"object","properties":{"dirCacheMax":{"type":"integer","description":"<para type=\"synopsis\">Directory Cache Value</para>\r\n<para type=\"description\"></para>","format":"int32"},"dormantFileLimit":{"type":"integer","description":"<para type=\"synopsis\">Dormant File Limit Value</para>\r\n<para type=\"description\"></para>","format":"int32"},"fileNotFoundCache":{"type":"integer","description":"<para type=\"synopsis\">File Not Found Cache Value</para>\r\n<para type=\"description\"></para>","format":"int32"},"fileInfoCache":{"type":"integer","description":"<para type=\"synopsis\">File Info Cache Value</para>\r\n<para type=\"description\"></para>","format":"int32"},"fileInfoCacheEnable":{"type":"boolean","description":"<para type=\"synopsis\">Whether File Info Cache is enabled or not</para>\r\n<para type=\"description\"></para>"},"directoryCacheEnable":{"type":"boolean","description":"<para type=\"synopsis\">Whether Directory Cache is enabled or not</para>\r\n<para type=\"description\"></para>"},"fileNotFoundCacheEnable":{"type":"boolean","description":"<para type=\"synopsis\">Whether File Not Found Cache is enabled or not</para>\r\n<para type=\"description\"></para>"},"dormantFileLimitEnable":{"type":"boolean","description":"<para type=\"synopsis\">Whether Dormant File Limit is enabled or not</para>\r\n<para type=\"description\"></para>"},"disableTCP":{"type":"boolean","description":"<para type=\"synopsis\">Whether TCP is disabled or not</para>\r\n<para type=\"description\"></para>"},"disableIPv6CompEnable":{"type":"boolean","description":"<para type=\"synopsis\">Whether Disable IPv6 Components is enabled or not</para>\r\n<para type=\"description\"></para>"},"disableIPv6ToIPv4":{"type":"boolean","description":"<para type=\"synopsis\">Whether Disable IPv6 To IPv4 is enabled or not</para>\r\n<para type=\"description\"></para>"},"disableIsaTap":{"type":"boolean","description":"<para type=\"synopsis\">Whether Disable IsaTap for IPv6 is enabled or not</para>\r\n<para type=\"description\"></para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Network Performance</para>\r\n<para type=\"description\"></para>"},"CustomScript":{"type":"object","properties":{"arguments":{"type":"string","description":"<para type=\"synopsis\">Arguments</para>\r\n<para type=\"description\"></para>","nullable":true},"command":{"type":"string","description":"<para type=\"synopsis\">Command</para>\r\n<para type=\"description\"></para>","nullable":true},"initDir":{"type":"string","description":"<para type=\"synopsis\">Initial Directory</para>\r\n<para type=\"description\"></para>","nullable":true},"user":{"type":"string","description":"<para type=\"synopsis\">User</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Custom Script</para>\r\n<para type=\"description\"></para>"},"DiskCleanup":{"type":"object","properties":{"cleanupWinSxSFolder":{"type":"boolean","description":"<para type=\"synopsis\">Whether Clean up windows SxS Folder is enabled or not</para>\r\n<para type=\"description\"></para>"},"cleanupSystemFiles":{"type":"boolean","description":"<para type=\"synopsis\">Whether Clean up system files is enabled or not</para>\r\n<para type=\"description\"></para>"},"cleanupTemporaryFileLogs":{"type":"boolean","description":"<para type=\"synopsis\">Whether Clean up temporary file logs is enabled or not</para>\r\n<para type=\"description\"></para>"},"removeOneDrive":{"type":"boolean","description":"<para type=\"synopsis\">Whether Remove One Drives is enabled or not</para>\r\n<para type=\"description\"></para>"},"deleteUserProfiles":{"type":"boolean","description":"<para type=\"synopsis\">Whether Delete User Profiles is enabled or not</para>\r\n<para type=\"description\"></para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Disk Cleanup</para>\r\n<para type=\"description\"></para>"},"VisualEffects":{"type":"object","properties":{"visualEffectsTypes":{"$ref":"#/components/schemas/VisualEffectsType"},"animateControlSelectElements":{"type":"boolean","description":"<para type=\"synopsis\">Whether Animate Control Select Elements is enabled or not</para>\r\n<para type=\"description\"></para>"},"animateWindowsWhenMinimizingMaximizing":{"type":"boolean","description":"<para type=\"synopsis\">Whether Animate Windows When Minimizing Or Maximizing is enabled or not</para>\r\n<para type=\"description\"></para>"},"animateTaskbar":{"type":"boolean","description":"<para type=\"synopsis\">Whether Animate Taskbar is enabled or not</para>\r\n<para type=\"description\"></para>"},"enablePeek":{"type":"boolean","description":"<para type=\"synopsis\">Whether Peek is enabled or not</para>\r\n<para type=\"description\"></para>"},"fadeSlideMenus":{"type":"boolean","description":"<para type=\"synopsis\">Whether Fade Slide Menus is enabled or not</para>\r\n<para type=\"description\"></para>"},"fadeSlideToolTips":{"type":"boolean","description":"<para type=\"synopsis\">Whether Fade Slide Tool Tips is enabled or not</para>\r\n<para type=\"description\"></para>"},"fadeOutMenuItems":{"type":"boolean","description":"<para type=\"synopsis\">Whether Fade Out Menu Items is enabled or not</para>\r\n<para type=\"description\"></para>"},"saveTaskbarThumbnail":{"type":"boolean","description":"<para type=\"synopsis\">Whether Taskbar Thumbnail is enabled or not</para>\r\n<para type=\"description\"></para>"},"showShadowUnderMouse":{"type":"boolean","description":"<para type=\"synopsis\">Whether Shadow Under Mouse is enabled or not</para>\r\n<para type=\"description\"></para>"},"shadowUnderWindows":{"type":"boolean","description":"<para type=\"synopsis\">Whether Shadow Under Windows is enabled or not</para>\r\n<para type=\"description\"></para>"},"thumbnailsInsteadOfIcons":{"type":"boolean","description":"<para type=\"synopsis\">Whether Thumbnails instead of icons is enabled or not</para>\r\n<para type=\"description\"></para>"},"showTranslucentSelection":{"type":"boolean","description":"<para type=\"synopsis\">Whether Translucent Selection is enabled or not</para>\r\n<para type=\"description\"></para>"},"showWindowsContentWhilstDragging":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Content Whilst Dragging is enabled or not</para>\r\n<para type=\"description\"></para>"},"slideOpenComboBoxes":{"type":"boolean","description":"<para type=\"synopsis\">Whether Slide open combo boxes is enabled or not</para>\r\n<para type=\"description\"></para>"},"smoothEdgesScreenFonts":{"type":"boolean","description":"<para type=\"synopsis\">Whether Smooth Edges Screen Fonts is enabled or not</para>\r\n<para type=\"description\"></para>"},"smoothScrollListBoxes":{"type":"boolean","description":"<para type=\"synopsis\">Whether Smooth Scroll List Boxes is enabled or not</para>\r\n<para type=\"description\"></para>"},"dropShadowsIcon":{"type":"boolean","description":"<para type=\"synopsis\">Whether Drop Shadow Icon is enabled or not</para>\r\n<para type=\"description\"></para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Visual Effects</para>\r\n<para type=\"description\"></para>"},"VisualEffectsType":{"enum":[["0 = LetWindowsChooseWhatsBest","1 = AdjustForBestAppearance","2 = AdjustForBestPerformance","3 = Custom"]],"type":"string","description":"<para type=\"synopsis\">Visual Effects Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowsScheduledTasks":{"type":"object","properties":{"windowsScheduledTasksList":{"type":"array","items":{"$ref":"#/components/schemas/ImageOptimizationWindowsScheduledTask"},"description":"<para type=\"descrition\">The Windows Scheduled Tasks List</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Scheduled Tasks</para>\r\n<para type=\"description\">A List of Windows Scheduled Task settings</para>"},"ImageOptimizationWindowsScheduledTask":{"type":"object","properties":{"task":{"type":"string","description":"<para type=\"synopsis\">Scheduled Task</para>\r\n<para type=\"description\"></para>","nullable":true},"location":{"type":"string","description":"<para type=\"synopsis\">Scheduled Task Location</para>\r\n<para type=\"description\"></para>","nullable":true},"type":{"$ref":"#/components/schemas/OptimizationFileType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Scheduled Task</para>\r\n<para type=\"description\"></para>"},"OptimizationFileType":{"enum":[["0 = Folder","1 = Task"]],"type":"string","description":"<para type=\"synopsis\">Whether file type is a folder or a task.</para>\r\n<para type=\"description\"></para>","format":"int32"},"Registries":{"type":"object","properties":{"registryList":{"type":"array","items":{"$ref":"#/components/schemas/Registry"},"description":"<para type=\"descrition\">The Registry List</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Registries</para>\r\n<para type=\"description\">A list of Registries</para>"},"Registry":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"synopsis\">The Id of the registry</para>\r\n<para type=\"description\"></para>","format":"int32"},"action":{"$ref":"#/components/schemas/ActionType"},"registryName":{"type":"string","description":"<para type=\"synopsis\">Registry Name</para>\r\n<para type=\"description\"></para>","nullable":true},"dwordValue":{"type":"integer","description":"<para type=\"synopsis\">Value</para>\r\n<para type=\"description\"></para>","format":"int32"},"displayName":{"type":"string","description":"<para type=\"synopsis\">Display Name</para>\r\n<para type=\"description\"></para>","nullable":true},"hiveType":{"$ref":"#/components/schemas/HiveType"},"path":{"type":"string","description":"<para type=\"synopsis\">Path</para>\r\n<para type=\"description\"></para>","nullable":true},"regType":{"$ref":"#/components/schemas/ValueType"},"stringValue":{"type":"string","description":"<para type=\"synopsis\">String Value</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Registry</para>\r\n<para type=\"description\"></para>"},"ActionType":{"enum":[["0 = Add","1 = Modify","2 = Delete"]],"type":"string","description":"<para type=\"synopsis\">The action type for add registry entry</para>\r\n<para type=\"description\"></para>","format":"int32"},"HiveType":{"enum":[["0 = HKEY_CURRENT_CONFIG","1 = HKEY_USERS","2 = HKEY_LOCAL_MACHINE","3 = HKEY_CLASSES_ROOT"]],"type":"string","description":"<para type=\"synopsis\">The hive type for add registry entry</para>\r\n<para type=\"description\"></para>","format":"int32"},"ValueType":{"enum":[["0 = REG_SZ","1 = REG_DWORD","2 = REG_QWORD","3 = REG_MULTI_SZ","4 = REG_EXPAND_SZ"]],"type":"string","description":"<para type=\"synopsis\">The value type for add registry entry</para>\r\n<para type=\"description\"></para>","format":"int32"},"UWPApps":{"type":"object","properties":{"allExcept":{"type":"array","items":{"type":"string"},"description":"<para type=\"synopsis\">All Except List</para>\r\n<para type=\"description\"></para>","nullable":true},"followingPkgs":{"type":"array","items":{"type":"string"},"description":"<para type=\"synopsis\">Following Pkgs List</para>\r\n<para type=\"description\"></para>","nullable":true},"removeType":{"$ref":"#/components/schemas/RemoveType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - UWPApps</para>\r\n<para type=\"description\"></para>"},"RemoveType":{"enum":[["0 = AllExcept","1 = FollowingPkgs"]],"type":"string","description":"<para type=\"synopsis\">Remove Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"ActionSettings":{"type":"object","properties":{"sessionAction":{"$ref":"#/components/schemas/SessionAction"},"performAction":{"$ref":"#/components/schemas/PerformAction"},"performActionAfterSec":{"type":"integer","description":"<para type=\"description\">Perform action after (in seconds).</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Action Settings</para>\r\n<para type=\"description\">Available to Personal Host Pools</para>\r\n<para type=\"description\"></para>"},"SessionAction":{"enum":[["0 = Disconnect","1 = Logoff"]],"type":"string","description":"<para type=\"synopsis\">Session Action type</para>\r\n<para type=\"description\"></para>","format":"int32"},"PerformAction":{"enum":[["0 = DoNothing","2 = Shutdown","4 = Suspend","7 = Delete","8 = Restart","9 = Unassign","10 = Recreate"]],"type":"string","description":"<para type=\"synopsis\">Perform Action type</para>\r\n<para type=\"description\"></para>","format":"int32"},"RDPPrinterSettings":{"type":"object","properties":{"printerNameFormat":{"$ref":"#/components/schemas/PrnNameFormat"},"removeSessionNumberFromPrinterName":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Remove session number from printer name' option is enabled or disabled.</para>"},"removeClientNameFromPrinterName":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Remove client name from printer name' option is enabled or disabled.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Host Pool Printer Settings</para>\r\n<para type=\"description\"></para>"},"PrnNameFormat":{"enum":[["0 = PrnFormat_PRN_CMP_SES","1 = PrnFormat_SES_CMP_PRN","2 = PrnFormat_PRN_REDSES"]],"type":"string","description":"<para type=\"synopsis\">Printer Name Format</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"AutoUpgradeSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Enable auto-upgrade maintenance window</para>"},"startDateTime":{"type":"string","description":"<para type=\"description\">Start Date</para>","format":"date-time"},"drainModeDurationInSecs":{"type":"number","description":"<para type=\"description\">Drain mode duration</para>","format":"double"},"forceLogoffSessions":{"type":"boolean","description":"<para type=\"description\">Force logoff sessions at the end of the drain mode period</para>"},"repeat":{"$ref":"#/components/schemas/RepeatType"},"specificDays":{"$ref":"#/components/schemas/RepeatSpecificDays"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleMessage"},"description":"<para type=\"description\">Messages</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Auto-upgrade Settings</para>\r\n<para type=\"description\"></para>"},"RepeatType":{"enum":[["0 = Never","1 = EveryDay","2 = EveryWeek","3 = Every2Weeks","4 = EveryMonth","5 = EveryYear","6 = SpecificDays"]],"type":"string","description":"<para type=\"synopsis\">Repeat Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"RepeatSpecificDays":{"enum":[["0 = Never","1 = Sunday","2 = Monday","4 = Tuesday","8 = Wednesday","16 = Thursday","32 = Friday","64 = Saturday"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Repeat Specific Days</para>\r\n<para type=\"description\"></para>","format":"int32"},"ScheduleMessage":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"enabled":{"type":"boolean","description":"<para type=\"description\">Enabled</para>"},"messageTitle":{"type":"string","description":"<para type=\"description\">Message title</para>","nullable":true},"message":{"type":"string","description":"<para type=\"description\">Message</para>","nullable":true},"sendMsgSecs":{"type":"integer","description":"<para type=\"description\">Seconds before message is sent</para>","format":"int32"},"sendMsgWhen":{"$ref":"#/components/schemas/SendMsgWhen"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Schedule Message</para>\r\n<para type=\"description\"></para>"},"SendMsgWhen":{"enum":[["0 = Before","1 = After"]],"type":"string","description":"<para type=\"synopsis\">Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.</para>\r\n<para type=\"description\"></para>","format":"int32"},"AVDAgent":{"type":"object","properties":{"scheduleAgentUpdates":{"type":"boolean","description":"<para type=\"description\">Whether to enable schedule agent updates.</para>"},"localSessionTimeZone":{"type":"boolean","description":"<para type=\"description\">Whether to use the local session time zone or not.</para>"},"timeZone":{"type":"string","description":"<para type=\"description\">The Time Zone</para>","nullable":true},"scheduleDay1":{"$ref":"#/components/schemas/DayOfWeek"},"scheduleTime1":{"$ref":"#/components/schemas/ScheduleTime"},"enableSchedule2":{"type":"boolean","description":"<para type=\"description\">Whether to enable a second schedule.</para>"},"scheduleDay2":{"$ref":"#/components/schemas/DayOfWeek"},"scheduleTime2":{"$ref":"#/components/schemas/ScheduleTime"}},"additionalProperties":false,"description":"<para type=\"synopsis\">AVD Agent Settings</para>\r\n<para type=\"description\"></para>"},"DayOfWeek":{"enum":[["0 = Monday","1 = Tuesday","2 = Wednesday","3 = Thursday","4 = Friday","5 = Saturday","6 = Sunday"]],"type":"string","description":"<para type=\"synopsis\">Week Days</para>\r\n<para type=\"description\"></para>","format":"int32"},"ScheduleTime":{"enum":[["0 = h00","1 = h01","2 = h02","3 = h03","4 = h04","5 = h05","6 = h06","7 = h07","8 = h08","9 = h09","10 = h10","11 = h11","12 = h12","13 = h13","14 = h14","15 = h15","16 = h16","17 = h17","18 = h18","19 = h19","20 = h20","21 = h21","22 = h22","23 = h23"]],"type":"string","description":"<para type=\"synopsis\">Schedule Time</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.parallels.com/landing/ras-rest-api-guide/api-reference/infrastructure/avd/host-pool/existing.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.