Members

List

Retrieve the list of RD Session Host servers which are members of the specified group.

GET/api/RDS/HostPool/{hostPoolId}/Members

Path parameters

hostPoolId*integer (int32)

ID of the RD Session Host Pool of which members information will be retrieved

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

servernullable string

Server name.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

directAddressnullable string

The direct address of the target RD Session Host server.

rasTemplateIdinteger (int32)

The RDSH RAS Template ID.

inheritDefaultAgentSettingsboolean

If true, default agent settings will be inherited.

inheritDefaultPrinterSettingsboolean

If true, default printer settings will be inherited.

inheritDefaultUserProfileSettingsboolean

If true, default User Profile settings will be inherited.

inheritDefaultDesktopAccessSettingsboolean

If true, default desktop access settings will be inherited.

inheritDefaultOptimizationSettingsnullable boolean

If true, default optimization settings will be inherited.

inheritDefaultAppPackageSettingsboolean

If true, default app package settings will be inherited.

portinteger (int32)

The port number of RD Session Host agent.

maxSessionsinteger (int32)

Maximum number of session a RDS Host can have.

disconnectActiveSessionAfterinteger (int32)

Disconnect active session after (in seconds). 0 - Never.

logoffDisconnectedSessionAfterinteger (int32)

Logoff disconnected session after (in seconds). 0 - Never; 1 - Immediate.

allowURLAndMailRedirectionAllowURLAndMailRedirection (enum)

URL and Mail Redirection values.

0 = Disabled,1 = Enabled,2 = EnabledWithAppRegistration

supportShellURLNamespaceObjectsboolean

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

allowRemoteExecboolean

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

enableAppMonitoringboolean

Specifies if 'Application Monitoring' option is enabled or disabled.

useRemoteAppsboolean

Specifies if 'Use RemoteApps if available' option is enables or disabled.

allowFileTransferboolean

Specifies if 'Allow file transfer' option is enables or disabled. (deprecated)

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.

fileTransferLockLocationboolean

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

allowDragAndDropboolean

Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated)

dragAndDropModeDragAndDropModeValue (enum)

Drag and drop redirection values.

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

preferredBrokerIdinteger (int32)

The preferred Connection broker ID.

enableDriveRedirectionCacheboolean

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

manageRDPTransportProtocolManageRDPTransportProtocol (enum)

Manage RDP transport protocol.

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

enablePrintingboolean

Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.

enableTWAINboolean

Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.

enableWIAboolean

Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.

printerNameFormatPrnNameFormat (enum)

Printer Name Format

0 = PrnFormat_PRN_CMP_SES,1 = PrnFormat_SES_CMP_PRN,2 = PrnFormat_PRN_REDSES

removeClientNameFromPrinterNameboolean

Specifies if 'Remove client name from printer name' option is enabled or disabled.

removeSessionNumberFromPrinterNameboolean

Specifies if 'Remove session number from printer name' option is enabled or disabled.

technologyUserProfileTech (enum)

User Profile Technology values.

0 = DoNotManage,1 = UPD,2 = FSLogix

fsLogixFSLogixSettings (object)

FXLogix Settings

profileContainerProfileContainerSettings (object)

FSLogix Profile Container Settings

enabledboolean

Specifies if the Container is enabled or disabled.

locationTypeLocationType (enum)

Location Type values.

0 = SMBLocation,1 = CloudCache

vhdLocationsnullable array of string

Specifies the 'VHD Locations'.

itemsstring

ccdLocationsnullable array of string

Specifies the 'CCDLocations'.

itemsstring

profileDiskFormatProfileDiskFormat (enum)

Profile Disk Format values.

0 = VHD,1 = VHDX

allocationTypeAllocationType (enum)

Allocation Type values.

0 = Dynamic,1 = Full

defaultSizeinteger (int32)

Specifies the 'Default size'.

userInclusionListnullable array of UserFilter (object)

Specifies the 'User Inclusion List'.

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

userExclusionListnullable array of UserFilter (object)

Specifies the 'User Exclusion List'.

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

cloudCacheCloudCacheSettings (object)

FSLogix Cloud Cache Settings

useMaxCacheSizeInMBsboolean

Specifies if the 'Max cache size in MBs' option is enabled or disabled.

maxCacheSizeInMBsinteger (int32)

Specifies the 'Max cache size in MBs'.

useClearCacheOnLogoffboolean

Specifies if the 'Clear cache on logoff' option is enabled or disabled.

clearCacheOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useHealthyProvidersRequiredForRegisterboolean

Specifies if the 'Healthy providers required for register' option is enabled or disabled.

healthyProvidersRequiredForRegisterinteger (int32)

Specifies the 'Healthy providers required for register'.

useHealthyProvidersRequiredForUnregisterboolean

Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.

healthyProvidersRequiredForUnregisterinteger (int32)

Specifies the 'Healthy providers required for unregister'.

useUnregisterTimeoutboolean

Specifies if the 'Unregister timeout' option is enabled or disabled.

unregisterTimeoutinteger (int32)

Specifies the 'Unregister timeout'.

useClearCacheOnForcedUnregisterboolean

Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.

clearCacheOnForcedUnregisterEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

customizeProfileFoldersboolean

Specifies whether the 'Customize Profile Folders' is enabled or disabled.

excludeCommonFoldersExcludeCommonFolders (enum)

Exclude Common Folders.

1 = Contacts,2 = Desktop,4 = Documents,8 = Links,16 = MusicPodcasts,32 = PicturesVideos,64 = FoldersLowIntegProcesses,128 = Downloads

folderInclusionListnullable array of string

Specifies the 'Folder Inclusion List'.

itemsstring

folderExclusionListnullable array of FolderExclusion (object)

Specifies the 'Folder Exclusion List'.

foldernullable string

Specifies the 'Folder' path.

excludeFolderCopyExcludeFolderCopy (enum)

Exclude Folder Copy values.

0 = None,1 = CopyBase,2 = CopyBack

advancedSettingsProfileContainerAdvancedSettings (object)

FSLogix Profile Container Advanced Settings

useLockedRetryCountboolean

Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.

lockedRetryCountinteger (int32)

Specifies the 'Number of locked VHD(X) retries'.

useLockedRetryIntervalboolean

Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.

lockedRetryIntervalinteger (int32)

Specifies the 'Delay between locked VHD(X) retries'.

useAccessNetworkAsComputerObjectboolean

Specifies if the 'Access network as computer object' option is enabled or disabled.

accessNetworkAsComputerObjectEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useAttachVHDSDDLboolean

Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.

attachVHDSDDLnullable string

Specifies the 'SDDL used when attaching the VHD'.

useDiffDiskParentFolderPathboolean

Specifies if the 'Diff disk parent folder path' option is enabled or disabled.

diffDiskParentFolderPathnullable string

Specifies the 'Diff disk parent folder path'.

useFlipFlopProfileDirectoryNameboolean

Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.

flipFlopProfileDirectoryNameEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useNoProfileContainingFolderboolean

Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.

noProfileContainingFolderEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useOutlookCachedModeboolean

Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.

outlookCachedModeEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithFailureboolean

Specifies if the 'Prevent logons with failures' option is enabled or disabled.

preventLoginWithFailureEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithTempProfileboolean

Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.

preventLoginWithTempProfileEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useReAttachRetryCountboolean

Specifies if the 'Re-attach retry limit' option is enabled or disabled.

reAttachRetryCountinteger (int32)

Specifies the 'Re-attach retry limit'.

useReAttachIntervalSecondsboolean

Specifies if the 'Re-attach interval' option is enabled or disabled.

reAttachIntervalSecondsinteger (int32)

Specifies the 'Re-attach interval'.

useRemoveOrphanedOSTFilesOnLogoffboolean

Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.

removeOrphanedOSTFilesOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRoamSearchboolean

Specifies if the 'Search roaming feature mode' option is enabled or disabled.

roamSearchRoamSearch (enum)

Roam search values.

0 = Disable,1 = SingleUser,2 = MultiUser

useSIDDirNameMatchboolean

Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.

sidDirNameMatchnullable string

Specifies the 'User-to-Profile matching pattern'.

