Set-RASAVDDefaultSettings

NAME

SYNOPSIS

Modifies default settings used to configure Azure Virtual Desktop.

SYNTAX

Set-RASAVDDefaultSettings -DefObjType {AVDMultiSessionDefaultSettings | AVDSingleSessionDefaultSettings} [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AppMonitor <bool>] [-DisconnectActiveSessionAfter <uint>] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-EnableDriveRedirectionCache <bool>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-LogoffDisconnectedSessionAfter <uint>] [-ManageRDPShortpath <bool>] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [-MaxRDPShortpathPort <uint>] [-MinRDPShortpathPort <uint>] [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}] [-PerformActionAfterSec <uint>] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RemoveClientNameFromPrinterName <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-SessionAction {Disconnect | Logoff}] [-SessionReadinessTimeout <uint>] [-SiteId <uint>] [-SupportShellURLNamespaceObjects <bool>] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [-UseRDPShortpath <bool>] [-UseSmallerPortRange <bool>] [<CommonParameters>]

DESCRIPTION

Modifies default settings used to configure Azure Virtual Desktop.

For each setting, the cmdlet has a corresponding input parameter. To modify a setting, specify a matching parameter and its value.

Default settings are defined on a site level and are applied to an Azure Virtual Desktop server when it is initially added to the site.

To retrieve the current defaults settings, use the Get-RASAVDDefaultSettings cmdlet.

PARAMETERS

-SiteId <uint> Site ID for which to modify the default AVD settings.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DefObjType <AVDDefObjType> The Default object type.

Possible values: AVDMultiSessionDefaultSettings, AVDSingleSessionDefaultSettings

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Technology <UserProfileTech> Specifies the 'User Profile Technology' value.

Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer

        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'.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SessionReadinessTimeout <uint> Session readiness timeout (in seconds). Accepted values: 20-3600 seconds.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowRemoteExec <bool> Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AllowURLAndMailRedirection <AllowURLAndMailRedirection> Specifies the 'Allow Client URL/Mail Redirection'.

Possible values: Disabled, Enabled, EnabledWithAppRegistration

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SupportShellURLNamespaceObjects <bool> Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ManageRDPTransportProtocol <ManageRDPTransportProtocol> Manage RDP transport protocol.

Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ManageRDPShortpath <bool> Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-AppMonitor <bool> Specifies if 'Allow Application Monitoring' option is enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-UseRDPShortpath <bool> Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-UseSmallerPortRange <bool> Specifies if 'Use Smaller Port' option is enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MinRDPShortpathPort <uint> The minimum RDP Shortpath Port.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaxRDPShortpathPort <uint> The maximum RDP Shortpath Port.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-DragAndDropMode <DragAndDropModeValue> Specifies the mode the drag and drop feature will operate.

Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-FileTransferMode <FileTransferControlMode> Specifies if File Transfer option is allowed and if yes, which directions are allowed.

Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-FileTransferLocation <string> Location where the File Transfer takes place, if and where it is allowed.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-FileTransferLockLocation <bool> Lock Location where the File Transfer takes place, if and where it is allowed.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-EnableDriveRedirectionCache <bool> Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SessionAction <SessionAction> Session Action

Possible values: Disconnect, Logoff

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PerformAction <PerformAction> Perform Action

Possible values: DoNothing, Shutdown, Suspend, Delete, Restart, Unassign, Recreate

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PerformActionAfterSec <uint> Perform action after (in seconds)

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PrinterNameFormat <PrnNameFormat> Printer Name Format

Possible values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RemoveSessionNumberFromPrinterName <bool> Specifies if 'Remove session number from printer name' option is enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RemoveClientNameFromPrinterName <bool> Specifies if 'Remove client name from printer name' option is enabled or disabled.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Set-RASAVDDefaultSettings -SiteId 1 -DefObjType AVDSingleSessionDefaultSettings -DisconnectActiveSessionAfter 10

Modifies the default value of the DisconnectActiveSessionAfter property for the specified site.

Get-RASAVDDefaultSettings

PreviousSet-RASAutoUpgradeMessage NextSet-RASAVDHostPool

Last updated 12 days ago