ProfileContainer
Retrieve the FSLogix Profile Container settings of a Site Defaults object.
The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).
GET /api/VDIDefaultSettings/FSLogix/ProfileContainer HTTP/1.1
Host:
Accept: */*
{
"enabled": true,
"locationType": [
"0 = SMBLocation",
"1 = CloudCache"
],
"vhdLocations": [
"text"
],
"ccdLocations": [
"text"
],
"profileDiskFormat": [
"0 = VHD",
"1 = VHDX"
],
"allocationType": [
"0 = Dynamic",
"1 = Full"
],
"defaultSize": 1,
"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": true,
"maxCacheSizeInMBs": 1,
"useClearCacheOnLogoff": true,
"clearCacheOnLogoff": [
"0 = Disable",
"1 = Enable"
],
"useHealthyProvidersRequiredForRegister": true,
"healthyProvidersRequiredForRegister": 1,
"useHealthyProvidersRequiredForUnregister": true,
"healthyProvidersRequiredForUnregister": 1,
"useUnregisterTimeout": true,
"unregisterTimeout": 1,
"useClearCacheOnForcedUnregister": true,
"clearCacheOnForcedUnregister": [
"0 = Disable",
"1 = Enable"
]
},
"customizeProfileFolders": true,
"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": true,
"lockedRetryCount": 1,
"useLockedRetryInterval": true,
"lockedRetryInterval": 1,
"useAccessNetworkAsComputerObject": true,
"accessNetworkAsComputerObject": [
"0 = Disable",
"1 = Enable"
],
"useAttachVHDSDDL": true,
"attachVHDSDDL": "text",
"useDiffDiskParentFolderPath": true,
"diffDiskParentFolderPath": "text",
"useFlipFlopProfileDirectoryName": true,
"flipFlopProfileDirectoryName": [
"0 = Disable",
"1 = Enable"
],
"useNoProfileContainingFolder": true,
"noProfileContainingFolder": [
"0 = Disable",
"1 = Enable"
],
"useOutlookCachedMode": true,
"outlookCachedMode": [
"0 = Disable",
"1 = Enable"
],
"usePreventLoginWithFailure": true,
"preventLoginWithFailure": [
"0 = Disable",
"1 = Enable"
],
"usePreventLoginWithTempProfile": true,
"preventLoginWithTempProfile": [
"0 = Disable",
"1 = Enable"
],
"useReAttachRetryCount": true,
"reAttachRetryCount": 1,
"useReAttachIntervalSeconds": true,
"reAttachIntervalSeconds": 1,
"useRemoveOrphanedOSTFilesOnLogoff": true,
"removeOrphanedOSTFilesOnLogoff": [
"0 = Disable",
"1 = Enable"
],
"useRoamSearch": true,
"roamSearch": [
"0 = Disable",
"1 = SingleUser",
"2 = MultiUser"
],
"useSIDDirNameMatch": true,
"sidDirNameMatch": "text",
"useSIDDirNamePattern": true,
"sidDirNamePattern": "text",
"useSIDDirSDDL": true,
"sidDirSDDL": "text",
"useVHDNameMatch": true,
"vhdNameMatch": "text",
"useVHDNamePattern": true,
"vhdNamePattern": "text",
"useVHDXSectorSize": true,
"vhdxSectorSize": [
"0 = SystemDefault",
"512 = Size_512",
"4096 = Size_4096"
],
"useVolumeWaitTimeMS": true,
"volumeWaitTimeMS": 1,
"useIgnoreNonAVD": true,
"ignoreNonAVD": [
"0 = AnySession",
"1 = AVDSessions"
],
"useRedirectType": true,
"redirectType": [
"1 = Legacy",
"2 = Advanced"
],
"useKeepLocalDir": true,
"keepLocalDir": [
"0 = Disable",
"1 = Enable"
],
"useDeleteLocalProfileWhenVHDShouldApply": true,
"deleteLocalProfileWhenVHDShouldApply": [
"0 = Disable",
"1 = Enable"
],
"useProfileDirSDDL": true,
"profileDirSDDL": "text",
"useProfileType": true,
"profileType": [
"0 = NormalProfile",
"1 = OnlyRWProfile",
"2 = OnlyROProfile",
"3 = RWROProfile"
],
"useSetTempToLocalPath": true,
"setTempToLocalPath": [
"0 = TakeNoAction",
"1 = RedirectTempAndTmp",
"2 = RedirectINetCache",
"3 = RedirectTempTmpAndINetCache"
],
"useCleanOutNotifications": true,
"cleanOutNotifications": [
"0 = Disable",
"1 = Enable"
],
"useInstallAppxPackages": true,
"installAppxPackages": [
"0 = Disable",
"1 = Enable"
],
"useRebootOnUserLogoff": true,
"rebootOnUserLogoff": [
"0 = Disable",
"1 = Enable"
],
"useRoamIdentity": true,
"roamIdentity": [
"0 = Disable",
"1 = Enable"
],
"useShutdownOnUserLogoff": true,
"shutdownOnUserLogoff": [
"0 = Disable",
"1 = Enable"
]
}
}Update the FSLogix Profile Container settings of a Site Defaults object.
The SiteId of a Site Defaults object for which to modify the FSLogix Profile Container settings (optional).
Update FSLogix profile configuration of a Sessions Host
Specifies if the Profile Container is enabled or disabled..
Location Type values.
Specifies the 'VHD Locations'.
Specifies the 'CDD Locations'.
Profile Disk Format values.
Allocation Type values.
Specifies the 'Default size'.
Enable or disable the 'Customize Profile Folders' option.
Exclude Common Folders.
Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Number of locked VHD(X) retries'.
Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.
Specifies the 'Delay between locked VHD(X) retries'.
Specifies if the 'Access network as computer object' option is enabled or disabled.
Enable State values.
Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.
Specifies the 'SDDL used when attaching the VHD'.
Specifies if the 'Diff disk parent folder path' option is enabled or disabled.
Specifies the 'Diff disk parent folder path'.
Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.
Enable State values.
Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with failures' option is enabled or disabled.
Enable State values.
Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Re-attach retry limit' option is enabled or disabled.
Specifies the 'Re-attach retry limit'.
Specifies if the 'Re-attach interval' option is enabled or disabled.
Specifies the 'Re-attach interval'.
Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Search roaming feature mode' option is enabled or disabled.
Roam search values.
Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.
Specifies the 'User-to-Profile matching pattern'.
Specifies if the 'Profile folder naming pattern' option is enabled or disabled.
Specifies the 'Profile folder naming pattern'.
Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.
Specifies the 'Use SSDL on creation of SID container folder'.
Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.
Specifies the 'Profile VHD(X) file matching pattern'.
Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.
Specifies the 'Naming pattern for new VHD(X) files'.
Specifies if the 'VHDX sector size' option is enabled or disabled.
Enable State values.
Specifies if the 'Volume wait time' option is enabled or disabled.
Specifies the 'Volume wait time'.
Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).
Ignore non-AVD values.
Specifies if the 'Redirect type' option is enabled or disabled.
Redirect type values.
Specifies if the 'Keep local profiles' option is enabled or disabled.
Enable State values.
Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.
Enable State values.
Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.
Specifies the 'Custom SDDL for profile directory'.
Specifies if the 'Profile type' option is enabled or disabled.
Profile Type values.
Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.
Temporary Folder Redirection Mode values.
Specifies if the 'Clean out notifications' option is enabled or disabled.
Enable State values.
Specifies if the Install Appx packages' option is enabled or disabled.
Enable State values.
Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.
Enable State values.
Specifies if the 'Roam identity' option is enabled or disabled.
Enable State values.
Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.
Enable State values.
Specifies if the 'Max cache size in MBs' option is enabled or disabled.
Specifies the 'Max cache size in MBs'.
Specifies if the 'Clear cache on logoff' option is enabled or disabled.
Enable State values.
Specifies if the 'Healthy providers required for register' option is enabled or disabled.
Specifies the 'Healthy providers required for register'.
Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.
Specifies the 'Healthy providers required for unregister'.
Specifies if the 'Unregister timeout' option is enabled or disabled.
Specifies the 'Unregister timeout'.
Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.
Enable State values.
PUT /api/VDIDefaultSettings/FSLogix/ProfileContainer HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 3397
{
"profileContainerEnabled": true,
"locationType": [
"0 = SMBLocation",
"1 = CloudCache"
],
"vhdLocations": [
"text"
],
"ccdLocations": [
"text"
],
"profileDiskFormat": [
"0 = VHD",
"1 = VHDX"
],
"allocationType": [
"0 = Dynamic",
"1 = Full"
],
"defaultSize": 1,
"customizeProfileFolders": true,
"excludeCommonFolders": [
"1 = Contacts",
"2 = Desktop",
"4 = Documents",
"8 = Links",
"16 = MusicPodcasts",
"32 = PicturesVideos",
"64 = FoldersLowIntegProcesses",
"128 = Downloads"
],
"useLockedRetryCount": true,
"lockedRetryCount": 1,
"useLockedRetryInterval": true,
"lockedRetryInterval": 1,
"useAccessNetworkAsComputerObject": true,
"accessNetworkAsComputerObject": [
"0 = Disable",
"1 = Enable"
],
"useAttachVHDSDDL": true,
"attachVHDSDDL": "text",
"useDiffDiskParentFolderPath": true,
"diffDiskParentFolderPath": "text",
"useFlipFlopProfileDirectoryName": true,
"flipFlopProfileDirectoryName": [
"0 = Disable",
"1 = Enable"
],
"useNoProfileContainingFolder": true,
"noProfileContainingFolder": [
"0 = Disable",
"1 = Enable"
],
"useOutlookCachedMode": true,
"outlookCachedMode": [
"0 = Disable",
"1 = Enable"
],
"usePreventLoginWithFailure": true,
"preventLoginWithFailure": [
"0 = Disable",
"1 = Enable"
],
"usePreventLoginWithTempProfile": true,
"preventLoginWithTempProfile": [
"0 = Disable",
"1 = Enable"
],
"useReAttachRetryCount": true,
"reAttachRetryCount": 1,
"useReAttachIntervalSeconds": true,
"reAttachIntervalSeconds": 1,
"useRemoveOrphanedOSTFilesOnLogoff": true,
"removeOrphanedOSTFilesOnLogoff": [
"0 = Disable",
"1 = Enable"
],
"useRoamSearch": true,
"roamSearch": [
"0 = Disable",
"1 = SingleUser",
"2 = MultiUser"
],
"useSIDDirNameMatch": true,
"sidDirNameMatch": "text",
"useSIDDirNamePattern": true,
"sidDirNamePattern": "text",
"useSIDDirSDDL": true,
"sidDirSDDL": "text",
"useVHDNameMatch": true,
"vhdNameMatch": "text",
"useVHDNamePattern": true,
"vhdNamePattern": "text",
"useVHDXSectorSize": true,
"vhdxSectorSize": [
"0 = SystemDefault",
"512 = Size_512",
"4096 = Size_4096"
],
"useVolumeWaitTimeMS": true,
"volumeWaitTimeMS": 1,
"useIgnoreNonAVD": true,
"ignoreNonAVD": [
"0 = AnySession",
"1 = AVDSessions"
],
"useRedirectType": true,
"redirectType": [
"1 = Legacy",
"2 = Advanced"
],
"useKeepLocalDir": true,
"keepLocalDir": [
"0 = Disable",
"1 = Enable"
],
"useDeleteLocalProfileWhenVHDShouldApply": true,
"deleteLocalProfileWhenVHDShouldApply": [
"0 = Disable",
"1 = Enable"
],
"useProfileDirSDDL": true,
"profileDirSDDL": "text",
"useProfileType": true,
"profileType": [
"0 = NormalProfile",
"1 = OnlyRWProfile",
"2 = OnlyROProfile",
"3 = RWROProfile"
],
"useSetTempToLocalPath": true,
"setTempToLocalPath": [
"0 = TakeNoAction",
"1 = RedirectTempAndTmp",
"2 = RedirectINetCache",
"3 = RedirectTempTmpAndINetCache"
],
"useCleanOutNotifications": true,
"cleanOutNotifications": [
"0 = Disable",
"1 = Enable"
],
"useInstallAppxPackages": true,
"installAppxPackages": [
"0 = Disable",
"1 = Enable"
],
"useRebootOnUserLogoff": true,
"rebootOnUserLogoff": [
"0 = Disable",
"1 = Enable"
],
"useRoamIdentity": true,
"roamIdentity": [
"0 = Disable",
"1 = Enable"
],
"useShutdownOnUserLogoff": true,
"shutdownOnUserLogoff": [
"0 = Disable",
"1 = Enable"
],
"useMaxCacheSizeInMBs": true,
"maxCacheSizeInMBs": 1,
"useClearCacheOnLogoff": true,
"clearCacheOnLogoff": [
"0 = Disable",
"1 = Enable"
],
"useHealthyProvidersRequiredForRegister": true,
"healthyProvidersRequiredForRegister": 1,
"useHealthyProvidersRequiredForUnregister": true,
"healthyProvidersRequiredForUnregister": 1,
"useUnregisterTimeout": true,
"unregisterTimeout": 1,
"useClearCacheOnForcedUnregister": true,
"clearCacheOnForcedUnregister": [
"0 = Disable",
"1 = Enable"
]
}No content
Was this helpful?