useSIDDirNamePatternboolean

Specifies if the 'Profile folder naming pattern' option is enabled or disabled.

sidDirNamePatternnullable string

Specifies the 'Profile folder naming pattern'.

useSIDDirSDDLboolean

Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.

sidDirSDDLnullable string

Specifies the 'Use SSDL on creation of SID container folder'.

useVHDNameMatchboolean

Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.

vhdNameMatchnullable string

Specifies the 'Profile VHD(X) file matching pattern'.

useVHDNamePatternboolean

Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.

vhdNamePatternnullable string

Specifies the 'Naming pattern for new VHD(X) files'.

useVHDXSectorSizeboolean

Specifies if the 'VHDX sector size' option is enabled or disabled.

vhdxSectorSizeVHDXSectorSize (enum)

Enable State values.

0 = SystemDefault,512 = Size_512,4096 = Size_4096

useVolumeWaitTimeMSboolean

Specifies if the 'Volume wait time' option is enabled or disabled.

volumeWaitTimeMSinteger (int32)

Specifies the 'Volume wait time'.

useIgnoreNonAVDboolean

Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).

ignoreNonAVDIgnoreNonAVD (enum)

Ignore non-AVD values.

0 = AnySession,1 = AVDSessions

useRedirectTypeboolean

Specifies if the 'Redirect type' option is enabled or disabled.

redirectTypeRedirectType (enum)

Redirect type values.

1 = Legacy,2 = Advanced

useKeepLocalDirboolean

Specifies if the 'Keep local profiles' option is enabled or disabled.

keepLocalDirEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useDeleteLocalProfileWhenVHDShouldApplyboolean

Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.

deleteLocalProfileWhenVHDShouldApplyEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useProfileDirSDDLboolean

Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.

profileDirSDDLnullable string

Specifies the 'Custom SDDL for profile directory'.

useProfileTypeboolean

Specifies if the 'Profile type' option is enabled or disabled.

profileTypeProfileType (enum)

Profile Type values.

0 = NormalProfile,1 = OnlyRWProfile,2 = OnlyROProfile,3 = RWROProfile

useSetTempToLocalPathboolean

Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.

setTempToLocalPathTempFolderRedirectionMode (enum)

Temporary Folder Redirection Mode values.

0 = TakeNoAction,1 = RedirectTempAndTmp,2 = RedirectINetCache,3 = RedirectTempTmpAndINetCache

useCleanOutNotificationsboolean

Specifies if the 'Clean out notifications' option is enabled or disabled.

cleanOutNotificationsEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useInstallAppxPackagesboolean

Specifies if the Install Appx packages' option is enabled or disabled.

installAppxPackagesEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRebootOnUserLogoffboolean

Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.

rebootOnUserLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRoamIdentityboolean

Specifies if the 'Roam identity' option is enabled or disabled.

roamIdentityEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useShutdownOnUserLogoffboolean

Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.

shutdownOnUserLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

officeContainerOfficeContainerSettings (object)

FSLogix Office Container Settings

enabledboolean

Specifies if the Container is enabled or disabled.

locationTypeLocationType (enum)

Location Type values.

0 = SMBLocation,1 = CloudCache

vhdLocationsnullable array of string

Specifies the 'VHD Locations'.

itemsstring

ccdLocationsnullable array of string

Specifies the 'CCDLocations'.

itemsstring

profileDiskFormatProfileDiskFormat (enum)

Profile Disk Format values.

0 = VHD,1 = VHDX

allocationTypeAllocationType (enum)

Allocation Type values.

0 = Dynamic,1 = Full

defaultSizeinteger (int32)

Specifies the 'Default size'.

userInclusionListnullable array of UserFilter (object)

Specifies the 'User Inclusion List'.

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

userExclusionListnullable array of UserFilter (object)

Specifies the 'User Exclusion List'.

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

cloudCacheCloudCacheSettings (object)

FSLogix Cloud Cache Settings

useMaxCacheSizeInMBsboolean

Specifies if the 'Max cache size in MBs' option is enabled or disabled.

maxCacheSizeInMBsinteger (int32)

Specifies the 'Max cache size in MBs'.

useClearCacheOnLogoffboolean

Specifies if the 'Clear cache on logoff' option is enabled or disabled.

clearCacheOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useHealthyProvidersRequiredForRegisterboolean

Specifies if the 'Healthy providers required for register' option is enabled or disabled.

healthyProvidersRequiredForRegisterinteger (int32)

Specifies the 'Healthy providers required for register'.

useHealthyProvidersRequiredForUnregisterboolean

Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.

healthyProvidersRequiredForUnregisterinteger (int32)

Specifies the 'Healthy providers required for unregister'.

useUnregisterTimeoutboolean

Specifies if the 'Unregister timeout' option is enabled or disabled.

unregisterTimeoutinteger (int32)

Specifies the 'Unregister timeout'.

useClearCacheOnForcedUnregisterboolean

Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.

clearCacheOnForcedUnregisterEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

advancedSettingsOfficeContainerAdvancedSettings (object)

FSLogix Office Container Advanced Settings

useLockedRetryCountboolean

Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.

lockedRetryCountinteger (int32)

Specifies the 'Number of locked VHD(X) retries'.

useLockedRetryIntervalboolean

Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.

lockedRetryIntervalinteger (int32)

Specifies the 'Delay between locked VHD(X) retries'.

useAccessNetworkAsComputerObjectboolean

Specifies if the 'Access network as computer object' option is enabled or disabled.

accessNetworkAsComputerObjectEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useAttachVHDSDDLboolean

Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.

attachVHDSDDLnullable string

Specifies the 'SDDL used when attaching the VHD'.

useDiffDiskParentFolderPathboolean

Specifies if the 'Diff disk parent folder path' option is enabled or disabled.

diffDiskParentFolderPathnullable string

Specifies the 'Diff disk parent folder path'.

useFlipFlopProfileDirectoryNameboolean

Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.

flipFlopProfileDirectoryNameEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useNoProfileContainingFolderboolean

Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.

noProfileContainingFolderEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useOutlookCachedModeboolean

Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.

outlookCachedModeEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithFailureboolean

Specifies if the 'Prevent logons with failures' option is enabled or disabled.

preventLoginWithFailureEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithTempProfileboolean

Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.

preventLoginWithTempProfileEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useReAttachRetryCountboolean

Specifies if the 'Re-attach retry limit' option is enabled or disabled.

reAttachRetryCountinteger (int32)

Specifies the 'Re-attach retry limit'.

useReAttachIntervalSecondsboolean

Specifies if the 'Re-attach interval' option is enabled or disabled.

reAttachIntervalSecondsinteger (int32)

Specifies the 'Re-attach interval'.

useRemoveOrphanedOSTFilesOnLogoffboolean

Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.

removeOrphanedOSTFilesOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRoamSearchboolean

Specifies if the 'Search roaming feature mode' option is enabled or disabled.

roamSearchRoamSearch (enum)

Roam search values.

0 = Disable,1 = SingleUser,2 = MultiUser

useSIDDirNameMatchboolean

Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.

sidDirNameMatchnullable string

Specifies the 'User-to-Profile matching pattern'.

useSIDDirNamePatternboolean

Specifies if the 'Profile folder naming pattern' option is enabled or disabled.

sidDirNamePatternnullable string

Specifies the 'Profile folder naming pattern'.

useSIDDirSDDLboolean

Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.

sidDirSDDLnullable string

Specifies the 'Use SSDL on creation of SID container folder'.

useVHDNameMatchboolean

Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.

vhdNameMatchnullable string

Specifies the 'Profile VHD(X) file matching pattern'.

useVHDNamePatternboolean

Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.

vhdNamePatternnullable string

Specifies the 'Naming pattern for new VHD(X) files'.

useVHDXSectorSizeboolean

Specifies if the 'VHDX sector size' option is enabled or disabled.

vhdxSectorSizeVHDXSectorSize (enum)

Enable State values.

0 = SystemDefault,512 = Size_512,4096 = Size_4096

useVolumeWaitTimeMSboolean

Specifies if the 'Volume wait time' option is enabled or disabled.

volumeWaitTimeMSinteger (int32)

