ProfileContainer

Get

Retrieve the FSLogix Profile Container settings of a session server with the specified ID.

GET/api/RDS/Host/{id}/FSLogix/ProfileContainer

Path parameters

id*integer (int32)

The ID of a session server for which to retrieve the FSLogix Profile Container settings.

Response

Success

Body

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

ccdLocationsnullable array of string

Specifies the 'CCDLocations'.

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

userExclusionListnullable array of UserFilter (object)

Specifies the 'User Exclusion List'.

cloudCacheCloudCacheSettings (object)

FSLogix Cloud Cache Settings

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

folderExclusionListnullable array of FolderExclusion (object)

Specifies the 'Folder Exclusion List'.

advancedSettingsProfileContainerAdvancedSettings (object)

FSLogix Profile Container Advanced Settings

Request

const response = await fetch('/api/RDS/Host/{id}/FSLogix/ProfileContainer', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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"
    ]
  }
}

Update

Update the FSLogix Profile Container settings of a session server with the specified ID.

PUT/api/RDS/Host/{id}/FSLogix/ProfileContainer

Path parameters

id*integer (int32)

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

FSLogix Profile Container settings.

profileContainerEnablednullable boolean

Specifies if the Profile Container is enabled or disabled..

locationTypeLocationType (enum)

Location Type values.

0 = SMBLocation,1 = CloudCache

vhdLocationsnullable array of string

Specifies the 'VHD Locations'.

ccdLocationsnullable array of string

Specifies the 'CDD Locations'.

profileDiskFormatProfileDiskFormat (enum)

Profile Disk Format values.

0 = VHD,1 = VHDX

allocationTypeAllocationType (enum)

Allocation Type values.

0 = Dynamic,1 = Full

defaultSizenullable integer (int32)

Specifies the 'Default size'.

customizeProfileFoldersnullable boolean

Enable or disable the 'Customize Profile Folders' option.

excludeCommonFoldersExcludeCommonFolders (enum)

Exclude Common Folders.

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

useLockedRetryCountnullable boolean

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

lockedRetryCountnullable integer (int32)

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

useLockedRetryIntervalnullable boolean

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

lockedRetryIntervalnullable integer (int32)

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

useAccessNetworkAsComputerObjectnullable boolean

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

accessNetworkAsComputerObjectEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useAttachVHDSDDLnullable boolean

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

attachVHDSDDLnullable string

Specifies the 'SDDL used when attaching the VHD'.

useDiffDiskParentFolderPathnullable boolean

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

diffDiskParentFolderPathnullable string

Specifies the 'Diff disk parent folder path'.

useFlipFlopProfileDirectoryNamenullable boolean

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

useNoProfileContainingFoldernullable boolean

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

useOutlookCachedModenullable boolean

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

outlookCachedModeEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithFailurenullable boolean

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

preventLoginWithFailureEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithTempProfilenullable boolean

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

preventLoginWithTempProfileEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useReAttachRetryCountnullable boolean

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

reAttachRetryCountnullable integer (int32)

Specifies the 'Re-attach retry limit'.

useReAttachIntervalSecondsnullable boolean

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

reAttachIntervalSecondsnullable integer (int32)

Specifies the 'Re-attach interval'.

useRemoveOrphanedOSTFilesOnLogoffnullable boolean

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

removeOrphanedOSTFilesOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRoamSearchnullable boolean

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

roamSearchRoamSearch (enum)

Roam search values.

0 = Disable,1 = SingleUser,2 = MultiUser

useSIDDirNameMatchnullable boolean

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

sidDirNameMatchnullable string

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

useSIDDirNamePatternnullable boolean

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

sidDirNamePatternnullable string

Specifies the 'Profile folder naming pattern'.

useSIDDirSDDLnullable boolean

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

useVHDNameMatchnullable boolean

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

vhdNameMatchnullable string

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

useVHDNamePatternnullable boolean

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

useVHDXSectorSizenullable boolean

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

vhdxSectorSizeVHDXSectorSize (enum)

Enable State values.

0 = SystemDefault,512 = Size_512,4096 = Size_4096

useVolumeWaitTimeMSnullable boolean

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

volumeWaitTimeMSnullable integer (int32)

Specifies the 'Volume wait time'.

useIgnoreNonAVDnullable boolean

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

ignoreNonAVDIgnoreNonAVD (enum)

Ignore non-AVD values.

0 = AnySession,1 = AVDSessions

useRedirectTypenullable boolean

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

redirectTypeRedirectType (enum)

Redirect type values.

1 = Legacy,2 = Advanced

useKeepLocalDirnullable boolean

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

keepLocalDirEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useDeleteLocalProfileWhenVHDShouldApplynullable boolean

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

deleteLocalProfileWhenVHDShouldApplyEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useProfileDirSDDLnullable boolean

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

profileDirSDDLnullable string

Specifies the 'Custom SDDL for profile directory'.

useProfileTypenullable boolean

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

profileTypeProfileType (enum)

Profile Type values.

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

useSetTempToLocalPathnullable boolean

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

useCleanOutNotificationsnullable boolean

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

cleanOutNotificationsEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useInstallAppxPackagesnullable boolean

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

installAppxPackagesEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRebootOnUserLogoffnullable boolean

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

rebootOnUserLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRoamIdentitynullable boolean

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

roamIdentityEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useShutdownOnUserLogoffnullable boolean

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

shutdownOnUserLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useMaxCacheSizeInMBsnullable boolean

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

maxCacheSizeInMBsnullable integer (int32)

Specifies the 'Max cache size in MBs'.

useClearCacheOnLogoffnullable boolean

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

clearCacheOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useHealthyProvidersRequiredForRegisternullable boolean

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

healthyProvidersRequiredForRegisternullable integer (int32)

Specifies the 'Healthy providers required for register'.

useHealthyProvidersRequiredForUnregisternullable boolean

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

healthyProvidersRequiredForUnregisternullable integer (int32)

Specifies the 'Healthy providers required for unregister'.

useUnregisterTimeoutnullable boolean

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

unregisterTimeoutnullable integer (int32)

Specifies the 'Unregister timeout'.

useClearCacheOnForcedUnregisternullable boolean

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

clearCacheOnForcedUnregisterEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

Response

No Content

Request

const response = await fetch('/api/RDS/Host/{id}/FSLogix/ProfileContainer', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

PreviousVHDLocations NextCCDLocations