Parallels REST API

Get

Retrieves the FSLogix Office Container settings of a session server with the specified ID.

get

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer'

200

401

404

{
  "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"
    ]
  },
  "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"
    ],
    "useIncludeOfficeActivation": true,
    "includeOfficeActivation": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneDrive": true,
    "includeOneDrive": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNote": true,
    "includeOneNote": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNoteUWP": true,
    "includeOneNoteUWP": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlook": true,
    "includeOutlook": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlookPersonalization": true,
    "includeOutlookPersonalization": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSharepoint": true,
    "includeSharepoint": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSkype": true,
    "includeSkype": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeTeams": true,
    "includeTeams": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useMirrorLocalOSTToVHD": true,
    "mirrorLocalOSTToVHD": [
      "0 = DoNothing",
      "1 = Copy",
      "2 = Move"
    ],
    "useNumSessionVHDsToKeep": true,
    "numSessionVHDsToKeep": 1,
    "useOutlookFolderPath": true,
    "outlookFolderPath": "text",
    "useRefreshUserPolicy": true,
    "refreshUserPolicy": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDAccessMode": true,
    "vhdAccessMode": [
      "0 = NormalDirectAccess",
      "1 = DiffDiskNetwork",
      "2 = DiffDiskLocal",
      "3 = UniqueVHDPerSession"
    ]
  }
}

Success

Update

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

put

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer

Path parameters

idinteger · int32required

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

Body

officeContainerEnabledboolean | nullable

<para type="description">Specifies if the Office Container is enabled or disabled.</para>

locationTypestring · enum

<para type="synopsis">Location Type values.</para> <para type="description"></para>

Options: 0 = SMBLocation,1 = CloudCache

vhdLocationsstring[] | nullable

<para type="description">Specifies the 'VHD Locations'.</para>

ccdLocationsstring[] | nullable

<para type="description">Specifies the 'CDD Locations'.</para>

profileDiskFormatstring · enum

<para type="synopsis">Profile Disk Format values.</para> <para type="description"></para>

Options: 0 = VHD,1 = VHDX

allocationTypestring · enum

<para type="synopsis">Allocation Type values.</para> <para type="description"></para>

Options: 0 = Dynamic,1 = Full

defaultSizeinteger · int32 | nullable

<para type="description">Specifies the 'Default size'.</para>

useLockedRetryCountboolean | nullable

<para type="description">Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.</para>

lockedRetryCountinteger · int32 | nullable

<para type="description">Specifies the 'Number of locked VHD(X) retries'.</para>

useLockedRetryIntervalboolean | nullable

<para type="description">Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.</para>

lockedRetryIntervalinteger · int32 | nullable

<para type="description">Specifies the 'Delay between locked VHD(X) retries'.</para>

useAccessNetworkAsComputerObjectboolean | nullable

<para type="description">Specifies if the 'Access network as computer object' option is enabled or disabled.</para>

accessNetworkAsComputerObjectstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useAttachVHDSDDLboolean | nullable

<para type="description">Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.</para>

attachVHDSDDLstring | nullable

<para type="description">Specifies the 'SDDL used when attaching the VHD'.</para>

useDiffDiskParentFolderPathboolean | nullable

<para type="description">Specifies if the 'Diff disk parent folder path' option is enabled or disabled.</para>

diffDiskParentFolderPathstring | nullable

<para type="description">Specifies the 'Diff disk parent folder path'.</para>

useFlipFlopProfileDirectoryNameboolean | nullable

<para type="description">Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.</para>

flipFlopProfileDirectoryNamestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useNoProfileContainingFolderboolean | nullable

<para type="description">Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.</para>

noProfileContainingFolderstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useOutlookCachedModeboolean | nullable

<para type="description">Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.</para>

outlookCachedModestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

usePreventLoginWithFailureboolean | nullable

<para type="description">Specifies if the 'Prevent logons with failures' option is enabled or disabled.</para>

preventLoginWithFailurestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

usePreventLoginWithTempProfileboolean | nullable

<para type="description">Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.</para>

preventLoginWithTempProfilestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useReAttachRetryCountboolean | nullable

<para type="description">Specifies if the 'Re-attach retry limit' option is enabled or disabled.</para>

reAttachRetryCountinteger · int32 | nullable

<para type="description">Specifies the 'Re-attach retry limit'.</para>

useReAttachIntervalSecondsboolean | nullable

<para type="description">Specifies if the 'Re-attach interval' option is enabled or disabled.</para>

reAttachIntervalSecondsinteger · int32 | nullable