Specifies the 'Volume wait time'.

useIgnoreNonAVDboolean

Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).

ignoreNonAVDIgnoreNonAVD (enum)

Ignore non-AVD values.

0 = AnySession,1 = AVDSessions

useRedirectTypeboolean

Specifies if the 'Redirect type' option is enabled or disabled.

redirectTypeRedirectType (enum)

Redirect type values.

1 = Legacy,2 = Advanced

useIncludeOfficeActivationboolean

Specifies if the 'Include Office Activation' option is enabled or disabled.

includeOfficeActivationEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOneDriveboolean

Specifies if the 'Include OneDrive' option is enabled or disabled.

includeOneDriveEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOneNoteboolean

Specifies if the 'Include OneNote' option is enabled or disabled.

includeOneNoteEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOneNoteUWPboolean

Specifies if the 'Include OneNote UWP' option is enabled or disabled.

includeOneNoteUWPEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOutlookboolean

Specifies if the 'Include Outlook' option is enabled or disabled.

includeOutlookEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOutlookPersonalizationboolean

Specifies if the 'Include Outlook Personalization' option is enabled or disabled.

includeOutlookPersonalizationEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeSharepointboolean

Specifies if the 'Include Sharepoint' option is enabled or disabled.

includeSharepointEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeSkypeboolean

Specifies if the 'Include Skype' option is enabled or disabled.

includeSkypeEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeTeamsboolean

Specifies if the 'Include Teams' option is enabled or disabled.

includeTeamsEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useMirrorLocalOSTToVHDboolean

Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.

mirrorLocalOSTToVHDMirrorLocalOSTToVHD (enum)

Mirror Local OST-VHD values.

0 = DoNothing,1 = Copy,2 = Move

useNumSessionVHDsToKeepboolean

Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.

numSessionVHDsToKeepinteger (int32)

Specifies the 'Number of Session VHDs to Keep'.

useOutlookFolderPathboolean

Specifies if the 'Outlook Folder Path' option is enabled or disabled.

outlookFolderPathnullable string

Specifies the 'Outlook Folder Path'.

useRefreshUserPolicyboolean

Specifies if the 'Refresh User Policy' option is enabled or disabled.

refreshUserPolicyEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useVHDAccessModeboolean

Specifies if the 'VHD Access Mode' option is enabled or disabled.

vhdAccessModeVHDAccessMode (enum)

VHD Access Mode values.

0 = NormalDirectAccess,1 = DiffDiskNetwork,2 = DiffDiskLocal,3 = UniqueVHDPerSession

generalSettingsFSLogixGeneralSettings (object)

FSLogix General Settings

appServicesAppServicesSettings (object)

FSLogix App Services Settings

useCleanupInvalidSessionsboolean

Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.

cleanupInvalidSessionsEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRoamRecycleBinboolean

Specifies if the 'Roam recycle bin' option is enabled or disabled.

roamRecycleBinEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useVHDCompactDiskboolean

Specifies if the 'VHD compact disk' option is enabled or disabled.

vhdCompactDiskEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

cloudCacheGeneralCloudCacheGeneralSettings (object)

FSLogix Cloud Cache General Settings

useCacheDirectoryboolean

Specifies if the 'Cache directory' option is enabled or disabled.

cacheDirectorynullable string

Specifies the 'Cache directory'.

useWriteCacheDirectoryboolean

Specifies if the 'Write cache directory' option is enabled or disabled.

writeCacheDirectorynullable string

Specifies the 'Write cache directory'.

useProxyDirectoryboolean

Specifies if the 'Proxy directory' option is enabled or disabled.

proxyDirectorynullable string

Specifies the 'Proxy directory'.

useSilenceACLWarningboolean

Specifies if the 'Silence ACL warning' option is enabled or disabled.

silenceACLWarningEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

loggingFSLogixLoggingSettings (object)

FSLogix Logging Settings

logEnabledFSLogixLogEnabled (enum)

Log enabled values.

0 = Disable,1 = Specific,2 = All

logLevelFSLogixLogLevel (enum)

FSLogix log level values.

0 = Debug,1 = Information,2 = Warning,3 = Error

logFileKeepingPeriodinteger (int32)

Specifies the 'Log keeping period in days'. Default: '2'.

logDirectorynullable string

Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.

robocopyLogPathnullable string

Specifies the 'Robocopy log path'.

logSpecificComponentsLogSpecificComponents (enum)

Log specific components values.

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

updModeUPDMode (enum)

User Profile Disk Mode.

0 = DoNotChange,1 = Enabled,2 = Disabled

maxUserProfileDiskSizeGBinteger (int32)

Specifies the max user profile disk size (in GB).

diskPathnullable string

Specifies the User Profile Disk path.

roamingModeUPDRoamingMode (enum)

User Profile Disk Roaming Mode.

0 = Exclude,2 = Include

includeFolderPathnullable array of string

Specifies the UPD 'Include' folder paths.

itemsstring

includeFilePathnullable array of string

Specifies the UPD 'Include' file paths.

itemsstring

excludeFolderPathnullable array of string

Specifies the UPD 'Exclude' folder paths.

itemsstring

excludeFilePathnullable array of string

Specifies the UPD 'Exclude' file paths.

itemsstring

restrictDesktopAccessboolean

Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled.

restrictedUsersnullable array of string

Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.

itemsstring

enableOptimizationboolean

optimizationImageOptimization (object)

Image Optimization

enableOptimizationboolean

Whether Optimization is enabled or not

optimizationTypeOptimizationTypeEnum (enum)

Optimization Type

0 = Automatic,1 = Manual

windowsDefenderATPWindowsDefenderATP (object)

Image Optimization - Windows Defender ATP

winDefATPTurnOffOnWindowsDefenderATPEnable (enum)

Windows enable options

0 = TurnOffWindowsDefenderATP,1 = TurnOnWindowsDefenderATP

disableRealTimeProtectionboolean

Disable Real Time Protection

excludeFoldersnullable array of string

Exclude Folders List

itemsstring

excludeProcessesnullable array of string

Exclude Processes

itemsstring

excludeExtensionnullable array of string

Exclude Extensions

itemsstring

windowsComponentsWindowsComponents (object)

Image Optimization - Windows Components

windowsComponentsListnullable array of WindowsComponent (object)

Windows Components List

typeDetailsType (enum)

Details Type

0 = Predefined,1 = Custom

componentNamenullable string

Windows Components Name

displayNamenullable string

Windows Components Display Name

aliasesnullable string

Windows Components Aliases

windowsDefenderATPEnabledboolean

Whether Windows Defender ATP is enabled or not

windowsComponentsEnabledboolean

Whether Windows Components is enabled or not

windowsServicesEnabledboolean

Whether Windows Services is enabled or not

windowsScheduledTasksEnabledboolean

Whether Windows Scheduled Task is enabled or not

windowsAdvancedOptionsEnabledboolean

Whether Windows Advanced Options is enabled or not

networkPerformanceEnabledboolean

Whether Network Performance is enabled or not

registryEnabledboolean

Whether Registry is enabled or not

visualEffectsEnabledboolean

Whether Visual Effects is enabled or not

diskCleanupEnabledboolean

Whether Disk Cleanup is enabled or not

customScriptEnabledboolean

Whether Custom Script is enabled or not

windowsServicesWindowsServices (object)

Image Optimization - Windows Services

windowsServicesListnullable array of WindowsService (object)

Windows Services List

typeDetailsType (enum)

Details Type

0 = Predefined,1 = Custom

serviceNamenullable string

Windows Services Name

displayNamenullable string

Windows Services Display Name

aliasesnullable string

Windows Service Aliases

windowsAdvancedOptionsWindowsAdvancedOptions (object)

Image Optimization - Windows Advanced Options

partialStartLayoutContentnullable string

Partial Start menu layout

hibernateboolean

Whether Hibernate is enabled or not

teleCollectionboolean

Whether TeleCollection is enabled or not

systemRestoreboolean

Whether System Restore is enabled or not

additionalErrorReportboolean

Whether Additional Error Reporting is enabled or not

tilesboolean

Whether Tiles is enabled or not

cortanaboolean

