VDI Default Settings

Get

Retrieve default settings used to configure a RAS Guest Agent.

GET/api/VDIDefaultSettings

Query parameters

Response

Success

Body

siteIdinteger (int32)

Site ID

generalVDIGeneralSettings (object)

VDI General Settings

userProfileUserProfileSettings (object)

User Profile Settings

appPackagesAssignedAppPackagesAssigned (object)

Application Packages Assigned

optimizationImageOptimization (object)

Image Optimization

actionActionSettings (object)

Action Settings

securityVDISecuritySettings (object)

VDI Security Settings

agentAgentSettings (object)

Host Pool Agent Settings

rdpPrinterRDPPrinterSettings (object)

Host Pool Printer Settings

autoUpgradeAutoUpgradeSettings (object)

Auto-upgrade Settings

Request

Response

Update

Modify default settings used to configure a desktop VM. For each setting, the cmdlet has a corresponding input parameter. To modify a setting, specify a parameter and its value. Default settings are defined on a site level and are applied to a desktop VM when it is initially added to a site.

PUT/api/VDIDefaultSettings

Query parameters

Body

VDI default settings

autoRemovePersIfNotUsedAfterSecnullable integer (int32)

Remove assigned persistent desktop from user if not used (in seconds).

assignmentTypeHostAssignmentType (enum)

Host Assignment Type

1 = User,2 = Device

technologyUserProfileTech (enum)

User Profile Technology values.

0 = DoNotManage,1 = UPD,2 = FSLogix

sessionActionSessionAction (enum)

Session Action type

0 = Disconnect,1 = Logoff

performActionPerformAction (enum)

Perform Action type

0 = DoNothing,2 = Shutdown,4 = Suspend,7 = Delete,8 = Restart,9 = Unassign,10 = Recreate

performActionAfterSecnullable integer (int32)

Perform action after (in seconds).

isUsersGrantedRDPermissionsnullable boolean

Grant users RD permission.

groupTypeUserGroupType (enum)

Group types to allow remote desktop access

1 = Administrators,2 = RemoteDesktopUsers

disconnectActiveSessionAfternullable integer (int32)

Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.

logoffDisconnectedSessionAfternullable integer (int32)

Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.

sessionReadinessTimeoutnullable integer (int32)

Session readiness timeout (in seconds). Accepted values: 20-3600 seconds.

allowURLAndMailRedirectionAllowURLAndMailRedirection (enum)

URL and Mail Redirection values.

0 = Disabled,1 = Enabled,2 = EnabledWithAppRegistration

supportShellURLNamespaceObjectsnullable boolean

Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.

dragAndDropModeDragAndDropModeValue (enum)

Drag and drop redirection values.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowRemoteExecnullable boolean

Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.

manageRDPTransportProtocolManageRDPTransportProtocol (enum)

Manage RDP transport protocol.

0 = Disabled,1 = BothUDPTCP,2 = OnlyTCP,3 = EitherUDPTCP

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

fileTransferLocationnullable string

Location where the File Transfer takes place, if and where it is allowed.

fileTransferLockLocationnullable boolean

Lock Location where the File Transfer takes place, if and where it is allowed.

enableDriveRedirectionCachenullable boolean

Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.

printerNameFormatPrnNameFormat (enum)

Printer Name Format

0 = PrnFormat_PRN_CMP_SES,1 = PrnFormat_SES_CMP_PRN,2 = PrnFormat_PRN_REDSES

removeSessionNumberFromPrinterNamenullable boolean

Enable or disable the 'Remove session number from printer name' option.

removeClientNameFromPrinterNamenullable boolean

Enable or disable the 'Remove client name from printer name' option.

Response

No Content

Request

Response

PreviousWindowsService NextAppPackageAssigned

Last updated 9 months ago

Update

PUT/api/VDIDefaultSettings