<para type="description">Specifies the 'Re-attach interval'.</para>

useRemoveOrphanedOSTFilesOnLogoffboolean | nullable

<para type="description">Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.</para>

removeOrphanedOSTFilesOnLogoffstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useRoamSearchboolean | nullable

<para type="description">Specifies if the 'Search roaming feature mode' option is enabled or disabled.</para>

roamSearchstring · enum

<para type="synopsis">Roam search values.</para> <para type="description"></para>

Options: 0 = Disable,1 = SingleUser,2 = MultiUser

useSIDDirNameMatchboolean | nullable

<para type="description">Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.</para>

sidDirNameMatchstring | nullable

<para type="description">Specifies the 'User-to-Profile matching pattern'.</para>

useSIDDirNamePatternboolean | nullable

<para type="description">Specifies if the 'Profile folder naming pattern' option is enabled or disabled.</para>

sidDirNamePatternstring | nullable

<para type="description">Specifies the 'Profile folder naming pattern'.</para>

useSIDDirSDDLboolean | nullable

<para type="description">Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.</para>

sidDirSDDLstring | nullable

<para type="description">Specifies the 'Use SSDL on creation of SID container folder'.</para>

useVHDNameMatchboolean | nullable

<para type="description">Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.</para>

vhdNameMatchstring | nullable

<para type="description">Specifies the 'Profile VHD(X) file matching pattern'.</para>

useVHDNamePatternboolean | nullable

<para type="description">Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.</para>

vhdNamePatternstring | nullable

<para type="description">Specifies the 'Naming pattern for new VHD(X) files'.</para>

useVHDXSectorSizeboolean | nullable

<para type="description">Specifies if the 'VHDX sector size' option is enabled or disabled.</para>

vhdxSectorSizestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = SystemDefault,512 = Size_512,4096 = Size_4096

useVolumeWaitTimeMSboolean | nullable

<para type="description">Specifies if the 'Volume wait time' option is enabled or disabled.</para>

volumeWaitTimeMSinteger · int32 | nullable

<para type="description">Specifies the 'Volume wait time'.</para>

useIgnoreNonAVDboolean | nullable

<para type="description">Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).</para>

ignoreNonAVDstring · enum

<para type="synopsis">Ignore non-AVD values.</para> <para type="description"></para>

Options: 0 = AnySession,1 = AVDSessions

useRedirectTypeboolean | nullable

<para type="description">Specifies if the 'Redirect type' option is enabled or disabled.</para>

redirectTypestring · enum

<para type="synopsis">Redirect type values.</para> <para type="description"></para>

Options: 1 = Legacy,2 = Advanced

useIncludeOfficeActivationboolean | nullable

<para type="description">Specifies if the 'Include Office Activation' option is enabled or disabled.</para>

includeOfficeActivationstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useIncludeOneDriveboolean | nullable

<para type="description">Specifies if the 'Include OneDrive' option is enabled or disabled.</para>

includeOneDrivestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useIncludeOneNoteboolean | nullable

<para type="description">Specifies if the 'Include OneNote' option is enabled or disabled.</para>

includeOneNotestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useIncludeOneNoteUWPboolean | nullable

<para type="description">Specifies if the 'Include OneNote UWP' option is enabled or disabled.</para>

includeOneNoteUWPstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useIncludeOutlookboolean | nullable

<para type="description">Specifies if the 'Include Outlook' option is enabled or disabled.</para>

includeOutlookstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useIncludeOutlookPersonalizationboolean | nullable

<para type="description">Specifies if the 'Include Outlook Personalization' option is enabled or disabled.</para>

includeOutlookPersonalizationstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useIncludeSharepointboolean | nullable

<para type="description">Specifies if the 'Include Sharepoint' option is enabled or disabled.</para>

includeSharepointstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useIncludeSkypeboolean | nullable

<para type="description">Specifies if the 'Include Skype' option is enabled or disabled.</para>

includeSkypestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useIncludeTeamsboolean | nullable

<para type="description">Specifies if the 'Include Teams' option is enabled or disabled.</para>

includeTeamsstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useMirrorLocalOSTToVHDboolean | nullable

<para type="description">Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.</para>

mirrorLocalOSTToVHDstring · enum

<para type="synopsis">Mirror Local OST-VHD values.</para> <para type="description"></para>

Options: 0 = DoNothing,1 = Copy,2 = Move

useNumSessionVHDsToKeepboolean | nullable

<para type="description">Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.</para>

