Set-RASAVDHostPool
NAME
Set-RASAVDHostPool
SYNOPSIS
Modifies a Azure Virtual Desktop Host Pool.
SYNTAX
Set-RASAVDHostPool [Id] (uint)** [AllowRemoteExec (bool)] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [AppMonitor (bool)] [AutoScaleEnabled (bool)] [-DefaultLicenseType {DoNotConfigure | WindowsClient | WindowsServer}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [Description (string)] [DisconnectActiveSessionAfter (uint)] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [DrainRemains (uint)] [Duration (uint)] [Enabled (bool)] [EnableDriveRedirectionCache (bool)] [EnableSchedule2 (bool)] [EnableZOrder (bool)] [FileTransferLocation (string)] [FileTransferLockLocation (bool)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [FriendlyName (string)] [HostName (string)] [InheritDefaultActionsSettings (bool)] [InheritDefaultAgentSettings (bool)] [InheritDefaultAppPackageSettings (bool)] [InheritDefaultAutoUpgradeSettings (bool)] [InheritDefaultOptimizationSettings (bool)] [InheritDefaultRDPPrinterSettings (bool)] [InheritDefaultUserProfileSettings (bool)] [LimitHosts (uint)] [-LoadBalancerType {BreadthFirst | DepthFirst | Persistent}] [LocalSessionTimeZone (bool)] [LogoffDisconnectedSessionAfter (uint)] [ManageRDPShortpath (bool)] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [MaxHosts (uint)] [MaxRDPShortpathPort (uint)] [MaxServersFromTemplate (uint)] [MinRDPShortpathPort (uint)] [MinServersFromTemplate (uint)] [OverwriteSize (bool)] [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}] [PerformActionAfterSec (uint)] [PowerOnHost (bool)] [PreCreatedHosts (uint)] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [RemoveClientNameFromPrinterName (bool)] [RemoveServersAfterDrainAndPowerOff (bool)] [RemoveSessionNumberFromPrinterName (bool)] [ScheduleAgentUpdates (bool)] [-ScheduleDay1 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}] [-ScheduleDay2 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}] [-ScheduleTime1 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}] [-ScheduleTime2 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}] [ServersToAddPerRequest (uint)] [-SessionAction {Disconnect | Logoff}] [SessionReadinessTimeout (uint)] [SupportShellURLNamespaceObjects (bool)] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [TemplateId (uint)] [TemplateTagId (uint)] [TemplateVersionId (uint)] [TimeZoneId (string)] [UseRDPShortpath (bool)] [UseSmallerPortRange (bool)] [ValidationEnvironment (bool)] [VMSize (string)] [WorkLoadDrain (uint)] [WorkloadThreshold (uint)] [(CommonParameters)]
Set-RASAVDHostPool [-InputObject] (AVDHostPool) [AllowRemoteExec (bool)] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [AppMonitor (bool)] [AutoScaleEnabled (bool)] [-DefaultLicenseType {DoNotConfigure | WindowsClient | WindowsServer}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [Description (string)] [DisconnectActiveSessionAfter (uint)] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [DrainRemains (uint)] [Duration (uint)] [Enabled (bool)] [EnableDriveRedirectionCache (bool)] [EnableSchedule2 (bool)] [EnableZOrder (bool)] [FileTransferLocation (string)] [FileTransferLockLocation (bool)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [FriendlyName (string)] [HostName (string)] [InheritDefaultActionsSettings (bool)] [InheritDefaultAgentSettings (bool)] [InheritDefaultAppPackageSettings (bool)] [InheritDefaultAutoUpgradeSettings (bool)] [InheritDefaultOptimizationSettings (bool)] [InheritDefaultRDPPrinterSettings (bool)] [InheritDefaultUserProfileSettings (bool)] [LimitHosts (uint)] [-LoadBalancerType {BreadthFirst | DepthFirst | Persistent}] [LocalSessionTimeZone (bool)] [LogoffDisconnectedSessionAfter (uint)] [ManageRDPShortpath (bool)] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [MaxHosts (uint)] [MaxRDPShortpathPort (uint)] [MaxServersFromTemplate (uint)] [MinRDPShortpathPort (uint)] [MinServersFromTemplate (uint)] [OverwriteSize (bool)] [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}] [PerformActionAfterSec (uint)] [PowerOnHost (bool)] [PreCreatedHosts (uint)] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [RemoveClientNameFromPrinterName (bool)] [RemoveServersAfterDrainAndPowerOff (bool)] [RemoveSessionNumberFromPrinterName (bool)] [ScheduleAgentUpdates (bool)] [-ScheduleDay1 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}] [-ScheduleDay2 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}] [-ScheduleTime1 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}] [-ScheduleTime2 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}] [ServersToAddPerRequest (uint)] [-SessionAction {Disconnect | Logoff}] [SessionReadinessTimeout (uint)] [SupportShellURLNamespaceObjects (bool)] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [TemplateId (uint)] [TemplateTagId (uint)] [TemplateVersionId (uint)] [TimeZoneId (string)] [UseRDPShortpath (bool)] [UseSmallerPortRange (bool)] [ValidationEnvironment (bool)] [VMSize (string)] [WorkLoadDrain (uint)] [WorkloadThreshold (uint)] [(CommonParameters)]
Set-RASAVDHostPool [Name]** (string) [[-SiteId] (uint)] [AllowRemoteExec (bool)] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [AppMonitor (bool)] [AutoScaleEnabled (bool)] [-DefaultLicenseType {DoNotConfigure | WindowsClient | WindowsServer}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [Description (string)] [DisconnectActiveSessionAfter (uint)] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [DrainRemains (uint)] [Duration (uint)] [Enabled (bool)] [EnableDriveRedirectionCache (bool)] [EnableSchedule2 (bool)] [EnableZOrder (bool)] [FileTransferLocation (string)] [FileTransferLockLocation (bool)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [FriendlyName (string)] [HostName (string)] [InheritDefaultActionsSettings (bool)] [InheritDefaultAgentSettings (bool)] [InheritDefaultAppPackageSettings (bool)] [InheritDefaultAutoUpgradeSettings (bool)] [InheritDefaultOptimizationSettings (bool)] [InheritDefaultRDPPrinterSettings (bool)] [InheritDefaultUserProfileSettings (bool)] [LimitHosts (uint)] [-LoadBalancerType {BreadthFirst | DepthFirst | Persistent}] [LocalSessionTimeZone (bool)] [LogoffDisconnectedSessionAfter (uint)] [ManageRDPShortpath (bool)] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [MaxHosts (uint)] [MaxRDPShortpathPort (uint)] [MaxServersFromTemplate (uint)] [MinRDPShortpathPort (uint)] [MinServersFromTemplate (uint)] [OverwriteSize (bool)] [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}] [PerformActionAfterSec (uint)] [PowerOnHost (bool)] [PreCreatedHosts (uint)] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [RemoveClientNameFromPrinterName (bool)] [RemoveServersAfterDrainAndPowerOff (bool)] [RemoveSessionNumberFromPrinterName (bool)] [ScheduleAgentUpdates (bool)] [-ScheduleDay1 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}] [-ScheduleDay2 {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}] [-ScheduleTime1 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}] [-ScheduleTime2 {h00 | h01 | h02 | h03 | h04 | h05 | h06 | h07 | h08 | h09 | h10 | h11 | h12 | h13 | h14 | h15 | h16 | h17 | h18 | h19 | h20 | h21 | h22 | h23}] [ServersToAddPerRequest (uint)] [-SessionAction {Disconnect | Logoff}] [SessionReadinessTimeout (uint)] [SupportShellURLNamespaceObjects (bool)] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [TemplateId (uint)] [TemplateTagId (uint)] [TemplateVersionId (uint)] [TimeZoneId (string)] [UseRDPShortpath (bool)] [UseSmallerPortRange (bool)] [ValidationEnvironment (bool)] [VMSize (string)] [WorkLoadDrain (uint)] [WorkloadThreshold (uint)] [(CommonParameters)]
DESCRIPTION
Modifies properties of a Azure Virtual Desktop Host Pool.
PARAMETERS
Id (uint)
ID for which to modify the Azure Virtual Desktop Host Pool settings.
Name (string)
The name of the target Azure Virtual Desktop Host Pool settings.
This must be the actual Azure Virtual Desktop Host Pool name used in the RAS farm.
SiteId (uint)
Site ID in which to modify the specified Azure Virtual Desktop Host Pool settings .
If the parameter is omitted, the site ID of the Licensing Server will be used.
InputObject (AVDHostPool)
An AVD Host Pool object (an object of type AVDHostPool) to modify.
An AVDHostPool object representing a host pool is obtained using the Get-RASAVDHostPool cmdlet.
FriendlyName (string)
The new Friendly Name of the Azure Virtual Desktop Host Pool settings.
Description (string)
The new description of the Azure Virtual Desktop Host Pool settings.
Enabled (bool)
Enable or disable the specified AVD Host Pool in a site.
PowerOnHost (bool)
Whether Power On Host is Enabled or not.
ValidationEnvironment (bool)
Whether Validation Environment is Enabled or not.
LimitHosts (uint)
The Limit of session on host.
DefaultLicenseType
(AVDLicenseType) The license type.
Possible values: DoNotConfigure, WindowsClient, WindowsServer
LoadBalancerType
(LoadBalancerType) The Load Balancer Type of the Host Pool
Possible values: BreadthFirst, DepthFirst, Persistent
TemplateId (uint)
The Template ID.
Available to Templated Host Pools
TemplateVersionId (uint)
The Template Version ID.
Available to Templated Host Pools
TemplateTagId (uint)
The Template Tag ID.
Available to Templated Host Pools
Technology (UserProfileTech)
Specifies the 'User Profile Technology' value.
Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer
DisconnectActiveSessionAfter (uint)
Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.
LogoffDisconnectedSessionAfter (uint)
Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.
SessionReadinessTimeout (uint)
Session readiness timeout (in seconds). Accepted values: 20-3600 seconds.
AllowRemoteExec (bool)
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.
AllowURLAndMailRedirection
(AllowURLAndMailRedirection) Specifies the 'Allow Client URL/Mail Redirection'.
Possible values: Disabled, Enabled, EnabledWithAppRegistration
SupportShellURLNamespaceObjects (bool)
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.
ManageRDPTransportProtocol
(ManageRDPTransportProtocol) Manage RDP transport protocol.
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
DragAndDropMode
(DragAndDropModeValue) Specifies the mode the drag and drop feature will operate.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
FileTransferMode
(FileTransferControlMode) Specifies if File Transfer option is allowed and if yes, which directions are allowed.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
FileTransferLocation (string)
Location where the File Transfer takes place, if and where it is allowed.
FileTransferLockLocation (bool)
Lock Location where the File Transfer takes place, if and where it is allowed.
EnableDriveRedirectionCache (bool)
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.
EnableZOrder (bool)
Specifies if the 'Enable Z-Order' option is enabled or disabled. (Experimental)
SessionAction (SessionAction)
Session Action
Possible values: Disconnect, Logoff
PerformAction (PerformAction)
Perform Action
Possible values: DoNothing, Shutdown, Suspend, Delete, Restart, Unassign, Recreate
PerformActionAfterSec (uint)
Perform action after (in seconds)
MaxHosts (uint)
The maximum number of hosts that can be created from the template.
Available to Templated Personal Host Pools
PreCreatedHosts (uint)
The maximum number of pre-created hosts. (Keep available buffer)
Available to Templated Personal Host Pools
Duration (uint)
The duration (in seconds) before the unused hosts are deleted
Available to Templated Personal Host Pools
AutoScaleEnabled (bool)
Whether AutoScale is Enabled or not.
Available to Templated Pooled Host Pools
MinServersFromTemplate (uint)
The Minimum Number of Hosts added to the template.
MaxServersFromTemplate (uint)
The Maximum Number of Hosts added to the template.
WorkloadThreshold (uint)
The Workload Threshold.
ServersToAddPerRequest (uint)
The amount of servers to add per request.
WorkLoadDrain (uint)
The Drain Workload.
DrainRemains (uint)
The Remaining Drain level.
RemoveServersAfterDrainAndPowerOff (bool)
Remove hosts from host pool after drain and power off.
HostName (string)
The Host Name Format. All Host Names must adhere to this format : '{text}-%ID:{number}%'
DefaultPowerState
(DefaultPowerState) The Default Power State
Possible values: PoweredOn, PoweredOff, Suspended
OverwriteSize (bool)
Whether Overwrite Size is Enabled or not.
VMSize (string)
VMSize which will override the size specified in template properties.
Example: Standard_B2s
PrinterNameFormat
(PrnNameFormat) Specifies the 'Printer Name Format' option.
Possible values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES
RemoveSessionNumberFromPrinterName (bool)
Specifies if 'Remove session number from printer name' option is enabled or disabled.
RemoveClientNameFromPrinterName (bool)
Specifies if 'Remove client name from printer name' option is enabled or disabled.
AppMonitor (bool)
Specifies if 'Enable applications monitoring' option is enabled or disabled.
ManageRDPShortpath (bool)
Specifies if 'Allow RDP Shortpath' option is enabled or disabled.
UseRDPShortpath (bool)
Specifies if 'Allow RDP Shortpath' option is enabled or disabled.
UseSmallerPortRange (bool)
Specifies if 'Use Smaller Port' option is enabled or disabled.
MinRDPShortpathPort (uint)
The minimum RDP Shortpath Port.
MaxRDPShortpathPort (uint)
The maximum RDP Shortpath Port.
InheritDefaultAgentSettings (bool)
If true, default AVD Agent settings will be inherited.
InheritDefaultUserProfileSettings (bool)
If true, default User Profile settings will be inherited.
InheritDefaultAppPackageSettings (bool)
If true, default Application Package settings will be inherited.
InheritDefaultOptimizationSettings (bool)
If true, default Optimization settings will be inherited.
InheritDefaultActionsSettings (bool)
If true, default Action settings will be inherited.
InheritDefaultRDPPrinterSettings (bool)
If true, default Printing settings will be inherited.
InheritDefaultAutoUpgradeSettings (bool)
If true, default Auto-upgrade settings will be inherited.
ScheduleAgentUpdates (bool)
Whether to enable schedule agent updates.
LocalSessionTimeZone (bool)
Whether to use the local session time zone or not.
TimeZoneId (string)
The Selected Time Zone Name
ScheduleDay1 (DayOfWeek)
The First Schedule Day
Possible values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
ScheduleTime1 (ScheduleTime)
The First Schedule Time
Possible values: h00, h01, h02, h03, h04, h05, h06, h07, h08, h09, h10, h11, h12, h13, h14, h15, h16, h17, h18, h19, h20, h21, h22, h23
EnableSchedule2 (bool)
Whether to enable a second schedule.
ScheduleDay2 (DayOfWeek)
The Second Schedule Day
Possible values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday
ScheduleTime2 (ScheduleTime)
The Second Schedule Time
Possible values: h00, h01, h02, h03, h04, h05, h06, h07, h08, h09, h10, h11, h12, h13, h14, h15, h16, h17, h18, h19, h20, h21, h22, h23
(CommonParameters)
INPUTS
OUTPUTS
-none-
EXAMPLES
---------- EXAMPLE 1 ----------
Set-RASAVDHostPool -Id 1 -NewName NewHostPool
Modifies the name of the AVD Host Pool with Id 1. ---------- EXAMPLE 2 ----------
Set-RASAVDHostPool -Name "AVDHostPoolName" -NewName NewHostPool
Modifies the name of the AVD Host Pool with Name AVDHostPoolName.
RELATED LINKS
Last updated