Whether Cortana is enabled or not

microsoftConsumerExperienceboolean

Whether Microsoft Consumer Experience is enabled or not

windowsTipsboolean

Whether Windows Tips is enabled or not

commonProgramGroupsboolean

Whether Common Program Groups is enabled or not

partialStartMenuboolean

Whether Partial Start Menu is enabled or not

networkPerformanceNetworkPerformance (object)

Image Optimization - Network Performance

dirCacheMaxinteger (int32)

Directory Cache Value

dormantFileLimitinteger (int32)

Dormant File Limit Value

fileNotFoundCacheinteger (int32)

File Not Found Cache Value

fileInfoCacheinteger (int32)

File Info Cache Value

fileInfoCacheEnableboolean

Whether File Info Cache is enabled or not

directoryCacheEnableboolean

Whether Directory Cache is enabled or not

fileNotFoundCacheEnableboolean

Whether File Not Found Cache is enabled or not

dormantFileLimitEnableboolean

Whether Dormant File Limit is enabled or not

disableTCPboolean

Whether TCP is disabled or not

disableIPv6CompEnableboolean

Whether Disable IPv6 Components is enabled or not

disableIPv6ToIPv4boolean

Whether Disable IPv6 To IPv4 is enabled or not

disableIsaTapboolean

Whether Disable IsaTap for IPv6 is enabled or not

customScriptCustomScript (object)

Image Optimization - Custom Script

argumentsnullable string

Arguments

commandnullable string

Command

initDirnullable string

Initial Directory

usernullable string

User

diskCleanupDiskCleanup (object)

Image Optimization - Disk Cleanup

cleanupWinSxSFolderboolean

Whether Clean up windows SxS Folder is enabled or not

cleanupSystemFilesboolean

Whether Clean up system files is enabled or not

cleanupTemporaryFileLogsboolean

Whether Clean up temporary file logs is enabled or not

removeOneDriveboolean

Whether Remove One Drives is enabled or not

deleteUserProfilesboolean

Whether Delete User Profiles is enabled or not

visualEffectsVisualEffects (object)

Image Optimization - Visual Effects

visualEffectsTypesVisualEffectsType (enum)

Visual Effects Type

0 = LetWindowsChooseWhatsBest,1 = AdjustForBestAppearance,2 = AdjustForBestPerformance,3 = Custom

animateControlSelectElementsboolean

Whether Animate Control Select Elements is enabled or not

animateWindowsWhenMinimizingMaximizingboolean

Whether Animate Windows When Minimizing Or Maximizing is enabled or not

animateTaskbarboolean

Whether Animate Taskbar is enabled or not

enablePeekboolean

Whether Peek is enabled or not

fadeSlideMenusboolean

Whether Fade Slide Menus is enabled or not

fadeSlideToolTipsboolean

Whether Fade Slide Tool Tips is enabled or not

fadeOutMenuItemsboolean

Whether Fade Out Menu Items is enabled or not

saveTaskbarThumbnailboolean

Whether Taskbar Thumbnail is enabled or not

showShadowUnderMouseboolean

Whether Shadow Under Mouse is enabled or not

shadowUnderWindowsboolean

Whether Shadow Under Windows is enabled or not

thumbnailsInsteadOfIconsboolean

Whether Thumbnails instead of icons is enabled or not

showTranslucentSelectionboolean

Whether Translucent Selection is enabled or not

showWindowsContentWhilstDraggingboolean

Whether Windows Content Whilst Dragging is enabled or not

slideOpenComboBoxesboolean

Whether Slide open combo boxes is enabled or not

smoothEdgesScreenFontsboolean

Whether Smooth Edges Screen Fonts is enabled or not

smoothScrollListBoxesboolean

Whether Smooth Scroll List Boxes is enabled or not

dropShadowsIconboolean

Whether Drop Shadow Icon is enabled or not

windowsScheduledTasksWindowsScheduledTasks (object)

Image Optimization - Windows Scheduled Tasks A List of Windows Scheduled Task settings

windowsScheduledTasksListnullable array of ImageOptimizationWindowsScheduledTask (object)

The Windows Scheduled Tasks List

tasknullable string

Scheduled Task

locationnullable string

Scheduled Task Location

typeOptimizationFileType (enum)

Whether file type is a folder or a task.

0 = Folder,1 = Task

registryRegistries (object)

Image Optimization - Registries A list of Registries

registryListnullable array of Registry (object)

The Registry List

idinteger (int32)

The Id of the registry

actionActionType (enum)

The action type for add registry entry

0 = Add,1 = Modify,2 = Delete

registryNamenullable string

Registry Name

dwordValueinteger (int32)

Value

displayNamenullable string

Display Name

hiveTypeHiveType (enum)

The hive type for add registry entry

0 = HKEY_CURRENT_CONFIG,1 = HKEY_USERS,2 = HKEY_LOCAL_MACHINE,3 = HKEY_CLASSES_ROOT

pathnullable string

Path

regTypeValueType (enum)

The value type for add registry entry

0 = REG_SZ,1 = REG_DWORD,2 = REG_QWORD,3 = REG_MULTI_SZ,4 = REG_EXPAND_SZ

stringValuenullable string

String Value

uwpAppsUWPApps (object)

Image Optimization - UWPApps

allExceptnullable array of string

All Except List

itemsstring

followingPkgsnullable array of string

Following Pkgs List

itemsstring

removeTypeRemoveType (enum)

Remove Type

0 = AllExcept,1 = FollowingPkgs

appPackagesAssignedAppPackagesAssigned (object)

Application Packages Assigned

applicationPackagesAssignednullable array of AppPackageAssigned (object)

List of Application Packages Assigned

versionnullable string

Application version

tagNamenullable string

Application version tag name

tagIdnullable integer (int32)

Application version tag ID

packageNamenullable string

Assigned application package name

Request

Response

Move

Move a member to a RD Session Host Pool.

PUT/api/RDS/HostPool/{hostPoolId}/Members

Path parameters

hostPoolId*integer (int32)

ID of the member to be added to a RD Session Host Pool

Body

RD Session Host group member configuration

MoveRDSHostPoolMember (object)

Move a member to the RD Session Host Pool

Response

No Content

Request

Response

Delete

Delete a member from a RD Session Host server group. This endpoint is obsolete, use Move Member endpoint instead.

DELETE/api/RDS/HostPool/{groupId}/Members/{rdsid}

Path parameters

groupId*integer (int32)

ID of the member of a RD Session Host server group to be deleted

rdsid*integer (int32)

ID of the RD Session Host server group of which the member will be deleted

Response

No Content

Request

Response

Add

Add a member to a RD Session Host server group. This endpoint is obsolete, use Move Member endpoint instead.

POST/api/RDS/HostPool/{groupId}/Members

Path parameters

groupId*integer (int32)

ID of the member to be added to a RD Session Host server group

Body

RD Session Host group member configuration

rdsIds*nullable array of integer (int32)

The IDs of RD Session Host servers to be added to the specified group.

itemsinteger (int32)

Response

No Content

Request

Response

List

Retrieve the list of RD Session Host servers which are members of the specified group.

GET/api/RDS/HostPool/{hostPoolId}/Members

Path parameters

hostPoolId*integer (int32)

ID of the RD Session Host Pool of which members information will be retrieved

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

servernullable string

Server name.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

directAddressnullable string

The direct address of the target RD Session Host server.

rasTemplateIdinteger (int32)

The RDSH RAS Template ID.

inheritDefaultAgentSettingsboolean

If true, default agent settings will be inherited.

inheritDefaultPrinterSettingsboolean

If true, default printer settings will be inherited.

inheritDefaultUserProfileSettingsboolean

If true, default User Profile settings will be inherited.

inheritDefaultDesktopAccessSettingsboolean

If true, default desktop access settings will be inherited.

inheritDefaultOptimizationSettingsnullable boolean

If true, default optimization settings will be inherited.

inheritDefaultAppPackageSettingsboolean

If true, default app package settings will be inherited.

portinteger (int32)

The port number of RD Session Host agent.

maxSessionsinteger (int32)

Maximum number of session a RDS Host can have.