numSessionVHDsToKeepinteger · int32 | nullable

<para type="description">Specifies the 'Number of Session VHDs to Keep'.</para>

useOutlookFolderPathboolean | nullable

<para type="description">Specifies if the 'Outlook Folder Path' option is enabled or disabled.</para>

outlookFolderPathstring | nullable

<para type="description">Specifies the 'Outlook Folder Path'.</para>

useRefreshUserPolicyboolean | nullable

<para type="description">Specifies if the 'Refresh User Policy' option is enabled or disabled.</para>

refreshUserPolicystring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useVHDAccessModeboolean | nullable

<para type="description">Specifies if the 'VHD Access Mode' option is enabled or disabled.</para>

vhdAccessModestring · enum

<para type="synopsis">VHD Access Mode values.</para> <para type="description"></para>

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

useMaxCacheSizeInMBsboolean | nullable

<para type="description">Specifies if the 'Max cache size in MBs' option is enabled or disabled.</para>

maxCacheSizeInMBsinteger · int32 | nullable

<para type="description">Specifies the 'Max cache size in MBs'.</para>

useClearCacheOnLogoffboolean | nullable

<para type="description">Specifies if the 'Clear cache on logoff' option is enabled or disabled.</para>

clearCacheOnLogoffstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useHealthyProvidersRequiredForRegisterboolean | nullable

<para type="description">Specifies if the 'Healthy providers required for register' option is enabled or disabled.</para>

healthyProvidersRequiredForRegisterinteger · int32 | nullable

<para type="description">Specifies the 'Healthy providers required for register'.</para>

useHealthyProvidersRequiredForUnregisterboolean | nullable

<para type="description">Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.</para>

healthyProvidersRequiredForUnregisterinteger · int32 | nullable

<para type="description">Specifies the 'Healthy providers required for unregister'.</para>

useUnregisterTimeoutboolean | nullable

<para type="description">Specifies if the 'Unregister timeout' option is enabled or disabled.</para>

unregisterTimeoutinteger · int32 | nullable

<para type="description">Specifies the 'Unregister timeout'.</para>

useClearCacheOnForcedUnregisterboolean | nullable

<para type="description">Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.</para>

clearCacheOnForcedUnregisterstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "officeContainerEnabled": true,
    "locationType": [
      "0 = SMBLocation",
      "1 = CloudCache"
    ],
    "vhdLocations": [
      "text"
    ],
    "ccdLocations": [
      "text"
    ],
    "profileDiskFormat": [
      "0 = VHD",
      "1 = VHDX"
    ],
    "allocationType": [
      "0 = Dynamic",
      "1 = Full"
    ],
    "defaultSize": 1,
    "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"
    ],
    "useIncludeOfficeActivation": true,
    "includeOfficeActivation": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneDrive": true,
    "includeOneDrive": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNote": true,
    "includeOneNote": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNoteUWP": true,
    "includeOneNoteUWP": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlook": true,
    "includeOutlook": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlookPersonalization": true,
    "includeOutlookPersonalization": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSharepoint": true,
    "includeSharepoint": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSkype": true,
    "includeSkype": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeTeams": true,
    "includeTeams": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useMirrorLocalOSTToVHD": true,
    "mirrorLocalOSTToVHD": [
      "0 = DoNothing",
      "1 = Copy",
      "2 = Move"
    ],
    "useNumSessionVHDsToKeep": true,
    "numSessionVHDsToKeep": 1,
    "useOutlookFolderPath": true,
    "outlookFolderPath": "text",
    "useRefreshUserPolicy": true,
    "refreshUserPolicy": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDAccessMode": true,
    "vhdAccessMode": [
      "0 = NormalDirectAccess",
      "1 = DiffDiskNetwork",
      "2 = DiffDiskLocal",
      "3 = UniqueVHDPerSession"
    ],
    "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"
    ]
  }'

204

401

404

No body

No Content

Get

Retrieves the FSLogix General Settings of a session server with the specified ID.

get

/api/VDI/HostPool/{id}/FSLogix/General

Path parameters

idinteger · int32required

The ID of a session server for which to retrieve the FSLogix General Settings.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/General'

200

401

404

