Modifies properties of a Azure Virtual Desktop Host Pool.
This is an Experimental feature which is subject to slight changes.
PARAMETERS
-Id <uint>
ID for which to modify the Azure Virtual Desktop Host Pool settings.
Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-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.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-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.
Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-NewName <string>
The new name of the Azure Virtual Desktop Host Pool settings.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <string>
The new description of the Azure Virtual Desktop Host Pool settings.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Enabled <bool>
Enable or disable the specified AVD Host Pool in a site.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PowerOnHost <bool>
Whether Power On Host is Enabled or not.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ValidationEnvironment <bool>
Whether Validation Environment is Enabled or not.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LimitHosts <uint>
The Limit of session on host.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DisconnectActiveSessionAfter <uint>
Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-LogoffDisconnectedSessionAfter <uint>
Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters .
INPUTS
OUTPUTS
-none-
EXAMPLES
---------- EXAMPLE 1 ----------
Set-RASAVDHostPool -NewName NewHostPool
Modifies the name of the Azure Virtual Desktop Host Pool.
-InputObject <>
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.
-DefaultLicenseType <>
The license type.
Possible values: DoNotConfigure, WindowsClient, WindowsServer
-LoadBalancerType <>
The Load Balancer Type of the Host Pool
Possible values: BreadthFirst, DepthFirst, Persistent
-Technology <>
Specifies the 'User Profile Technology' value.
Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer
-AllowURLAndMailRedirection <>
Specifies the 'Allow Client URL/Mail Redirection'.
Possible values: Disabled, Enabled, EnabledWithAppRegistration
-ManageRDPTransportProtocol <>
Manage RDP transport protocol.
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
-DragAndDropMode <>
Specifies the mode the drag and drop feature will operate.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
-FileTransferMode <>
Specifies if File Transfer option is allowed and if yes, which directions are allowed.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
-SessionAction <>
Session Action
Possible values: Disconnect, Logoff