disconnectActiveSessionAfterinteger (int32)

Disconnect active session after (in seconds). 0 - Never.

logoffDisconnectedSessionAfterinteger (int32)

Logoff disconnected session after (in seconds). 0 - Never; 1 - Immediate.

allowURLAndMailRedirectionAllowURLAndMailRedirection (enum)

URL and Mail Redirection values.

0 = Disabled,1 = Enabled,2 = EnabledWithAppRegistration

supportShellURLNamespaceObjectsboolean

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

allowRemoteExecboolean

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

enableAppMonitoringboolean

Specifies if 'Application Monitoring' option is enabled or disabled.

useRemoteAppsboolean

Specifies if 'Use RemoteApps if available' option is enables or disabled.

allowFileTransferboolean

Specifies if 'Allow file transfer' option is enables or disabled. (deprecated)

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.

fileTransferLockLocationboolean

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

allowDragAndDropboolean

Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated)

dragAndDropModeDragAndDropModeValue (enum)

Drag and drop redirection values.

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

preferredBrokerIdinteger (int32)

The preferred Connection broker ID.

enableDriveRedirectionCacheboolean

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

manageRDPTransportProtocolManageRDPTransportProtocol (enum)

Manage RDP transport protocol.

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

enablePrintingboolean

Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.

enableTWAINboolean

Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.

enableWIAboolean

Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.

printerNameFormatPrnNameFormat (enum)

Printer Name Format

0 = PrnFormat_PRN_CMP_SES,1 = PrnFormat_SES_CMP_PRN,2 = PrnFormat_PRN_REDSES

removeClientNameFromPrinterNameboolean

Specifies if 'Remove client name from printer name' option is enabled or disabled.

removeSessionNumberFromPrinterNameboolean

Specifies if 'Remove session number from printer name' option is enabled or disabled.

technologyUserProfileTech (enum)

User Profile Technology values.

0 = DoNotManage,1 = UPD,2 = FSLogix

fsLogixFSLogixSettings (object)

FXLogix Settings

profileContainerProfileContainerSettings (object)

FSLogix Profile Container Settings

enabledboolean

Specifies if the Container is enabled or disabled.

locationTypeLocationType (enum)

Location Type values.

0 = SMBLocation,1 = CloudCache

vhdLocationsnullable array of string

Specifies the 'VHD Locations'.

itemsstring

ccdLocationsnullable array of string

Specifies the 'CCDLocations'.

itemsstring

profileDiskFormatProfileDiskFormat (enum)

Profile Disk Format values.

0 = VHD,1 = VHDX

allocationTypeAllocationType (enum)

Allocation Type values.

0 = Dynamic,1 = Full

defaultSizeinteger (int32)

Specifies the 'Default size'.

userInclusionListnullable array of UserFilter (object)

Specifies the 'User Inclusion List'.

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

userExclusionListnullable array of UserFilter (object)

Specifies the 'User Exclusion List'.

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

cloudCacheCloudCacheSettings (object)

FSLogix Cloud Cache Settings

useMaxCacheSizeInMBsboolean

Specifies if the 'Max cache size in MBs' option is enabled or disabled.

maxCacheSizeInMBsinteger (int32)

Specifies the 'Max cache size in MBs'.

useClearCacheOnLogoffboolean

Specifies if the 'Clear cache on logoff' option is enabled or disabled.

clearCacheOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useHealthyProvidersRequiredForRegisterboolean

Specifies if the 'Healthy providers required for register' option is enabled or disabled.

healthyProvidersRequiredForRegisterinteger (int32)

Specifies the 'Healthy providers required for register'.

useHealthyProvidersRequiredForUnregisterboolean

Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.

healthyProvidersRequiredForUnregisterinteger (int32)

Specifies the 'Healthy providers required for unregister'.

useUnregisterTimeoutboolean

Specifies if the 'Unregister timeout' option is enabled or disabled.

unregisterTimeoutinteger (int32)

Specifies the 'Unregister timeout'.

useClearCacheOnForcedUnregisterboolean

Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.

clearCacheOnForcedUnregisterEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

customizeProfileFoldersboolean

Specifies whether the 'Customize Profile Folders' is enabled or disabled.

excludeCommonFoldersExcludeCommonFolders (enum)

Exclude Common Folders.

1 = Contacts,2 = Desktop,4 = Documents,8 = Links,16 = MusicPodcasts,32 = PicturesVideos,64 = FoldersLowIntegProcesses,128 = Downloads

folderInclusionListnullable array of string

Specifies the 'Folder Inclusion List'.

itemsstring

folderExclusionListnullable array of FolderExclusion (object)

Specifies the 'Folder Exclusion List'.

foldernullable string

Specifies the 'Folder' path.

excludeFolderCopyExcludeFolderCopy (enum)

Exclude Folder Copy values.

0 = None,1 = CopyBase,2 = CopyBack

advancedSettingsProfileContainerAdvancedSettings (object)

FSLogix Profile Container Advanced Settings

useLockedRetryCountboolean

Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.

lockedRetryCountinteger (int32)

Specifies the 'Number of locked VHD(X) retries'.

useLockedRetryIntervalboolean

Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.

lockedRetryIntervalinteger (int32)

Specifies the 'Delay between locked VHD(X) retries'.

useAccessNetworkAsComputerObjectboolean

Specifies if the 'Access network as computer object' option is enabled or disabled.

accessNetworkAsComputerObjectEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useAttachVHDSDDLboolean

Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.

attachVHDSDDLnullable string

Specifies the 'SDDL used when attaching the VHD'.

useDiffDiskParentFolderPathboolean

Specifies if the 'Diff disk parent folder path' option is enabled or disabled.

diffDiskParentFolderPathnullable string

Specifies the 'Diff disk parent folder path'.

useFlipFlopProfileDirectoryNameboolean

Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.

flipFlopProfileDirectoryNameEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useNoProfileContainingFolderboolean

Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.

noProfileContainingFolderEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useOutlookCachedModeboolean

Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.

outlookCachedModeEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithFailureboolean

Specifies if the 'Prevent logons with failures' option is enabled or disabled.

preventLoginWithFailureEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithTempProfileboolean

Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.

preventLoginWithTempProfileEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useReAttachRetryCountboolean

Specifies if the 'Re-attach retry limit' option is enabled or disabled.

reAttachRetryCountinteger (int32)

Specifies the 'Re-attach retry limit'.

useReAttachIntervalSecondsboolean

Specifies if the 'Re-attach interval' option is enabled or disabled.

reAttachIntervalSecondsinteger (int32)

Specifies the 'Re-attach interval'.

useRemoveOrphanedOSTFilesOnLogoffboolean

Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.

removeOrphanedOSTFilesOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRoamSearchboolean

Specifies if the 'Search roaming feature mode' option is enabled or disabled.

roamSearchRoamSearch (enum)

Roam search values.

0 = Disable,1 = SingleUser,2 = MultiUser

useSIDDirNameMatchboolean

Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.

sidDirNameMatchnullable string

Specifies the 'User-to-Profile matching pattern'.

useSIDDirNamePatternboolean

Specifies if the 'Profile folder naming pattern' option is enabled or disabled.

sidDirNamePatternnullable string

Specifies the 'Profile folder naming pattern'.

useSIDDirSDDLboolean

Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.

sidDirSDDLnullable string

Specifies the 'Use SSDL on creation of SID container folder'.

useVHDNameMatchboolean

Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.

vhdNameMatchnullable string

Specifies the 'Profile VHD(X) file matching pattern'.

useVHDNamePatternboolean

Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.

vhdNamePatternnullable string

Specifies the 'Naming pattern for new VHD(X) files'.

useVHDXSectorSizeboolean

Specifies if the 'VHDX sector size' option is enabled or disabled.

vhdxSectorSizeVHDXSectorSize (enum)

Enable State values.

0 = SystemDefault,512 = Size_512,4096 = Size_4096

useVolumeWaitTimeMSboolean

Specifies if the 'Volume wait time' option is enabled or disabled.

volumeWaitTimeMSinteger (int32)

Specifies the 'Volume wait time'.

useIgnoreNonAVDboolean

Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).