{
  "appServices": {
    "useCleanupInvalidSessions": true,
    "cleanupInvalidSessions": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamRecycleBin": true,
    "roamRecycleBin": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDCompactDisk": true,
    "vhdCompactDisk": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "cloudCacheGeneral": {
    "useCacheDirectory": true,
    "cacheDirectory": "text",
    "useWriteCacheDirectory": true,
    "writeCacheDirectory": "text",
    "useProxyDirectory": true,
    "proxyDirectory": "text",
    "useSilenceACLWarning": true,
    "silenceACLWarning": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "logging": {
    "logEnabled": [
      "0 = Disable",
      "1 = Specific",
      "2 = All"
    ],
    "logLevel": [
      "0 = Debug",
      "1 = Information",
      "2 = Warning",
      "3 = Error"
    ],
    "logFileKeepingPeriod": 1,
    "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"
    ]
  }
}

Success

Update

Update the FSLogix General Settings of a session server with the specified ID.

put

/api/VDI/HostPool/{id}/FSLogix/General

Path parameters

idinteger · int32required

The ID of a session server for which to modify the FSLogix General Settings.

Body

useCleanupInvalidSessionsboolean | nullable

<para type="description">Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.</para>

cleanupInvalidSessionsstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useRoamRecycleBinboolean | nullable

<para type="description">Specifies if the 'Roam recycle bin' option is enabled or disabled.</para>

roamRecycleBinstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useVHDCompactDiskboolean | nullable

<para type="description">Specifies if the 'VHD compact disk' option is enabled or disabled.</para>

vhdCompactDiskstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useCacheDirectoryboolean | nullable

<para type="description">Specifies if the 'Cache directory' option is enabled or disabled.</para>

cacheDirectorystring | nullable

<para type="description">Specifies the 'Cache directory'.</para>

useWriteCacheDirectoryboolean | nullable

<para type="description">Specifies if the 'Write cache directory' option is enabled or disabled.</para>

writeCacheDirectorystring | nullable

<para type="description">Specifies the 'Write cache directory'.</para>

useProxyDirectoryboolean | nullable

<para type="description">Specifies if the 'Proxy directory' option is enabled or disabled.</para>

proxyDirectorystring | nullable

<para type="description">Specifies the 'Proxy directory'.</para>

useSilenceACLWarningboolean | nullable

<para type="description">Specifies if the 'Silence ACL warning' option is enabled or disabled.</para>

silenceACLWarningstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

logEnabledstring · enum

<para type="synopsis">Log enabled values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Specific,2 = All

logLevelstring · enum

<para type="synopsis">FSLogix log level values.</para> <para type="description"></para>

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

logFileKeepingPeriodinteger · int32 | nullable

<para type="description">Specifies the 'Log keeping period in days'. Default: '2'.</para>

logDirectorystring | nullable

<para type="description">Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.</para>

robocopyLogPathstring | nullable

<para type="description">Specifies the 'Robocopy log path'.</para>

logSpecificComponentsstring[Flag] · enum

<para type="synopsis">Log specific components values.</para> <para type="description"></para>

Options:

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/VDI/HostPool/{id}/FSLogix/General' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "useCleanupInvalidSessions": true,
    "cleanupInvalidSessions": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamRecycleBin": true,
    "roamRecycleBin": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDCompactDisk": true,
    "vhdCompactDisk": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useCacheDirectory": true,
    "cacheDirectory": "text",
    "useWriteCacheDirectory": true,
    "writeCacheDirectory": "text",
    "useProxyDirectory": true,
    "proxyDirectory": "text",
    "useSilenceACLWarning": true,
    "silenceACLWarning": [
      "0 = Disable",
      "1 = Enable"
    ],
    "logEnabled": [
      "0 = Disable",
      "1 = Specific",
      "2 = All"
    ],
    "logLevel": [
      "0 = Debug",
      "1 = Information",
      "2 = Warning",
      "3 = Error"
    ],
    "logFileKeepingPeriod": 1,
    "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"
    ]
  }'

204

401

404

No body

No Content

Get

Retrieves FSLogix Office Container VHDLocation List of a session server with the specified ID.

get

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/VHDLocations

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/VHDLocations'

200

401

404

[
  "text"
]

Success

Add

Add a folder to the VHDLocation List of the FSLogix Office Container settings.

post

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/VHDLocations

Path parameters

idinteger · int32required

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

Body

vhdLocationstring | nullablerequired

<para type="description">Specifies the 'VHDLocation' path to add to the VHDLocation List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/VHDLocations' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "vhdLocation": "text"
  }'

201

401

404

409

No body

Created

Remove

Remove a folder from the VHDLocation List of the FSLogix Office Container settings.

delete

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/VHDLocations

Path parameters

idinteger · int32required

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

Body

vhdLocationstring | nullablerequired

