Profile Container

Get

get

Retrieve the FSLogix Profile Container settings of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer

HTTPcURLJavaScriptPython

GET /api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer HTTP/1.1
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

put

Update the FSLogix Profile Container settings of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to modify the FSLogix Profile Container settings (optional).

Body

application/json; api-version=1.0

Update FSLogix profile configuration of a Sessions Host

profileContainerEnabledboolean · nullableOptional

Specifies if the Profile Container is enabled or disabled..

locationTypestring · enumOptional

Location Type values.

Possible values:

vhdLocationsstring[] · nullableOptional

Specifies the 'VHD Locations'.

ccdLocationsstring[] · nullableOptional

Specifies the 'CDD Locations'.

profileDiskFormatstring · enumOptional

Profile Disk Format values.

Possible values:

allocationTypestring · enumOptional

Allocation Type values.

Possible values:

defaultSizeinteger · int32 · nullableOptional

Specifies the 'Default size'.

customizeProfileFoldersboolean · nullableOptional

Enable or disable the 'Customize Profile Folders' option.

excludeCommonFoldersstring[Flag] · enumOptional

Exclude Common Folders.

Possible values:

useLockedRetryCountboolean · nullableOptional

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

lockedRetryCountinteger · int32 · nullableOptional

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

useLockedRetryIntervalboolean · nullableOptional

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

lockedRetryIntervalinteger · int32 · nullableOptional

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

useAccessNetworkAsComputerObjectboolean · nullableOptional

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

accessNetworkAsComputerObjectstring · enumOptional

Enable State values.

Possible values:

useAttachVHDSDDLboolean · nullableOptional

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

attachVHDSDDLstring · max: 255 · nullableOptional

Specifies the 'SDDL used when attaching the VHD'.

useDiffDiskParentFolderPathboolean · nullableOptional

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

diffDiskParentFolderPathstring · min: 1 · max: 255 · nullableOptional

Specifies the 'Diff disk parent folder path'.

useFlipFlopProfileDirectoryNameboolean · nullableOptional

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

flipFlopProfileDirectoryNamestring · enumOptional

Enable State values.

Possible values:

useNoProfileContainingFolderboolean · nullableOptional

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

noProfileContainingFolderstring · enumOptional

Enable State values.

Possible values:

useOutlookCachedModeboolean · nullableOptional

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

outlookCachedModestring · enumOptional

Enable State values.

Possible values:

usePreventLoginWithFailureboolean · nullableOptional

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

preventLoginWithFailurestring · enumOptional

Enable State values.

Possible values:

usePreventLoginWithTempProfileboolean · nullableOptional

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

preventLoginWithTempProfilestring · enumOptional

Enable State values.

Possible values:

useReAttachRetryCountboolean · nullableOptional

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

reAttachRetryCountinteger · int32 · nullableOptional

Specifies the 'Re-attach retry limit'.

useReAttachIntervalSecondsboolean · nullableOptional

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

reAttachIntervalSecondsinteger · int32 · nullableOptional

Specifies the 'Re-attach interval'.

useRemoveOrphanedOSTFilesOnLogoffboolean · nullableOptional

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

removeOrphanedOSTFilesOnLogoffstring · enumOptional

Enable State values.

Possible values:

useRoamSearchboolean · nullableOptional

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

roamSearchstring · enumOptional

Roam search values.

Possible values:

useSIDDirNameMatchboolean · nullableOptional

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

sidDirNameMatchstring · min: 1 · max: 255 · nullableOptional

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

useSIDDirNamePatternboolean · nullableOptional

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

sidDirNamePatternstring · min: 1 · max: 255 · nullableOptional

Specifies the 'Profile folder naming pattern'.

useSIDDirSDDLboolean · nullableOptional

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

sidDirSDDLstring · max: 255 · nullableOptional

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

useVHDNameMatchboolean · nullableOptional

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

vhdNameMatchstring · min: 1 · max: 255 · nullableOptional

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

useVHDNamePatternboolean · nullableOptional

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

vhdNamePatternstring · min: 1 · max: 255 · nullableOptional

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

useVHDXSectorSizeboolean · nullableOptional

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

vhdxSectorSizestring · enumOptional

Enable State values.

Possible values:

useVolumeWaitTimeMSboolean · nullableOptional

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

volumeWaitTimeMSinteger · int32 · nullableOptional

Specifies the 'Volume wait time'.

useIgnoreNonAVDboolean · nullableOptional

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

ignoreNonAVDstring · enumOptional

Ignore non-AVD values.

Possible values:

useRedirectTypeboolean · nullableOptional

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

redirectTypestring · enumOptional

Redirect type values.

Possible values:

useKeepLocalDirboolean · nullableOptional

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

keepLocalDirstring · enumOptional

Enable State values.

Possible values:

useDeleteLocalProfileWhenVHDShouldApplyboolean · nullableOptional

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

deleteLocalProfileWhenVHDShouldApplystring · enumOptional

Enable State values.

Possible values:

useProfileDirSDDLboolean · nullableOptional

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

profileDirSDDLstring · max: 255 · nullableOptional

Specifies the 'Custom SDDL for profile directory'.

useProfileTypeboolean · nullableOptional

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

profileTypestring · enumOptional

Profile Type values.

Possible values:

useSetTempToLocalPathboolean · nullableOptional

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

setTempToLocalPathstring · enumOptional

Temporary Folder Redirection Mode values.

Possible values:

useCleanOutNotificationsboolean · nullableOptional

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

cleanOutNotificationsstring · enumOptional

Enable State values.

Possible values:

useInstallAppxPackagesboolean · nullableOptional

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

installAppxPackagesstring · enumOptional

Enable State values.

Possible values:

useRebootOnUserLogoffboolean · nullableOptional

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

rebootOnUserLogoffstring · enumOptional

Enable State values.

Possible values:

useRoamIdentityboolean · nullableOptional

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

roamIdentitystring · enumOptional

Enable State values.

Possible values:

useShutdownOnUserLogoffboolean · nullableOptional

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

shutdownOnUserLogoffstring · enumOptional

Enable State values.

Possible values:

useMaxCacheSizeInMBsboolean · nullableOptional

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

maxCacheSizeInMBsinteger · int32 · nullableOptional

Specifies the 'Max cache size in MBs'.

useClearCacheOnLogoffboolean · nullableOptional

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

clearCacheOnLogoffstring · enumOptional

Enable State values.

Possible values:

useHealthyProvidersRequiredForRegisterboolean · nullableOptional

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

healthyProvidersRequiredForRegisterinteger · int32 · nullableOptional

Specifies the 'Healthy providers required for register'.

useHealthyProvidersRequiredForUnregisterboolean · nullableOptional

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

healthyProvidersRequiredForUnregisterinteger · int32 · nullableOptional

Specifies the 'Healthy providers required for unregister'.

useUnregisterTimeoutboolean · nullableOptional

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

unregisterTimeoutinteger · int32 · nullableOptional

Specifies the 'Unregister timeout'.

useClearCacheOnForcedUnregisterboolean · nullableOptional

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

clearCacheOnForcedUnregisterstring · enumOptional

Enable State values.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer

HTTPcURLJavaScriptPython

PUT /api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer HTTP/1.1
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