ignoreNonAVDIgnoreNonAVD (enum)

Ignore non-AVD values.

0 = AnySession,1 = AVDSessions

useRedirectTypeboolean

Specifies if the 'Redirect type' option is enabled or disabled.

redirectTypeRedirectType (enum)

Redirect type values.

1 = Legacy,2 = Advanced

useKeepLocalDirboolean

Specifies if the 'Keep local profiles' option is enabled or disabled.

keepLocalDirEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useDeleteLocalProfileWhenVHDShouldApplyboolean

Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.

deleteLocalProfileWhenVHDShouldApplyEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useProfileDirSDDLboolean

Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.

profileDirSDDLnullable string

Specifies the 'Custom SDDL for profile directory'.

useProfileTypeboolean

Specifies if the 'Profile type' option is enabled or disabled.

profileTypeProfileType (enum)

Profile Type values.

0 = NormalProfile,1 = OnlyRWProfile,2 = OnlyROProfile,3 = RWROProfile

useSetTempToLocalPathboolean

Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.

setTempToLocalPathTempFolderRedirectionMode (enum)

Temporary Folder Redirection Mode values.

0 = TakeNoAction,1 = RedirectTempAndTmp,2 = RedirectINetCache,3 = RedirectTempTmpAndINetCache

useCleanOutNotificationsboolean

Specifies if the 'Clean out notifications' option is enabled or disabled.

cleanOutNotificationsEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useInstallAppxPackagesboolean

Specifies if the Install Appx packages' option is enabled or disabled.

installAppxPackagesEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRebootOnUserLogoffboolean

Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.

rebootOnUserLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRoamIdentityboolean

Specifies if the 'Roam identity' option is enabled or disabled.

roamIdentityEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useShutdownOnUserLogoffboolean

Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.

shutdownOnUserLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

officeContainerOfficeContainerSettings (object)

FSLogix Office Container Settings

enabledboolean

Specifies if the Container is enabled or disabled.

locationTypeLocationType (enum)

Location Type values.

0 = SMBLocation,1 = CloudCache

vhdLocationsnullable array of string

Specifies the 'VHD Locations'.

itemsstring

ccdLocationsnullable array of string

Specifies the 'CCDLocations'.

itemsstring

profileDiskFormatProfileDiskFormat (enum)

Profile Disk Format values.

0 = VHD,1 = VHDX

allocationTypeAllocationType (enum)

Allocation Type values.

0 = Dynamic,1 = Full

defaultSizeinteger (int32)

Specifies the 'Default size'.

userInclusionListnullable array of UserFilter (object)

Specifies the 'User Inclusion List'.

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

userExclusionListnullable array of UserFilter (object)

Specifies the 'User Exclusion List'.

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

cloudCacheCloudCacheSettings (object)

FSLogix Cloud Cache Settings

useMaxCacheSizeInMBsboolean

Specifies if the 'Max cache size in MBs' option is enabled or disabled.

maxCacheSizeInMBsinteger (int32)

Specifies the 'Max cache size in MBs'.

useClearCacheOnLogoffboolean

Specifies if the 'Clear cache on logoff' option is enabled or disabled.

clearCacheOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useHealthyProvidersRequiredForRegisterboolean

Specifies if the 'Healthy providers required for register' option is enabled or disabled.

healthyProvidersRequiredForRegisterinteger (int32)

Specifies the 'Healthy providers required for register'.

useHealthyProvidersRequiredForUnregisterboolean

Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.

healthyProvidersRequiredForUnregisterinteger (int32)

Specifies the 'Healthy providers required for unregister'.

useUnregisterTimeoutboolean

Specifies if the 'Unregister timeout' option is enabled or disabled.

unregisterTimeoutinteger (int32)

Specifies the 'Unregister timeout'.

useClearCacheOnForcedUnregisterboolean

Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.

clearCacheOnForcedUnregisterEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

advancedSettingsOfficeContainerAdvancedSettings (object)

FSLogix Office Container Advanced Settings

useLockedRetryCountboolean

Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.

lockedRetryCountinteger (int32)

Specifies the 'Number of locked VHD(X) retries'.

useLockedRetryIntervalboolean

Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.

lockedRetryIntervalinteger (int32)

Specifies the 'Delay between locked VHD(X) retries'.

useAccessNetworkAsComputerObjectboolean

Specifies if the 'Access network as computer object' option is enabled or disabled.

accessNetworkAsComputerObjectEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useAttachVHDSDDLboolean

Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.

attachVHDSDDLnullable string

Specifies the 'SDDL used when attaching the VHD'.

useDiffDiskParentFolderPathboolean

Specifies if the 'Diff disk parent folder path' option is enabled or disabled.

diffDiskParentFolderPathnullable string

Specifies the 'Diff disk parent folder path'.

useFlipFlopProfileDirectoryNameboolean

Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.

flipFlopProfileDirectoryNameEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useNoProfileContainingFolderboolean

Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.

noProfileContainingFolderEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useOutlookCachedModeboolean

Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.

outlookCachedModeEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithFailureboolean

Specifies if the 'Prevent logons with failures' option is enabled or disabled.

preventLoginWithFailureEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithTempProfileboolean

Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.

preventLoginWithTempProfileEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useReAttachRetryCountboolean

Specifies if the 'Re-attach retry limit' option is enabled or disabled.

reAttachRetryCountinteger (int32)

Specifies the 'Re-attach retry limit'.

useReAttachIntervalSecondsboolean

Specifies if the 'Re-attach interval' option is enabled or disabled.

reAttachIntervalSecondsinteger (int32)

Specifies the 'Re-attach interval'.

useRemoveOrphanedOSTFilesOnLogoffboolean

Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.

removeOrphanedOSTFilesOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRoamSearchboolean

Specifies if the 'Search roaming feature mode' option is enabled or disabled.

roamSearchRoamSearch (enum)

Roam search values.

0 = Disable,1 = SingleUser,2 = MultiUser

useSIDDirNameMatchboolean

Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.

sidDirNameMatchnullable string

Specifies the 'User-to-Profile matching pattern'.

useSIDDirNamePatternboolean

Specifies if the 'Profile folder naming pattern' option is enabled or disabled.

sidDirNamePatternnullable string

Specifies the 'Profile folder naming pattern'.

useSIDDirSDDLboolean

Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.

sidDirSDDLnullable string

Specifies the 'Use SSDL on creation of SID container folder'.

useVHDNameMatchboolean

Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.

vhdNameMatchnullable string

Specifies the 'Profile VHD(X) file matching pattern'.

useVHDNamePatternboolean

Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.

vhdNamePatternnullable string

Specifies the 'Naming pattern for new VHD(X) files'.

useVHDXSectorSizeboolean

Specifies if the 'VHDX sector size' option is enabled or disabled.

vhdxSectorSizeVHDXSectorSize (enum)

Enable State values.

0 = SystemDefault,512 = Size_512,4096 = Size_4096

useVolumeWaitTimeMSboolean

Specifies if the 'Volume wait time' option is enabled or disabled.

volumeWaitTimeMSinteger (int32)

Specifies the 'Volume wait time'.

useIgnoreNonAVDboolean

Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).

ignoreNonAVDIgnoreNonAVD (enum)

Ignore non-AVD values.

0 = AnySession,1 = AVDSessions

useRedirectTypeboolean

Specifies if the 'Redirect type' option is enabled or disabled.

redirectTypeRedirectType (enum)

Redirect type values.

1 = Legacy,2 = Advanced

useIncludeOfficeActivationboolean

Specifies if the 'Include Office Activation' option is enabled or disabled.

includeOfficeActivationEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOneDriveboolean

Specifies if the 'Include OneDrive' option is enabled or disabled.

includeOneDriveEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOneNoteboolean

Specifies if the 'Include OneNote' option is enabled or disabled.

includeOneNoteEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOneNoteUWPboolean

Specifies if the 'Include OneNote UWP' option is enabled or disabled.

includeOneNoteUWPEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOutlookboolean

Specifies if the 'Include Outlook' option is enabled or disabled.

includeOutlookEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOutlookPersonalizationboolean

Specifies if the 'Include Outlook Personalization' option is enabled or disabled.

includeOutlookPersonalizationEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeSharepointboolean

Specifies if the 'Include Sharepoint' option is enabled or disabled.

includeSharepointEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeSkypeboolean

Specifies if the 'Include Skype' option is enabled or disabled.

includeSkypeEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeTeamsboolean

Specifies if the 'Include Teams' option is enabled or disabled.

includeTeamsEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useMirrorLocalOSTToVHDboolean

Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.

mirrorLocalOSTToVHDMirrorLocalOSTToVHD (enum)

Mirror Local OST-VHD values.

0 = DoNothing,1 = Copy,2 = Move

useNumSessionVHDsToKeepboolean

Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.

numSessionVHDsToKeepinteger (int32)

Specifies the 'Number of Session VHDs to Keep'.

useOutlookFolderPathboolean

Specifies if the 'Outlook Folder Path' option is enabled or disabled.

outlookFolderPathnullable string

Specifies the 'Outlook Folder Path'.

useRefreshUserPolicyboolean

Specifies if the 'Refresh User Policy' option is enabled or disabled.

refreshUserPolicyEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useVHDAccessModeboolean

Specifies if the 'VHD Access Mode' option is enabled or disabled.

vhdAccessModeVHDAccessMode (enum)

VHD Access Mode values.

0 = NormalDirectAccess,1 = DiffDiskNetwork,2 = DiffDiskLocal,3 = UniqueVHDPerSession

generalSettingsFSLogixGeneralSettings (object)

FSLogix General Settings

appServicesAppServicesSettings (object)

FSLogix App Services Settings

useCleanupInvalidSessionsboolean

Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.

cleanupInvalidSessionsEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRoamRecycleBinboolean

Specifies if the 'Roam recycle bin' option is enabled or disabled.

roamRecycleBinEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useVHDCompactDiskboolean

Specifies if the 'VHD compact disk' option is enabled or disabled.

vhdCompactDiskEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

cloudCacheGeneralCloudCacheGeneralSettings (object)

FSLogix Cloud Cache General Settings

useCacheDirectoryboolean

Specifies if the 'Cache directory' option is enabled or disabled.

cacheDirectorynullable string

Specifies the 'Cache directory'.

useWriteCacheDirectoryboolean

Specifies if the 'Write cache directory' option is enabled or disabled.

writeCacheDirectorynullable string

Specifies the 'Write cache directory'.

useProxyDirectoryboolean

Specifies if the 'Proxy directory' option is enabled or disabled.

proxyDirectorynullable string

Specifies the 'Proxy directory'.

useSilenceACLWarningboolean

Specifies if the 'Silence ACL warning' option is enabled or disabled.

silenceACLWarningEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

loggingFSLogixLoggingSettings (object)

FSLogix Logging Settings

logEnabledFSLogixLogEnabled (enum)

Log enabled values.

0 = Disable,1 = Specific,2 = All

logLevelFSLogixLogLevel (enum)

FSLogix log level values.

0 = Debug,1 = Information,2 = Warning,3 = Error

logFileKeepingPeriodinteger (int32)

Specifies the 'Log keeping period in days'. Default: '2'.

logDirectorynullable string

Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.

robocopyLogPathnullable string

Specifies the 'Robocopy log path'.

logSpecificComponentsLogSpecificComponents (enum)

Log specific components values.

updModeUPDMode (enum)

User Profile Disk Mode.

0 = DoNotChange,1 = Enabled,2 = Disabled

maxUserProfileDiskSizeGBinteger (int32)

Specifies the max user profile disk size (in GB).

diskPathnullable string

Specifies the User Profile Disk path.

roamingModeUPDRoamingMode (enum)

User Profile Disk Roaming Mode.

0 = Exclude,2 = Include

includeFolderPathnullable array of string

Specifies the UPD 'Include' folder paths.

itemsstring

includeFilePathnullable array of string

Specifies the UPD 'Include' file paths.

itemsstring

excludeFolderPathnullable array of string

Specifies the UPD 'Exclude' folder paths.

itemsstring

excludeFilePathnullable array of string

Specifies the UPD 'Exclude' file paths.

itemsstring

restrictDesktopAccessboolean

Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled.

restrictedUsersnullable array of string

Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.

itemsstring

enableOptimizationboolean

optimizationImageOptimization (object)

Image Optimization

enableOptimizationboolean

Whether Optimization is enabled or not

optimizationTypeOptimizationTypeEnum (enum)

Optimization Type

0 = Automatic,1 = Manual

windowsDefenderATPWindowsDefenderATP (object)

Image Optimization - Windows Defender ATP

winDefATPTurnOffOnWindowsDefenderATPEnable (enum)

Windows enable options

0 = TurnOffWindowsDefenderATP,1 = TurnOnWindowsDefenderATP

disableRealTimeProtectionboolean

Disable Real Time Protection

excludeFoldersnullable array of string

Exclude Folders List

itemsstring

excludeProcessesnullable array of string

Exclude Processes

itemsstring

excludeExtensionnullable array of string

Exclude Extensions

itemsstring

windowsComponentsWindowsComponents (object)

Image Optimization - Windows Components

windowsComponentsListnullable array of WindowsComponent (object)

Windows Components List

typeDetailsType (enum)

Details Type

0 = Predefined,1 = Custom

componentNamenullable string

Windows Components Name

displayNamenullable string

Windows Components Display Name

aliasesnullable string

Windows Components Aliases

windowsDefenderATPEnabledboolean

Whether Windows Defender ATP is enabled or not

windowsComponentsEnabledboolean

Whether Windows Components is enabled or not

windowsServicesEnabledboolean

Whether Windows Services is enabled or not

windowsScheduledTasksEnabledboolean

Whether Windows Scheduled Task is enabled or not

windowsAdvancedOptionsEnabledboolean

Whether Windows Advanced Options is enabled or not

networkPerformanceEnabledboolean

Whether Network Performance is enabled or not

registryEnabledboolean

Whether Registry is enabled or not

visualEffectsEnabledboolean

Whether Visual Effects is enabled or not

diskCleanupEnabledboolean

Whether Disk Cleanup is enabled or not

customScriptEnabledboolean

Whether Custom Script is enabled or not

windowsServicesWindowsServices (object)

Image Optimization - Windows Services

windowsServicesListnullable array of WindowsService (object)

Windows Services List

typeDetailsType (enum)

Details Type

0 = Predefined,1 = Custom

serviceNamenullable string

Windows Services Name

displayNamenullable string

Windows Services Display Name

aliasesnullable string

Windows Service Aliases

windowsAdvancedOptionsWindowsAdvancedOptions (object)

Image Optimization - Windows Advanced Options

partialStartLayoutContentnullable string

Partial Start menu layout

hibernateboolean

Whether Hibernate is enabled or not

teleCollectionboolean

Whether TeleCollection is enabled or not

systemRestoreboolean

Whether System Restore is enabled or not

additionalErrorReportboolean

Whether Additional Error Reporting is enabled or not

tilesboolean

Whether Tiles is enabled or not

cortanaboolean

Whether Cortana is enabled or not

microsoftConsumerExperienceboolean

Whether Microsoft Consumer Experience is enabled or not

windowsTipsboolean

Whether Windows Tips is enabled or not

commonProgramGroupsboolean

Whether Common Program Groups is enabled or not

partialStartMenuboolean

Whether Partial Start Menu is enabled or not

networkPerformanceNetworkPerformance (object)

Image Optimization - Network Performance

dirCacheMaxinteger (int32)

Directory Cache Value

dormantFileLimitinteger (int32)

Dormant File Limit Value

fileNotFoundCacheinteger (int32)

File Not Found Cache Value

fileInfoCacheinteger (int32)

File Info Cache Value

fileInfoCacheEnableboolean

Whether File Info Cache is enabled or not

directoryCacheEnableboolean

Whether Directory Cache is enabled or not

fileNotFoundCacheEnableboolean

Whether File Not Found Cache is enabled or not

dormantFileLimitEnableboolean

Whether Dormant File Limit is enabled or not

disableTCPboolean

Whether TCP is disabled or not