<para type="description">Specifies the 'VHDLocation' path to remove from the VHDLocation List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/VHDLocations' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "vhdLocation": "text"
  }'

204

401

404

No body

No Content

Get

Retrieves FSLogix Office Container User Inclusion List of a session server with the specified ID.

get

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion'

200

401

404

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

Success

Add

Add a user to the User Inclusion List of the FSLogix Office Container settings.

post

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion

Path parameters

idinteger · int32required

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

Body

accountstring | nullable

<para type="description">The name of the user/group account to add to the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to add to the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

201

401

404

409

No body

Created

Remove

Remove a user from the User Inclusion List of the FSLogix Office Container settings.

delete

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion

Path parameters

idinteger · int32required

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

Body

accountstring | nullable

<para type="description">The name of the user/group account to remove from the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to remove from the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

204

401

404

No body

No Content

Get

Retrieves FSLogix Office Container User Exclusion List of a session server with the specified ID.

get

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserExclusion

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserExclusion'

200

401

404

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

Success

Add

Add a user to the User Exclusion List of the FSLogix Office Container settings.

post

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserExclusion

Path parameters

idinteger · int32required

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

Body

accountstring | nullable

<para type="description">The name of the user/group account to add to the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to add to the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

201

401

404

409

No body

Created

Remove

Remove a user from the User Exclusion List of the FSLogix Office Container settings.

delete

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserExclusion

Path parameters

idinteger · int32required

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

Body

accountstring | nullable

<para type="description">The name of the user/group account to remove from the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to remove from the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/UserExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

204

401

404

No body

No Content

Get

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

get

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer'

200

401

404

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

Success

Update

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

put

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer

Path parameters

idinteger · int32required

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

Body

profileContainerEnabledboolean | nullable

<para type="description">Specifies if the Profile Container is enabled or disabled..</para>

locationTypestring · enum

<para type="synopsis">Location Type values.</para> <para type="description"></para>

Options: 0 = SMBLocation,1 = CloudCache

vhdLocationsstring[] | nullable

<para type="description">Specifies the 'VHD Locations'.</para>

ccdLocationsstring[] | nullable

<para type="description">Specifies the 'CDD Locations'.</para>

profileDiskFormatstring · enum

<para type="synopsis">Profile Disk Format values.</para> <para type="description"></para>

Options: 0 = VHD,1 = VHDX

allocationTypestring · enum

<para type="synopsis">Allocation Type values.</para> <para type="description"></para>

Options: 0 = Dynamic,1 = Full

defaultSizeinteger · int32 | nullable

<para type="description">Specifies the 'Default size'.</para>

customizeProfileFoldersboolean | nullable

<para type="description">Enable or disable the 'Customize Profile Folders' option.</para>

excludeCommonFoldersstring[Flag] · enum

<para type="synopsis">Exclude Common Folders.</para> <para type="description"></para>

Options:

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

useLockedRetryCountboolean | nullable

<para type="description">Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.</para>

lockedRetryCountinteger · int32 | nullable

<para type="description">Specifies the 'Number of locked VHD(X) retries'.</para>

useLockedRetryIntervalboolean | nullable

<para type="description">Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.</para>

lockedRetryIntervalinteger · int32 | nullable

<para type="description">Specifies the 'Delay between locked VHD(X) retries'.</para>

useAccessNetworkAsComputerObjectboolean | nullable

<para type="description">Specifies if the 'Access network as computer object' option is enabled or disabled.</para>

accessNetworkAsComputerObjectstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useAttachVHDSDDLboolean | nullable

<para type="description">Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.</para>

attachVHDSDDLstring | nullable

<para type="description">Specifies the 'SDDL used when attaching the VHD'.</para>

useDiffDiskParentFolderPathboolean | nullable

<para type="description">Specifies if the 'Diff disk parent folder path' option is enabled or disabled.</para>

diffDiskParentFolderPathstring | nullable

<para type="description">Specifies the 'Diff disk parent folder path'.</para>

useFlipFlopProfileDirectoryNameboolean | nullable

<para type="description">Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.</para>

flipFlopProfileDirectoryNamestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useNoProfileContainingFolderboolean | nullable

<para type="description">Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.</para>

noProfileContainingFolderstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useOutlookCachedModeboolean | nullable

<para type="description">Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.</para>

outlookCachedModestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

usePreventLoginWithFailureboolean | nullable

<para type="description">Specifies if the 'Prevent logons with failures' option is enabled or disabled.</para>

preventLoginWithFailurestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

usePreventLoginWithTempProfileboolean | nullable

