Creates an Azure Virtual Desktop Host Pool from an existing Host Pool.
Azure Virtual Desktop Host Pool settings.
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.
The Workspace ID.
Enable or disable the AVD Host Pool upon creation. If the parameter is omitted, the AVD Host Pool is initialised as Disabled.
The Azure ID of the AVD Host Pool.
Whether Validation Environment is Enabled or not.
The Template ID.
The RAS Template Version ID.
Whether AutoScale is Enabled or not
The Minimum Number of Hosts added from the template. Default: 1
The Maximum Number of Hosts added from the template. Default: 2
The host name format. All VMs created from the template will have this name with %ID:N:S% replaced.
Session Type
The Workload Threshold. Default: 75
The amount of servers to add per request. Default: 1
The Drain Workload. Default: 20
The Remaining Drain level. Default: 0 (Immediate)
Remove hosts from host pool after drain and power off.
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Whether host pool is enabled or not.
The Name of the Host Pool
The Friendly Name of the Host Pool
The Description of the Host Pool
The Resource Group of the Host Pool
The location of the Host Pool
The Azure ID
The Workspace ID.
The Linked Desktop Application Group.
The Linked Remote Application Group.
AVD Configuration Settings
Pool Type
Publishing Type
Provisioning Type
Load Balancer Type
Whether Power On Host is Enabled or not.
Whether Validation Environment is Enabled or not.
The Limit of session on host.
The AVD License Type
Azure Virtual Desktop Host Pool Provisioning Settings
The Host name format. All Host created from the template will have this name with %ID:N:S% replaced.
Session Type
The maximum number of hosts that can be created from the template.
The maximum number of pre-created hosts.
The Duration
AVD AutoScale Settings
The Template ID.
The RAS Template Version ID.
Whether AutoScale is Enabled or not.
The Minimum Number of Hosts added to the template.
The Maximum Number of Hosts added to the template.
The Workload Threshold.
The amount of servers to add per request.
The Drain Workload.
The Remaining Drain level. (Seconds)
Remove hosts from host pool after drain and power off.
Whether Overwrite Size is Enabled or not.
AVD VM Size
VM Size
Offering
Family
Virtual CPUs
RAM (GiB)
Data Disk Count
Maximum IOPS
Temparary Storage (MB)
Binary Choice.
The Azure Virtual Desktop Host Pool Assignment Settings
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Azure Active Directory
Azure Active Directory Id
If true, default Agent settings will be inherited.
Azure Virtual Desktop Host Pool Agent Settings
Disconnect active session after (in seconds). 0 for 'Never'.
Logoff disconnected session after (in seconds). 0 for 'Never'; 1 for 'Immediate'.
Session readiness timeout (in seconds).
URL and Mail Redirection values.
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.
Drag and drop redirection values.
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.
Manage RDP transport protocol.
File Transfer Control modes.
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.
Specifies if 'Allow RDP Shortpath' option is enabled or disabled.
Specifies if 'Allow Application Monitoring' option is enabled or disabled.
Specifies if 'Allow RDP Shortpath' option is enabled or disabled.
Specifies if 'Use Smaller Port' option is enabled or disabled.
The minimum RDP Shortpath Port.
The maximum RDP Shortpath Port.
If true, default User Profile settings will be inherited.
User Profile Settings
User Profile Technology values.
FXLogix Settings
FSLogix Profile Container Settings
Specifies if the Container is enabled or disabled.
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CCDLocations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Specifies the 'User Inclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Specifies the 'User Exclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
FSLogix Cloud Cache Settings
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
Specifies whether the 'Customize Profile Folders' is enabled or disabled.
Exclude Common Folders.
Specifies the 'Folder Inclusion List'.
Specifies the 'Folder Exclusion List'.
Specifies the 'Folder' path.
Exclude Folder Copy values.
FSLogix Profile Container Advanced Settings
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Keep local profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.
Enable State values.
Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.
Specifies the 'Custom SDDL for profile directory'.
Specifies if the 'Profile type' option is enabled or disabled.
Profile Type values.
Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.
Temporary Folder Redirection Mode values.
Specifies if the 'Clean out notifications' option is enabled or disabled.
Enable State values.
Specifies if the Install Appx packages' option is enabled or disabled.
Enable State values.
Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam identity' option is enabled or disabled.
Enable State values.
Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.
Enable State values.
FSLogix Office Container Settings
Specifies if the Container is enabled or disabled.
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CCDLocations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Specifies the 'User Inclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
Specifies the 'User Exclusion List'.
The name of the user/group account the filter is added to.
User Type
The SID of the user/group account the filter is added to.
FSLogix Cloud Cache Settings
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
FSLogix Office Container Advanced Settings
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Include Office Activation' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneDrive' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote' option is enabled or disabled.
Enable State values.
Specifies if the 'Include OneNote UWP' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Outlook Personalization' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Sharepoint' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Skype' option is enabled or disabled.
Enable State values.
Specifies if the 'Include Teams' option is enabled or disabled.
Enable State values.
Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.
Mirror Local OST-VHD values.
Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.
Specifies the 'Number of Session VHDs to Keep'.
Specifies if the 'Outlook Folder Path' option is enabled or disabled.
Specifies the 'Outlook Folder Path'.
Specifies if the 'Refresh User Policy' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD Access Mode' option is enabled or disabled.
VHD Access Mode values.
FSLogix General Settings
FSLogix App Services Settings
Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam recycle bin' option is enabled or disabled.
Enable State values.
Specifies if the 'VHD compact disk' option is enabled or disabled.
Enable State values.
FSLogix Cloud Cache General Settings
Specifies if the 'Cache directory' option is enabled or disabled.
Specifies the 'Cache directory'.
Specifies if the 'Write cache directory' option is enabled or disabled.
Specifies the 'Write cache directory'.
Specifies if the 'Proxy directory' option is enabled or disabled.
Specifies the 'Proxy directory'.
Specifies if the 'Silence ACL warning' option is enabled or disabled.
Enable State values.
FSLogix Logging Settings
Log enabled values.
FSLogix log level values.
Specifies the 'Log keeping period in days'. Default: '2'.
Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.
Specifies the 'Robocopy log path'.
Log specific components values.
If true, default app package settings will be inherited.
Application Packages Assigned
List of Application Packages Assigned
Application version
Application version tag name
Application version tag ID
Assigned application package name
If true, default optimization settings will be inherited.
Image Optimization
Whether Optimization is enabled or not
Optimization Type
Image Optimization - Windows Defender ATP
Windows enable options
Disable Real Time Protection
Exclude Folders List
Exclude Processes
Exclude Extensions
Image Optimization - Windows Components
Windows Components List
Details Type
Windows Components Name
Windows Components Display Name
Windows Components Aliases
Whether Windows Defender ATP is enabled or not
Whether Windows Components is enabled or not
Whether Windows Services is enabled or not
Whether Windows Scheduled Task is enabled or not
Whether Windows Advanced Options is enabled or not
Whether Network Performance is enabled or not
Whether Registry is enabled or not
Whether Visual Effects is enabled or not
Whether Disk Cleanup is enabled or not
Whether Custom Script is enabled or not
Image Optimization - Windows Services
Windows Services List
Details Type
Windows Services Name
Windows Services Display Name
Windows Service Aliases
Image Optimization - Windows Advanced Options
Partial Start menu layout
Whether Hibernate is enabled or not
Whether TeleCollection is enabled or not
Whether System Restore is enabled or not
Whether Additional Error Reporting is enabled or not
Whether Tiles is enabled or not
Whether Cortana is enabled or not
Whether Microsoft Consumer Experience is enabled or not
Whether Windows Tips is enabled or not
Whether Common Program Groups is enabled or not
Whether Partial Start Menu is enabled or not
Image Optimization - Network Performance
Directory Cache Value
Dormant File Limit Value
File Not Found Cache Value
File Info Cache Value
Whether File Info Cache is enabled or not
Whether Directory Cache is enabled or not
Whether File Not Found Cache is enabled or not
Whether Dormant File Limit is enabled or not
Whether TCP is disabled or not
Whether Disable IPv6 Components is enabled or not
Whether Disable IPv6 To IPv4 is enabled or not
Whether Disable IsaTap for IPv6 is enabled or not
Image Optimization - Custom Script
Arguments
Command
Initial Directory
User
Image Optimization - Disk Cleanup
Whether Clean up windows SxS Folder is enabled or not
Whether Clean up system files is enabled or not
Whether Clean up temporary file logs is enabled or not
Whether Remove One Drives is enabled or not
Whether Delete User Profiles is enabled or not
Image Optimization - Visual Effects
Visual Effects Type
Whether Animate Control Select Elements is enabled or not
Whether Animate Windows When Minimizing Or Maximizing is enabled or not
Whether Animate Taskbar is enabled or not
Whether Peek is enabled or not
Whether Fade Slide Menus is enabled or not
Whether Fade Slide Tool Tips is enabled or not
Whether Fade Out Menu Items is enabled or not
Whether Taskbar Thumbnail is enabled or not
Whether Shadow Under Mouse is enabled or not
Whether Shadow Under Windows is enabled or not
Whether Thumbnails instead of icons is enabled or not
Whether Translucent Selection is enabled or not
Whether Windows Content Whilst Dragging is enabled or not
Whether Slide open combo boxes is enabled or not
Whether Smooth Edges Screen Fonts is enabled or not
Whether Smooth Scroll List Boxes is enabled or not
Whether Drop Shadow Icon is enabled or not
Image Optimization - Windows Scheduled Tasks A List of Windows Scheduled Task settings
The Windows Scheduled Tasks List
Scheduled Task
Scheduled Task Location
Whether file type is a folder or a task.
Image Optimization - Registries A list of Registries
The Registry List
The Id of the registry
The action type for add registry entry
Registry Name
Value
Display Name
The hive type for add registry entry
Path
The value type for add registry entry
String Value
Image Optimization - UWPApps
All Except List
Following Pkgs List
Remove Type
If true, default Actions settings will be inherited.
Action Settings
Session Action type
Perform Action type
Perform action after (in seconds).
If true, default Printing settings will be inherited.
Host Pool Printer Settings
Printer Name Format
Specifies if 'Remove session number from printer name' option is enabled or disabled.
Specifies if 'Remove client name from printer name' option is enabled or disabled.
If true, default Auto-upgrade settings will be inherited.
Auto-upgrade Settings
Enable auto-upgrade maintenance window
Start Date
Drain mode duration
Force logoff sessions at the end of the drain mode period
Repeat Type
Repeat Specific Days
Messages
ID of the object.
Enabled
Message title
Message
Seconds before message is sent
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.