disableIPv6CompEnableboolean

Whether Disable IPv6 Components is enabled or not

disableIPv6ToIPv4boolean

Whether Disable IPv6 To IPv4 is enabled or not

disableIsaTapboolean

Whether Disable IsaTap for IPv6 is enabled or not

customScriptCustomScript (object)

Image Optimization - Custom Script

argumentsnullable string

Arguments

commandnullable string

Command

initDirnullable string

Initial Directory

usernullable string

User

diskCleanupDiskCleanup (object)

Image Optimization - Disk Cleanup

cleanupWinSxSFolderboolean

Whether Clean up windows SxS Folder is enabled or not

cleanupSystemFilesboolean

Whether Clean up system files is enabled or not

cleanupTemporaryFileLogsboolean

Whether Clean up temporary file logs is enabled or not

removeOneDriveboolean

Whether Remove One Drives is enabled or not

deleteUserProfilesboolean

Whether Delete User Profiles is enabled or not

visualEffectsVisualEffects (object)

Image Optimization - Visual Effects

visualEffectsTypesVisualEffectsType (enum)

Visual Effects Type

0 = LetWindowsChooseWhatsBest,1 = AdjustForBestAppearance,2 = AdjustForBestPerformance,3 = Custom

animateControlSelectElementsboolean

Whether Animate Control Select Elements is enabled or not

animateWindowsWhenMinimizingMaximizingboolean

Whether Animate Windows When Minimizing Or Maximizing is enabled or not

animateTaskbarboolean

Whether Animate Taskbar is enabled or not

enablePeekboolean

Whether Peek is enabled or not

fadeSlideMenusboolean

Whether Fade Slide Menus is enabled or not

fadeSlideToolTipsboolean

Whether Fade Slide Tool Tips is enabled or not

fadeOutMenuItemsboolean

Whether Fade Out Menu Items is enabled or not

saveTaskbarThumbnailboolean

Whether Taskbar Thumbnail is enabled or not

showShadowUnderMouseboolean

Whether Shadow Under Mouse is enabled or not

shadowUnderWindowsboolean

Whether Shadow Under Windows is enabled or not

thumbnailsInsteadOfIconsboolean

Whether Thumbnails instead of icons is enabled or not

showTranslucentSelectionboolean

Whether Translucent Selection is enabled or not

showWindowsContentWhilstDraggingboolean

Whether Windows Content Whilst Dragging is enabled or not

slideOpenComboBoxesboolean

Whether Slide open combo boxes is enabled or not

smoothEdgesScreenFontsboolean

Whether Smooth Edges Screen Fonts is enabled or not

smoothScrollListBoxesboolean

Whether Smooth Scroll List Boxes is enabled or not

dropShadowsIconboolean

Whether Drop Shadow Icon is enabled or not

windowsScheduledTasksWindowsScheduledTasks (object)

Image Optimization - Windows Scheduled Tasks A List of Windows Scheduled Task settings

windowsScheduledTasksListnullable array of ImageOptimizationWindowsScheduledTask (object)

The Windows Scheduled Tasks List

tasknullable string

Scheduled Task

locationnullable string

Scheduled Task Location

typeOptimizationFileType (enum)

Whether file type is a folder or a task.

0 = Folder,1 = Task

registryRegistries (object)

Image Optimization - Registries A list of Registries

registryListnullable array of Registry (object)

The Registry List

idinteger (int32)

The Id of the registry

actionActionType (enum)

The action type for add registry entry

0 = Add,1 = Modify,2 = Delete

registryNamenullable string

Registry Name

dwordValueinteger (int32)

Value

displayNamenullable string

Display Name

hiveTypeHiveType (enum)

The hive type for add registry entry

0 = HKEY_CURRENT_CONFIG,1 = HKEY_USERS,2 = HKEY_LOCAL_MACHINE,3 = HKEY_CLASSES_ROOT

pathnullable string

Path

regTypeValueType (enum)

The value type for add registry entry

0 = REG_SZ,1 = REG_DWORD,2 = REG_QWORD,3 = REG_MULTI_SZ,4 = REG_EXPAND_SZ

stringValuenullable string

String Value

uwpAppsUWPApps (object)

Image Optimization - UWPApps

allExceptnullable array of string

All Except List

itemsstring

followingPkgsnullable array of string

Following Pkgs List

itemsstring

removeTypeRemoveType (enum)

Remove Type

0 = AllExcept,1 = FollowingPkgs

appPackagesAssignedAppPackagesAssigned (object)

Application Packages Assigned

applicationPackagesAssignednullable array of AppPackageAssigned (object)

List of Application Packages Assigned

versionnullable string

Application version

tagNamenullable string

Application version tag name

tagIdnullable integer (int32)

Application version tag ID

packageNamenullable string

Assigned application package name

Request

Response

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T10:07:19.450Z",
    "timeLastMod": "2024-11-07T10:07:19.450Z",
    "server": "text",
    "enabled": false,
    "description": "text",
    "directAddress": "text",
    "inheritDefaultAgentSettings": false,
    "inheritDefaultPrinterSettings": false,
    "inheritDefaultUserProfileSettings": false,
    "inheritDefaultDesktopAccessSettings": false,
    "inheritDefaultOptimizationSettings": false,
    "inheritDefaultAppPackageSettings": false,
    "allowURLAndMailRedirection": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = EnabledWithAppRegistration"
    ],
    "supportShellURLNamespaceObjects": false,
    "allowRemoteExec": false,
    "enableAppMonitoring": false,
    "useRemoteApps": false,
    "allowFileTransfer": false,
    "fileTransferMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "fileTransferLocation": "text",
    "fileTransferLockLocation": false,
    "allowDragAndDrop": false,
    "dragAndDropMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "enableDriveRedirectionCache": false,
    "manageRDPTransportProtocol": [
      "0 = Disabled",
      "1 = BothUDPTCP",
      "2 = OnlyTCP",
      "3 = EitherUDPTCP"
    ],
    "enablePrinting": false,
    "enableTWAIN": false,
    "enableWIA": false,
    "printerNameFormat": [
      "0 = PrnFormat_PRN_CMP_SES",
      "1 = PrnFormat_SES_CMP_PRN",
      "2 = PrnFormat_PRN_REDSES"
    ],
    "removeClientNameFromPrinterName": false,
    "removeSessionNumberFromPrinterName": false,
    "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"
        ],
        "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,
          "useClearCacheOnLogoff": false,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": false,
          "useHealthyProvidersRequiredForUnregister": false,
          "useUnregisterTimeout": false,
          "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,
          "useLockedRetryInterval": false,
          "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,
          "useReAttachIntervalSeconds": false,
          "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,
          "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"
        ],
        "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,
          "useClearCacheOnLogoff": false,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": false,
          "useHealthyProvidersRequiredForUnregister": false,
          "useUnregisterTimeout": false,
          "useClearCacheOnForcedUnregister": false,
          "clearCacheOnForcedUnregister": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "advancedSettings": {
          "useLockedRetryCount": false,
          "useLockedRetryInterval": false,
          "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,
          "useReAttachIntervalSeconds": false,
          "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,
          "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,
          "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"
          ],
          "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"
          ]
        }
      }
    },
    "updMode": [
      "0 = DoNotChange",
      "1 = Enabled",
      "2 = Disabled"
    ],
    "diskPath": "text",
    "roamingMode": [
      "0 = Exclude",
      "2 = Include"
    ],
    "includeFolderPath": [
      "text"
    ],
    "includeFilePath": [
      "text"
    ],
    "excludeFolderPath": [
      "text"
    ],
    "excludeFilePath": [
      "text"
    ],
    "restrictDesktopAccess": false,
    "restrictedUsers": [
      "text"
    ],
    "enableOptimization": false,
    "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": {
        "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": [
          {
            "action": [
              "0 = Add",
              "1 = Modify",
              "2 = Delete"
            ],
            "registryName": "text",
            "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"
        ]
      }
    },
    "appPackagesAssigned": {
      "applicationPackagesAssigned": [
        {
          "version": "text",
          "tagName": "text",
          "packageName": "text"
        }
      ]
    }
  }
]