<para type="description">Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.</para>

preventLoginWithTempProfilestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useReAttachRetryCountboolean | nullable

<para type="description">Specifies if the 'Re-attach retry limit' option is enabled or disabled.</para>

reAttachRetryCountinteger · int32 | nullable

<para type="description">Specifies the 'Re-attach retry limit'.</para>

useReAttachIntervalSecondsboolean | nullable

<para type="description">Specifies if the 'Re-attach interval' option is enabled or disabled.</para>

reAttachIntervalSecondsinteger · int32 | nullable

<para type="description">Specifies the 'Re-attach interval'.</para>

useRemoveOrphanedOSTFilesOnLogoffboolean | nullable

<para type="description">Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.</para>

removeOrphanedOSTFilesOnLogoffstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useRoamSearchboolean | nullable

<para type="description">Specifies if the 'Search roaming feature mode' option is enabled or disabled.</para>

roamSearchstring · enum

<para type="synopsis">Roam search values.</para> <para type="description"></para>

Options: 0 = Disable,1 = SingleUser,2 = MultiUser

useSIDDirNameMatchboolean | nullable

<para type="description">Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.</para>

sidDirNameMatchstring | nullable

<para type="description">Specifies the 'User-to-Profile matching pattern'.</para>

useSIDDirNamePatternboolean | nullable

<para type="description">Specifies if the 'Profile folder naming pattern' option is enabled or disabled.</para>

sidDirNamePatternstring | nullable

<para type="description">Specifies the 'Profile folder naming pattern'.</para>

useSIDDirSDDLboolean | nullable

<para type="description">Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.</para>

sidDirSDDLstring | nullable

<para type="description">Specifies the 'Use SSDL on creation of SID container folder'.</para>

useVHDNameMatchboolean | nullable

<para type="description">Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.</para>

vhdNameMatchstring | nullable

<para type="description">Specifies the 'Profile VHD(X) file matching pattern'.</para>

useVHDNamePatternboolean | nullable

<para type="description">Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.</para>

vhdNamePatternstring | nullable

<para type="description">Specifies the 'Naming pattern for new VHD(X) files'.</para>

useVHDXSectorSizeboolean | nullable

<para type="description">Specifies if the 'VHDX sector size' option is enabled or disabled.</para>

vhdxSectorSizestring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = SystemDefault,512 = Size_512,4096 = Size_4096

useVolumeWaitTimeMSboolean | nullable

<para type="description">Specifies if the 'Volume wait time' option is enabled or disabled.</para>

volumeWaitTimeMSinteger · int32 | nullable

<para type="description">Specifies the 'Volume wait time'.</para>

useIgnoreNonAVDboolean | nullable

<para type="description">Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).</para>

ignoreNonAVDstring · enum

<para type="synopsis">Ignore non-AVD values.</para> <para type="description"></para>

Options: 0 = AnySession,1 = AVDSessions

useRedirectTypeboolean | nullable

<para type="description">Specifies if the 'Redirect type' option is enabled or disabled.</para>

redirectTypestring · enum

<para type="synopsis">Redirect type values.</para> <para type="description"></para>

Options: 1 = Legacy,2 = Advanced

useKeepLocalDirboolean | nullable

<para type="description">Specifies if the 'Keep local profiles' option is enabled or disabled.</para>

keepLocalDirstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useDeleteLocalProfileWhenVHDShouldApplyboolean | nullable

<para type="description">Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.</para>

deleteLocalProfileWhenVHDShouldApplystring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useProfileDirSDDLboolean | nullable

<para type="description">Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.</para>

profileDirSDDLstring | nullable

<para type="description">Specifies the 'Custom SDDL for profile directory'.</para>

useProfileTypeboolean | nullable

<para type="description">Specifies if the 'Profile type' option is enabled or disabled.</para>

profileTypestring · enum

<para type="synopsis">Profile Type values.</para> <para type="description"></para>

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

useSetTempToLocalPathboolean | nullable

<para type="description">Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.</para>

setTempToLocalPathstring · enum

<para type="synopsis">Temporary Folder Redirection Mode values.</para> <para type="description"></para>

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

useCleanOutNotificationsboolean | nullable

<para type="description">Specifies if the 'Clean out notifications' option is enabled or disabled.</para>

cleanOutNotificationsstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useInstallAppxPackagesboolean | nullable

<para type="description">Specifies if the Install Appx packages' option is enabled or disabled.</para>

installAppxPackagesstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useRebootOnUserLogoffboolean | nullable