{ "siteId": 0, "general": { "assignmentType": [ "1 = User", "2 = Device" ], "autoRemovePersIfNotUsedAfterSec": 0 }, "userProfile": { "technology": [ "0 = DoNotManage", "1 = UPD", "2 = FSLogix" ], "fsLogix": { "profileContainer": { "enabled": false, "locationType": [ "0 = SMBLocation", "1 = CloudCache" ], "vhdLocations": [ "text" ], "ccdLocations": [ "text" ], "profileDiskFormat": [ "0 = VHD", "1 = VHDX" ], "allocationType": [ "0 = Dynamic", "1 = Full" ], "defaultSize": 0, "userInclusionList": [ { "account": "text", "type": [ "1 = User", "2 = Group", "3 = ForeignSecurityPrincipal", "4 = Computer" ], "sid": "text" } ], "userExclusionList": [ { "account": "text", "type": [ "1 = User", "2 = Group", "3 = ForeignSecurityPrincipal", "4 = Computer" ], "sid": "text" } ], "cloudCache": { "useMaxCacheSizeInMBs": false, "maxCacheSizeInMBs": 0, "useClearCacheOnLogoff": false, "clearCacheOnLogoff": [ "0 = Disable", "1 = Enable" ], "useHealthyProvidersRequiredForRegister": false, "healthyProvidersRequiredForRegister": 0, "useHealthyProvidersRequiredForUnregister": false, "healthyProvidersRequiredForUnregister": 0, "useUnregisterTimeout": false, "unregisterTimeout": 0, "useClearCacheOnForcedUnregister": false, "clearCacheOnForcedUnregister": [ "0 = Disable", "1 = Enable" ] }, "customizeProfileFolders": false, "excludeCommonFolders": [ "1 = Contacts", "2 = Desktop", "4 = Documents", "8 = Links", "16 = MusicPodcasts", "32 = PicturesVideos", "64 = FoldersLowIntegProcesses", "128 = Downloads" ], "folderInclusionList": [ "text" ], "folderExclusionList": [ { "folder": "text", "excludeFolderCopy": [ "0 = None", "1 = CopyBase", "2 = CopyBack" ] } ], "advancedSettings": { "useLockedRetryCount": false, "lockedRetryCount": 0, "useLockedRetryInterval": false, "lockedRetryInterval": 0, "useAccessNetworkAsComputerObject": false, "accessNetworkAsComputerObject": [ "0 = Disable", "1 = Enable" ], "useAttachVHDSDDL": false, "attachVHDSDDL": "text", "useDiffDiskParentFolderPath": false, "diffDiskParentFolderPath": "text", "useFlipFlopProfileDirectoryName": false, "flipFlopProfileDirectoryName": [ "0 = Disable", "1 = Enable" ], "useNoProfileContainingFolder": false, "noProfileContainingFolder": [ "0 = Disable", "1 = Enable" ], "useOutlookCachedMode": false, "outlookCachedMode": [ "0 = Disable", "1 = Enable" ], "usePreventLoginWithFailure": false, "preventLoginWithFailure": [ "0 = Disable", "1 = Enable" ], "usePreventLoginWithTempProfile": false, "preventLoginWithTempProfile": [ "0 = Disable", "1 = Enable" ], "useReAttachRetryCount": false, "reAttachRetryCount": 0, "useReAttachIntervalSeconds": false, "reAttachIntervalSeconds": 0, "useRemoveOrphanedOSTFilesOnLogoff": false, "removeOrphanedOSTFilesOnLogoff": [ "0 = Disable", "1 = Enable" ], "useRoamSearch": false, "roamSearch": [ "0 = Disable", "1 = SingleUser", "2 = MultiUser" ], "useSIDDirNameMatch": false, "sidDirNameMatch": "text", "useSIDDirNamePattern": false, "sidDirNamePattern": "text", "useSIDDirSDDL": false, "sidDirSDDL": "text", "useVHDNameMatch": false, "vhdNameMatch": "text", "useVHDNamePattern": false, "vhdNamePattern": "text", "useVHDXSectorSize": false, "vhdxSectorSize": [ "0 = SystemDefault", "512 = Size_512", "4096 = Size_4096" ], "useVolumeWaitTimeMS": false, "volumeWaitTimeMS": 0, "useIgnoreNonAVD": false, "ignoreNonAVD": [ "0 = AnySession", "1 = AVDSessions" ], "useRedirectType": false, "redirectType": [ "1 = Legacy", "2 = Advanced" ], "useKeepLocalDir": false, "keepLocalDir": [ "0 = Disable", "1 = Enable" ], "useDeleteLocalProfileWhenVHDShouldApply": false, "deleteLocalProfileWhenVHDShouldApply": [ "0 = Disable", "1 = Enable" ], "useProfileDirSDDL": false, "profileDirSDDL": "text", "useProfileType": false, "profileType": [ "0 = NormalProfile", "1 = OnlyRWProfile", "2 = OnlyROProfile", "3 = RWROProfile" ], "useSetTempToLocalPath": false, "setTempToLocalPath": [ "0 = TakeNoAction", "1 = RedirectTempAndTmp", "2 = RedirectINetCache", "3 = RedirectTempTmpAndINetCache" ], "useCleanOutNotifications": false, "cleanOutNotifications": [ "0 = Disable", "1 = Enable" ], "useInstallAppxPackages": false, "installAppxPackages": [ "0 = Disable", "1 = Enable" ], "useRebootOnUserLogoff": false, "rebootOnUserLogoff": [ "0 = Disable", "1 = Enable" ], "useRoamIdentity": false, "roamIdentity": [ "0 = Disable", "1 = Enable" ], "useShutdownOnUserLogoff": false, "shutdownOnUserLogoff": [ "0 = Disable", "1 = Enable" ] } }, "officeContainer": { "enabled": false, "locationType": [ "0 = SMBLocation", "1 = CloudCache" ], "vhdLocations": [ "text" ], "ccdLocations": [ "text" ], "profileDiskFormat": [ "0 = VHD", "1 = VHDX" ], "allocationType": [ "0 = Dynamic", "1 = Full" ], "defaultSize": 0, "userInclusionList": [ { "account": "text", "type": [ "1 = User", "2 = Group", "3 = ForeignSecurityPrincipal", "4 = Computer" ], "sid": "text" } ], "userExclusionList": [ { "account": "text", "type": [ "1 = User", "2 = Group", "3 = ForeignSecurityPrincipal", "4 = Computer" ], "sid": "text" } ], "cloudCache": { "useMaxCacheSizeInMBs": false, "maxCacheSizeInMBs": 0, "useClearCacheOnLogoff": false, "clearCacheOnLogoff": [ "0 = Disable", "1 = Enable" ], "useHealthyProvidersRequiredForRegister": false, "healthyProvidersRequiredForRegister": 0, "useHealthyProvidersRequiredForUnregister": false, "healthyProvidersRequiredForUnregister": 0, "useUnregisterTimeout": false, "unregisterTimeout": 0, "useClearCacheOnForcedUnregister": false, "clearCacheOnForcedUnregister": [ "0 = Disable", "1 = Enable" ] }, "advancedSettings": { "useLockedRetryCount": false, "lockedRetryCount": 0, "useLockedRetryInterval": false, "lockedRetryInterval": 0, "useAccessNetworkAsComputerObject": false, "accessNetworkAsComputerObject": [ "0 = Disable", "1 = Enable" ], "useAttachVHDSDDL": false, "attachVHDSDDL": "text", "useDiffDiskParentFolderPath": false, "diffDiskParentFolderPath": "text", "useFlipFlopProfileDirectoryName": false, "flipFlopProfileDirectoryName": [ "0 = Disable", "1 = Enable" ], "useNoProfileContainingFolder": false, "noProfileContainingFolder": [ "0 = Disable", "1 = Enable" ], "useOutlookCachedMode": false, "outlookCachedMode": [ "0 = Disable", "1 = Enable" ], "usePreventLoginWithFailure": false, "preventLoginWithFailure": [ "0 = Disable", "1 = Enable" ], "usePreventLoginWithTempProfile": false, "preventLoginWithTempProfile": [ "0 = Disable", "1 = Enable" ], "useReAttachRetryCount": false, "reAttachRetryCount": 0, "useReAttachIntervalSeconds": false, "reAttachIntervalSeconds": 0, "useRemoveOrphanedOSTFilesOnLogoff": false, "removeOrphanedOSTFilesOnLogoff": [ "0 = Disable", "1 = Enable" ], "useRoamSearch": false, "roamSearch": [ "0 = Disable", "1 = SingleUser", "2 = MultiUser" ], "useSIDDirNameMatch": false, "sidDirNameMatch": "text", "useSIDDirNamePattern": false, "sidDirNamePattern": "text", "useSIDDirSDDL": false, "sidDirSDDL": "text", "useVHDNameMatch": false, "vhdNameMatch": "text", "useVHDNamePattern": false, "vhdNamePattern": "text", "useVHDXSectorSize": false, "vhdxSectorSize": [ "0 = SystemDefault", "512 = Size_512", "4096 = Size_4096" ], "useVolumeWaitTimeMS": false, "volumeWaitTimeMS": 0, "useIgnoreNonAVD": false, "ignoreNonAVD": [ "0 = AnySession", "1 = AVDSessions" ], "useRedirectType": false, "redirectType": [ "1 = Legacy", "2 = Advanced" ], "useIncludeOfficeActivation": false, "includeOfficeActivation": [ "0 = Disable", "1 = Enable" ], "useIncludeOneDrive": false, "includeOneDrive": [ "0 = Disable", "1 = Enable" ], "useIncludeOneNote": false, "includeOneNote": [ "0 = Disable", "1 = Enable" ], "useIncludeOneNoteUWP": false, "includeOneNoteUWP": [ "0 = Disable", "1 = Enable" ], "useIncludeOutlook": false, "includeOutlook": [ "0 = Disable", "1 = Enable" ], "useIncludeOutlookPersonalization": false, "includeOutlookPersonalization": [ "0 = Disable", "1 = Enable" ], "useIncludeSharepoint": false, "includeSharepoint": [ "0 = Disable", "1 = Enable" ], "useIncludeSkype": false, "includeSkype": [ "0 = Disable", "1 = Enable" ], "useIncludeTeams": false, "includeTeams": [ "0 = Disable", "1 = Enable" ], "useMirrorLocalOSTToVHD": false, "mirrorLocalOSTToVHD": [ "0 = DoNothing", "1 = Copy", "2 = Move" ], "useNumSessionVHDsToKeep": false, "numSessionVHDsToKeep": 0, "useOutlookFolderPath": false, "outlookFolderPath": "text", "useRefreshUserPolicy": false, "refreshUserPolicy": [ "0 = Disable", "1 = Enable" ], "useVHDAccessMode": false, "vhdAccessMode": [ "0 = NormalDirectAccess", "1 = DiffDiskNetwork", "2 = DiffDiskLocal", "3 = UniqueVHDPerSession" ] } }, "generalSettings": { "appServices": { "useCleanupInvalidSessions": false, "cleanupInvalidSessions": [ "0 = Disable", "1 = Enable" ], "useRoamRecycleBin": false, "roamRecycleBin": [ "0 = Disable", "1 = Enable" ], "useVHDCompactDisk": false, "vhdCompactDisk": [ "0 = Disable", "1 = Enable" ] }, "cloudCacheGeneral": { "useCacheDirectory": false, "cacheDirectory": "text", "useWriteCacheDirectory": false, "writeCacheDirectory": "text", "useProxyDirectory": false, "proxyDirectory": "text", "useSilenceACLWarning": false, "silenceACLWarning": [ "0 = Disable", "1 = Enable" ] }, "logging": { "logEnabled": [ "0 = Disable", "1 = Specific", "2 = All" ], "logLevel": [ "0 = Debug", "1 = Information", "2 = Warning", "3 = Error" ], "logFileKeepingPeriod": 0, "logDirectory": "text", "robocopyLogPath": "text", "logSpecificComponents": [ "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" ] } } } }, "appPackagesAssigned": { "applicationPackagesAssigned": [ { "version": "text", "tagName": "text", "tagId": 0, "packageName": "text" } ] }, "optimization": { "enableOptimization": false, "optimizationType": [ "0 = Automatic", "1 = Manual" ], "windowsDefenderATP": { "winDefATPTurnOffOn": [ "0 = TurnOffWindowsDefenderATP", "1 = TurnOnWindowsDefenderATP" ], "disableRealTimeProtection": false, "excludeFolders": [ "text" ], "excludeProcesses": [ "text" ], "excludeExtension": [ "text" ] }, "windowsComponents": { "windowsComponentsList": [ { "type": [ "0 = Predefined", "1 = Custom" ], "componentName": "text", "displayName": "text", "aliases": "text" } ] }, "windowsDefenderATPEnabled": false, "windowsComponentsEnabled": false, "windowsServicesEnabled": false, "windowsScheduledTasksEnabled": false, "windowsAdvancedOptionsEnabled": false, "networkPerformanceEnabled": false, "registryEnabled": false, "visualEffectsEnabled": false, "diskCleanupEnabled": false, "customScriptEnabled": false, "windowsServices": { "windowsServicesList": [ { "type": [ "0 = Predefined", "1 = Custom" ], "serviceName": "text", "displayName": "text", "aliases": "text" } ] }, "windowsAdvancedOptions": { "partialStartLayoutContent": "text", "hibernate": false, "teleCollection": false, "systemRestore": false, "additionalErrorReport": false, "tiles": false, "cortana": false, "microsoftConsumerExperience": false, "windowsTips": false, "commonProgramGroups": false, "partialStartMenu": false }, "networkPerformance": { "dirCacheMax": 0, "dormantFileLimit": 0, "fileNotFoundCache": 0, "fileInfoCache": 0, "fileInfoCacheEnable": false, "directoryCacheEnable": false, "fileNotFoundCacheEnable": false, "dormantFileLimitEnable": false, "disableTCP": false, "disableIPv6CompEnable": false, "disableIPv6ToIPv4": false, "disableIsaTap": false }, "customScript": { "arguments": "text", "command": "text", "initDir": "text", "user": "text" }, "diskCleanup": { "cleanupWinSxSFolder": false, "cleanupSystemFiles": false, "cleanupTemporaryFileLogs": false, "removeOneDrive": false, "deleteUserProfiles": false }, "visualEffects": { "visualEffectsTypes": [ "0 = LetWindowsChooseWhatsBest", "1 = AdjustForBestAppearance", "2 = AdjustForBestPerformance", "3 = Custom" ], "animateControlSelectElements": false, "animateWindowsWhenMinimizingMaximizing": false, "animateTaskbar": false, "enablePeek": false, "fadeSlideMenus": false, "fadeSlideToolTips": false, "fadeOutMenuItems": false, "saveTaskbarThumbnail": false, "showShadowUnderMouse": false, "shadowUnderWindows": false, "thumbnailsInsteadOfIcons": false, "showTranslucentSelection": false, "showWindowsContentWhilstDragging": false, "slideOpenComboBoxes": false, "smoothEdgesScreenFonts": false, "smoothScrollListBoxes": false, "dropShadowsIcon": false }, "windowsScheduledTasks": { "windowsScheduledTasksList": [ { "task": "text", "location": "text", "type": [ "0 = Folder", "1 = Task" ] } ] }, "registry": { "registryList": [ { "id": 0, "action": [ "0 = Add", "1 = Modify", "2 = Delete" ], "registryName": "text", "dwordValue": 0, "displayName": "text", "hiveType": [ "0 = HKEY_CURRENT_CONFIG", "1 = HKEY_USERS", "2 = HKEY_LOCAL_MACHINE", "3 = HKEY_CLASSES_ROOT" ], "path": "text", "regType": [ "0 = REG_SZ", "1 = REG_DWORD", "2 = REG_QWORD", "3 = REG_MULTI_SZ", "4 = REG_EXPAND_SZ" ], "stringValue": "text" } ] }, "uwpApps": { "allExcept": [ "text" ], "followingPkgs": [ "text" ], "removeType": [ "0 = AllExcept", "1 = FollowingPkgs" ] } }, "action": { "sessionAction": [ "0 = Disconnect", "1 = Logoff" ], "performAction": [ "0 = DoNothing", "2 = Shutdown", "4 = Suspend", "7 = Delete", "8 = Restart", "9 = Unassign", "10 = Recreate" ], "performActionAfterSec": 0 }, "security": { "isUsersGrantedRDPermissions": false, "groupType": [ "1 = Administrators", "2 = RemoteDesktopUsers" ] }, "agent": { "disconnectActiveSessionAfter": 0, "logoffDisconnectedSessionAfter": 0, "sessionReadinessTimeout": 0, "allowURLAndMailRedirection": [ "0 = Disabled", "1 = Enabled", "2 = EnabledWithAppRegistration" ], "supportShellURLNamespaceObjects": false, "dragAndDropMode": [ "0 = Disabled", "1 = ClientToServer", "2 = ServerToClient", "3 = Bidirectional" ], "allowRemoteExec": false, "manageRDPTransportProtocol": [ "0 = Disabled", "1 = BothUDPTCP", "2 = OnlyTCP", "3 = EitherUDPTCP" ], "fileTransferMode": [ "0 = Disabled", "1 = ClientToServer", "2 = ServerToClient", "3 = Bidirectional" ], "fileTransferLocation": "text", "fileTransferLockLocation": false, "enableDriveRedirectionCache": false }, "rdpPrinter": { "printerNameFormat": [ "0 = PrnFormat_PRN_CMP_SES", "1 = PrnFormat_SES_CMP_PRN", "2 = PrnFormat_PRN_REDSES" ], "removeSessionNumberFromPrinterName": false, "removeClientNameFromPrinterName": false }, "autoUpgrade": { "enabled": false, "startDateTime": "2024-12-21T14:12:16.274Z", "drainModeDurationInSecs": 0, "forceLogoffSessions": false, "repeat": [ "0 = Never", "1 = EveryDay", "2 = EveryWeek", "3 = Every2Weeks", "4 = EveryMonth", "5 = EveryYear", "6 = SpecificDays" ], "specificDays": [ "0 = Never", "1 = Sunday", "2 = Monday", "4 = Tuesday", "8 = Wednesday", "16 = Thursday", "32 = Friday", "64 = Saturday" ], "messages": [ { "id": 0, "enabled": false, "messageTitle": "text", "message": "text", "sendMsgSecs": 0, "sendMsgWhen": [ "0 = Before", "1 = After" ] } ] } }