OfficeContainer

PreviousGeneral NextCCDLocations

Was this helpful?

Get

get

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

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

put

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

Path parameters

idinteger · int32required

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

Body

officeContainerEnabledboolean | nullableoptional

Specifies if the Office Container is enabled or disabled.

locationTypestring · enumoptional

Location Type values.

Options: 0 = SMBLocation,1 = CloudCache

vhdLocationsstring[] | nullableoptional

Specifies the 'VHD Locations'.

ccdLocationsstring[] | nullableoptional

Specifies the 'CDD Locations'.

profileDiskFormatstring · enumoptional

Profile Disk Format values.

Options: 0 = VHD,1 = VHDX

allocationTypestring · enumoptional

Allocation Type values.

Options: 0 = Dynamic,1 = Full

defaultSizeinteger · int32 | nullableoptional

Specifies the 'Default size'.

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.

Options: 0 = Disable,1 = Enable

useAttachVHDSDDLboolean | nullableoptional

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

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

Options: 0 = Disable,1 = Enable

useNoProfileContainingFolderboolean | nullableoptional

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

noProfileContainingFolderstring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

useOutlookCachedModeboolean | nullableoptional

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

outlookCachedModestring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

usePreventLoginWithFailureboolean | nullableoptional

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

preventLoginWithFailurestring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

usePreventLoginWithTempProfileboolean | nullableoptional

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

preventLoginWithTempProfilestring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

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.

Options: 0 = Disable,1 = Enable

useRoamSearchboolean | nullableoptional

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

roamSearchstring · enumoptional

Roam search values.

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

useSIDDirNameMatchboolean | nullableoptional

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

sidDirNameMatchstring | nullableoptional

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

useSIDDirNamePatternboolean | nullableoptional

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

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

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

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.

Options: 0 = AnySession,1 = AVDSessions

useRedirectTypeboolean | nullableoptional

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

redirectTypestring · enumoptional

Redirect type values.

Options: 1 = Legacy,2 = Advanced

useIncludeOfficeActivationboolean | nullableoptional

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

includeOfficeActivationstring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

useIncludeOneDriveboolean | nullableoptional

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

includeOneDrivestring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

useIncludeOneNoteboolean | nullableoptional

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

includeOneNotestring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

useIncludeOneNoteUWPboolean | nullableoptional

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

includeOneNoteUWPstring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

useIncludeOutlookboolean | nullableoptional

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

includeOutlookstring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

useIncludeOutlookPersonalizationboolean | nullableoptional

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

includeOutlookPersonalizationstring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

useIncludeSharepointboolean | nullableoptional

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

includeSharepointstring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

useIncludeSkypeboolean | nullableoptional

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

includeSkypestring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

useIncludeTeamsboolean | nullableoptional

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

includeTeamsstring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

useMirrorLocalOSTToVHDboolean | nullableoptional

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

mirrorLocalOSTToVHDstring · enumoptional

Mirror Local OST-VHD values.

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

useNumSessionVHDsToKeepboolean | nullableoptional

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

numSessionVHDsToKeepinteger · int32 | nullableoptional

Specifies the 'Number of Session VHDs to Keep'.

useOutlookFolderPathboolean | nullableoptional

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

outlookFolderPathstring | nullableoptional

Specifies the 'Outlook Folder Path'.

useRefreshUserPolicyboolean | nullableoptional

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

refreshUserPolicystring · enumoptional

Enable State values.

Options: 0 = Disable,1 = Enable

useVHDAccessModeboolean | nullableoptional

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

vhdAccessModestring · enumoptional

VHD Access Mode values.

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

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.

Options: 0 = Disable,1 = Enable

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.

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