<para type="description">Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.</para>

rebootOnUserLogoffstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useRoamIdentityboolean | nullable

<para type="description">Specifies if the 'Roam identity' option is enabled or disabled.</para>

roamIdentitystring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useShutdownOnUserLogoffboolean | nullable

<para type="description">Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.</para>

shutdownOnUserLogoffstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useMaxCacheSizeInMBsboolean | nullable

<para type="description">Specifies if the 'Max cache size in MBs' option is enabled or disabled.</para>

maxCacheSizeInMBsinteger · int32 | nullable

<para type="description">Specifies the 'Max cache size in MBs'.</para>

useClearCacheOnLogoffboolean | nullable

<para type="description">Specifies if the 'Clear cache on logoff' option is enabled or disabled.</para>

clearCacheOnLogoffstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

useHealthyProvidersRequiredForRegisterboolean | nullable

<para type="description">Specifies if the 'Healthy providers required for register' option is enabled or disabled.</para>

healthyProvidersRequiredForRegisterinteger · int32 | nullable

<para type="description">Specifies the 'Healthy providers required for register'.</para>

useHealthyProvidersRequiredForUnregisterboolean | nullable

<para type="description">Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.</para>

healthyProvidersRequiredForUnregisterinteger · int32 | nullable

<para type="description">Specifies the 'Healthy providers required for unregister'.</para>

useUnregisterTimeoutboolean | nullable

<para type="description">Specifies if the 'Unregister timeout' option is enabled or disabled.</para>

unregisterTimeoutinteger · int32 | nullable

<para type="description">Specifies the 'Unregister timeout'.</para>

useClearCacheOnForcedUnregisterboolean | nullable

<para type="description">Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.</para>

clearCacheOnForcedUnregisterstring · enum

<para type="synopsis">Enable State values.</para> <para type="description"></para>

Options: 0 = Disable,1 = Enable

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "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"
    ]
  }'

204

401

404

No body

No Content

Get

Retrieves FSLogix Office Container CCDLocation List of a session server with the specified ID.

get

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/CCDLocations

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/CCDLocations'

200

401

404

[
  "text"
]

Success

Add

Add a folder to the CCDLocation List of the FSLogix Office Container settings.

post

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/CCDLocations

Path parameters

idinteger · int32required

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

Body

ccdLocationstring | nullablerequired

<para type="description">Specifies the 'CCDLocation' path to add to the CCDLocation List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/CCDLocations' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "ccdLocation": "text"
  }'

201

401

404

409

No body

Created

Remove

Remove a folder from the CCDLocation List of the FSLogix Office Container settings.

delete

/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/CCDLocations

Path parameters

idinteger · int32required

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

Body

ccdLocationstring | nullablerequired

<para type="description">Specifies the 'CCDLocation' path to remove from the CCDLocation List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/FSLogix/OfficeContainer/CCDLocations' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "ccdLocation": "text"
  }'

204

401

404

No body

No Content

Get

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

get

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/CCDLocations

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/CCDLocations'

200

401

404

[
  "text"
]

Success

Add

Add a folder to the CCDLocation List of the FSLogix Profile Container settings.

post

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/CCDLocations

Path parameters

idinteger · int32required

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

Body

ccdLocationstring | nullablerequired

<para type="description">Specifies the 'CCDLocation' path to add to the CCDLocation List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/CCDLocations' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "ccdLocation": "text"
  }'

201

401

404

409

No body

Created

Delete

Remove a folder from the CCDLocation List of the FSLogix Profile Container settings.

delete

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/CCDLocations

Path parameters

idinteger · int32required

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

Body

ccdLocationstring | nullablerequired

<para type="description">Specifies the 'CCDLocation' path to remove from the CCDLocation List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/CCDLocations' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "ccdLocation": "text"
  }'

204

401

404

No body

No Content

Get

Retrieve FSLogix Profile Container User Inclusion List of a session server with the specified ID.

get

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserInclusion

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserInclusion'

200

401

404

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

Success

Add

Add a user to the User Inclusion List of the FSLogix Profile Container settings.

post

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserInclusion

Path parameters

idinteger · int32required

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

Body

accountstring | nullable

<para type="description">The name of the user/group account to add to the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to add to the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserInclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

201

401

404

409

No body

Created

Delete

Remove a user from the User Inclusion List of the FSLogix Profile Container settings.

delete

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserInclusion

Path parameters

idinteger · int32required

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

Body

accountstring | nullable

<para type="description">The name of the user/group account to remove from the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to remove from the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserInclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

204

401

404

No body

No Content

Get

Retrieve FSLogix Profile Container Folder Exclusion List of a session server with the specified ID.

get

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion'

200

401

404

[
  "text"
]

Success

Add

Add a folder to the Folder Exclusion List of the FSLogix Profile Container settings.

post

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion

Path parameters

idinteger · int32required

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

Body

folderstring | nullablerequired

<para type="description">Specifies the 'Folder' path to add to the Include/Exclude Folder List.</para>

excludeFolderCopystring[Flag] · enum

<para type="synopsis">Exclude Folder Copy values.</para> <para type="description"></para>

Options: 0 = None,1 = CopyBase,2 = CopyBack

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "folder": "text",
    "excludeFolderCopy": [
      "0 = None",
      "1 = CopyBase",
      "2 = CopyBack"
    ]
  }'

201

401

404

409

No body

Created

Update

Modify an item in the folder exclusion list of the FSLogix Profile Container settings.

put

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion

Path parameters

idinteger · int32required

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

Body

folderstring | nullablerequired

<para type="description">Specifies the 'Folder' path to modify within Exclude Folder List.</para>

excludeFolderCopystring[Flag] · enumrequired

<para type="synopsis">Exclude Folder Copy values.</para> <para type="description"></para>

Options: 0 = None,1 = CopyBase,2 = CopyBack

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "folder": "text",
    "excludeFolderCopy": [
      "0 = None",
      "1 = CopyBase",
      "2 = CopyBack"
    ]
  }'

201

401

404

409

No body

Created

Delete

Remove a folder from the Folder Exclusion List of the FSLogix Profile Container settings.

delete

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion

Path parameters

idinteger · int32required

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

Body

folderstring | nullablerequired

<para type="description">Specifies the 'Folder' path to remove to the Include/Exclude Folder List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "folder": "text"
  }'

204

401

404

No body

No Content

Get

Retrieve FSLogix Profile Container User Exclusion List of a session server with the specified ID.

get

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion'

200

401

404

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

Success

Add

Add a user to the User Exclusion List of the FSLogix Profile Container settings.

post

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion

Path parameters

idinteger · int32required

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

Body

accountstring | nullable

<para type="description">The name of the user/group account to add to the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to add to the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

201

401

404

409

No body

Created

Delete

Remove a user from the User Exclusion List of the FSLogix Profile Container settings.

delete

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion

Path parameters

idinteger · int32required

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

Body

accountstring | nullable

<para type="description">The name of the user/group account to remove from the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to remove from the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

204

401

404

No body

No Content

Get

Retrieve FSLogix Profile Container Folder Inclusion List of a session server with the specified ID.

get

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderInclusion

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderInclusion'

200

401

404

[
  "text"
]

Success

Add

Add a folder to the Folder Inclusion List of the FSLogix Profile Container settings.

post

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderInclusion

Path parameters

idinteger · int32required

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

Body

folderstring | nullablerequired

<para type="description">Specifies the 'Folder' path to add to the Include/Exclude Folder List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderInclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "folder": "text"
  }'

201

401

404

409

No body

Created

Delete

Remove a folder from the Folder Inclusion List of the FSLogix Profile Container settings.

delete

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderInclusion

Path parameters

idinteger · int32required

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

Body

folderstring | nullablerequired

<para type="description">Specifies the 'Folder' path to remove to the Include/Exclude Folder List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/FolderInclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "folder": "text"
  }'

204

401

404

No body

No Content

Get

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

get

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/VHDLocations

Path parameters

idinteger · int32required

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/VHDLocations'

200

401

404

[
  "text"
]

Success

Add

Add a folder to the VHDLocation List of the FSLogix Profile Container settings.

post

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/VHDLocations

Path parameters

idinteger · int32required

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

Body

vhdLocationstring | nullablerequired

<para type="description">Specifies the 'VHDLocation' path to add to the VHDLocation List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/VHDLocations' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "vhdLocation": "text"
  }'

201

401

404

409

No body

Created

Delete

Remove a folder from the VHDLocation List of the FSLogix Profile Container settings.

delete

/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/VHDLocations

Path parameters

idinteger · int32required

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

Body

vhdLocationstring | nullablerequired

<para type="description">Specifies the 'VHDLocation' path to remove from the VHDLocation List.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/VDI/HostPool/{id}/FSLogix/ProfileContainer/VHDLocations' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "vhdLocation": "text"
  }'

204

401

404

No body

No Content