# Office Container

## Get

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

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/AVD/HostPool/{id}/FSLogix/OfficeContainer":{"get":{"tags":["0-Infrastructure/AVD/Host Pool/FSLogix//Office Container"],"summary":"Get","description":"Retrieves the FSLogix Office Container settings of a session server with the specified ID.","operationId":"8e8811d1-933c-420f-a702-60949d67d012","parameters":[{"name":"id","in":"path","description":"The ID of a session server for which to retrieve the FSLogix Office Container settings.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/OfficeContainerSettings"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"OfficeContainerSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Specifies if the Container is enabled or disabled.</para>"},"locationType":{"$ref":"#/components/schemas/LocationType"},"vhdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'VHD Locations'.</para>","nullable":true},"ccdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'CCDLocations'.</para>","nullable":true},"profileDiskFormat":{"$ref":"#/components/schemas/ProfileDiskFormat"},"allocationType":{"$ref":"#/components/schemas/AllocationType"},"defaultSize":{"type":"integer","description":"<para type=\"description\">Specifies the 'Default size'.</para>","format":"int32"},"userInclusionList":{"type":"array","items":{"$ref":"#/components/schemas/UserFilter"},"description":"<para type=\"description\">Specifies the 'User Inclusion List'.</para>","nullable":true},"userExclusionList":{"type":"array","items":{"$ref":"#/components/schemas/UserFilter"},"description":"<para type=\"description\">Specifies the 'User Exclusion List'.</para>","nullable":true},"cloudCache":{"$ref":"#/components/schemas/CloudCacheSettings"},"advancedSettings":{"$ref":"#/components/schemas/OfficeContainerAdvancedSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Office Container Settings</para>\r\n<para type=\"description\"></para>"},"LocationType":{"enum":[["0 = SMBLocation","1 = CloudCache"]],"type":"string","description":"<para type=\"synopsis\">Location Type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProfileDiskFormat":{"enum":[["0 = VHD","1 = VHDX"]],"type":"string","description":"<para type=\"synopsis\">Profile Disk Format values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"AllocationType":{"enum":[["0 = Dynamic","1 = Full"]],"type":"string","description":"<para type=\"synopsis\">Allocation Type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"UserFilter":{"type":"object","properties":{"account":{"type":"string","description":"<para type=\"description\">The name of the user/group account the filter is added to.</para>","nullable":true},"type":{"$ref":"#/components/schemas/UserType"},"sid":{"type":"string","description":"<para type=\"description\">The SID of the user/group account the filter is added to.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">User filter</para>\r\n<para type=\"description\"></para>"},"UserType":{"enum":[["1 = User","2 = Group","3 = ForeignSecurityPrincipal","4 = Computer"]],"type":"string","description":"<para type=\"synopsis\">User Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"CloudCacheSettings":{"type":"object","properties":{"useMaxCacheSizeInMBs":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Max cache size in MBs' option is enabled or disabled.</para>"},"maxCacheSizeInMBs":{"type":"integer","description":"<para type=\"description\">Specifies the 'Max cache size in MBs'.</para>","format":"int32"},"useClearCacheOnLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Clear cache on logoff' option is enabled or disabled.</para>"},"clearCacheOnLogoff":{"$ref":"#/components/schemas/EnableState"},"useHealthyProvidersRequiredForRegister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Healthy providers required for register' option is enabled or disabled.</para>"},"healthyProvidersRequiredForRegister":{"type":"integer","description":"<para type=\"description\">Specifies the 'Healthy providers required for register'.</para>","format":"int32"},"useHealthyProvidersRequiredForUnregister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.</para>"},"healthyProvidersRequiredForUnregister":{"type":"integer","description":"<para type=\"description\">Specifies the 'Healthy providers required for unregister'.</para>","format":"int32"},"useUnregisterTimeout":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Unregister timeout' option is enabled or disabled.</para>"},"unregisterTimeout":{"type":"integer","description":"<para type=\"description\">Specifies the 'Unregister timeout'.</para>","format":"int32"},"useClearCacheOnForcedUnregister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.</para>"},"clearCacheOnForcedUnregister":{"$ref":"#/components/schemas/EnableState"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Cloud Cache Settings</para>\r\n<para type=\"description\"></para>"},"EnableState":{"enum":[["0 = Disable","1 = Enable"]],"type":"string","description":"<para type=\"synopsis\">Enable State values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"OfficeContainerAdvancedSettings":{"type":"object","properties":{"useLockedRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.</para>"},"lockedRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Number of locked VHD(X) retries'.</para>","format":"int32"},"useLockedRetryInterval":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.</para>"},"lockedRetryInterval":{"type":"integer","description":"<para type=\"description\">Specifies the 'Delay between locked VHD(X) retries'.</para>","format":"int32"},"useAccessNetworkAsComputerObject":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Access network as computer object' option is enabled or disabled.</para>"},"accessNetworkAsComputerObject":{"$ref":"#/components/schemas/EnableState"},"useAttachVHDSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.</para>"},"attachVHDSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'SDDL used when attaching the VHD'.</para>","nullable":true},"useDiffDiskParentFolderPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Diff disk parent folder path' option is enabled or disabled.</para>"},"diffDiskParentFolderPath":{"type":"string","description":"<para type=\"description\">Specifies the 'Diff disk parent folder path'.</para>","nullable":true},"useFlipFlopProfileDirectoryName":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.</para>"},"flipFlopProfileDirectoryName":{"$ref":"#/components/schemas/EnableState"},"useNoProfileContainingFolder":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.</para>"},"noProfileContainingFolder":{"$ref":"#/components/schemas/EnableState"},"useOutlookCachedMode":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.</para>"},"outlookCachedMode":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithFailure":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with failures' option is enabled or disabled.</para>"},"preventLoginWithFailure":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithTempProfile":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.</para>"},"preventLoginWithTempProfile":{"$ref":"#/components/schemas/EnableState"},"useReAttachRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach retry limit' option is enabled or disabled.</para>"},"reAttachRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach retry limit'.</para>","format":"int32"},"useReAttachIntervalSeconds":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach interval' option is enabled or disabled.</para>"},"reAttachIntervalSeconds":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach interval'.</para>","format":"int32"},"useRemoveOrphanedOSTFilesOnLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.</para>"},"removeOrphanedOSTFilesOnLogoff":{"$ref":"#/components/schemas/EnableState"},"useRoamSearch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Search roaming feature mode' option is enabled or disabled.</para>"},"roamSearch":{"$ref":"#/components/schemas/RoamSearch"},"useSIDDirNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.</para>"},"sidDirNameMatch":{"type":"string","description":"<para type=\"description\">Specifies the 'User-to-Profile matching pattern'.</para>","nullable":true},"useSIDDirNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile folder naming pattern' option is enabled or disabled.</para>"},"sidDirNamePattern":{"type":"string","description":"<para type=\"description\">Specifies the 'Profile folder naming pattern'.</para>","nullable":true},"useSIDDirSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.</para>"},"sidDirSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'Use SSDL on creation of SID container folder'.</para>","nullable":true},"useVHDNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.</para>"},"vhdNameMatch":{"type":"string","description":"<para type=\"description\">Specifies the 'Profile VHD(X) file matching pattern'.</para>","nullable":true},"useVHDNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.</para>"},"vhdNamePattern":{"type":"string","description":"<para type=\"description\">Specifies the 'Naming pattern for new VHD(X) files'.</para>","nullable":true},"useVHDXSectorSize":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHDX sector size' option is enabled or disabled.</para>"},"vhdxSectorSize":{"$ref":"#/components/schemas/VHDXSectorSize"},"useVolumeWaitTimeMS":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Volume wait time' option is enabled or disabled.</para>"},"volumeWaitTimeMS":{"type":"integer","description":"<para type=\"description\">Specifies the 'Volume wait time'.</para>","format":"int32"},"useIgnoreNonAVD":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled.</para>"},"ignoreNonAVD":{"$ref":"#/components/schemas/IgnoreNonAVD"},"useRedirectType":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Redirect type' option is enabled or disabled.</para>"},"redirectType":{"$ref":"#/components/schemas/RedirectType"},"useIncludeOfficeActivation":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Office Activation' option is enabled or disabled.</para>"},"includeOfficeActivation":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneDrive":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneDrive' option is enabled or disabled.</para>"},"includeOneDrive":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneNote":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneNote' option is enabled or disabled.</para>"},"includeOneNote":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneNoteUWP":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneNote UWP' option is enabled or disabled.</para>"},"includeOneNoteUWP":{"$ref":"#/components/schemas/EnableState"},"useIncludeOutlook":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Outlook' option is enabled or disabled.</para>"},"includeOutlook":{"$ref":"#/components/schemas/EnableState"},"useIncludeOutlookPersonalization":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Outlook Personalization' option is enabled or disabled.</para>"},"includeOutlookPersonalization":{"$ref":"#/components/schemas/EnableState"},"useIncludeSharepoint":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Sharepoint' option is enabled or disabled.</para>"},"includeSharepoint":{"$ref":"#/components/schemas/EnableState"},"useIncludeTeams":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Teams' option is enabled or disabled.</para>"},"includeTeams":{"$ref":"#/components/schemas/EnableState"},"useMirrorLocalOSTToVHD":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.</para>"},"mirrorLocalOSTToVHD":{"$ref":"#/components/schemas/MirrorLocalOSTToVHD"},"useNumSessionVHDsToKeep":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.</para>"},"numSessionVHDsToKeep":{"type":"integer","description":"<para type=\"description\">Specifies the 'Number of Session VHDs to Keep'.</para>","format":"int32"},"useOutlookFolderPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Outlook Folder Path' option is enabled or disabled.</para>"},"outlookFolderPath":{"type":"string","description":"<para type=\"description\">Specifies the 'Outlook Folder Path'.</para>","nullable":true},"useRefreshUserPolicy":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Refresh User Policy' option is enabled or disabled.</para>"},"refreshUserPolicy":{"$ref":"#/components/schemas/EnableState"},"useVHDAccessMode":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHD Access Mode' option is enabled or disabled.</para>"},"vhdAccessMode":{"$ref":"#/components/schemas/VHDAccessMode"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Office Container Advanced Settings</para>\r\n<para type=\"description\"></para>"},"RoamSearch":{"enum":[["0 = Disable","1 = SingleUser","2 = MultiUser"]],"type":"string","description":"<para type=\"synopsis\">Roam search values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"VHDXSectorSize":{"enum":[["0 = SystemDefault","512 = Size_512","4096 = Size_4096"]],"type":"string","description":"<para type=\"synopsis\">Enable State values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"IgnoreNonAVD":{"enum":[["0 = AnySession","1 = AVDSessions"]],"type":"string","description":"<para type=\"synopsis\">Ignore non-AVD values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"RedirectType":{"enum":[["1 = Legacy","2 = Advanced"]],"type":"string","description":"<para type=\"synopsis\">Redirect type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"MirrorLocalOSTToVHD":{"enum":[["0 = DoNothing","1 = Copy","2 = Move"]],"type":"string","description":"<para type=\"synopsis\">Mirror Local OST-VHD values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"VHDAccessMode":{"enum":[["0 = NormalDirectAccess","1 = DiffDiskNetwork","2 = DiffDiskLocal","3 = UniqueVHDPerSession"]],"type":"string","description":"<para type=\"synopsis\">VHD Access Mode values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Update

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

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/AVD/HostPool/{id}/FSLogix/OfficeContainer":{"put":{"tags":["0-Infrastructure/AVD/Host Pool/FSLogix//Office Container"],"summary":"Update","description":"Update the FSLogix Office Container settings of a session server with the specified ID.","operationId":"58f147f6-ccca-48f6-a177-1581542c14ef","parameters":[{"name":"id","in":"path","description":"The ID of a session server for which to modify the FSLogix Office Container settings.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"FSLogix Office Container settings.","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/SetFSLogixOffice"}}}},"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"SetFSLogixOffice":{"type":"object","properties":{"officeContainerEnabled":{"type":"boolean","description":"<para type=\"description\">Specifies if the Office Container is enabled or disabled.</para>","nullable":true},"locationType":{"$ref":"#/components/schemas/LocationType"},"vhdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'VHD Locations'.</para>","nullable":true},"ccdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'CDD Locations'.</para>","nullable":true},"profileDiskFormat":{"$ref":"#/components/schemas/ProfileDiskFormat"},"allocationType":{"$ref":"#/components/schemas/AllocationType"},"defaultSize":{"type":"integer","description":"<para type=\"description\">Specifies the 'Default size'.</para>","format":"int32","nullable":true},"useLockedRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.</para>","nullable":true},"lockedRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Number of locked VHD(X) retries'.</para>","format":"int32","nullable":true},"useLockedRetryInterval":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.</para>","nullable":true},"lockedRetryInterval":{"type":"integer","description":"<para type=\"description\">Specifies the 'Delay between locked VHD(X) retries'.</para>","format":"int32","nullable":true},"useAccessNetworkAsComputerObject":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Access network as computer object' option is enabled or disabled.</para>","nullable":true},"accessNetworkAsComputerObject":{"$ref":"#/components/schemas/EnableState"},"useAttachVHDSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.</para>","nullable":true},"attachVHDSDDL":{"maxLength":255,"minLength":0,"type":"string","description":"<para type=\"description\">Specifies the 'SDDL used when attaching the VHD'.</para>","nullable":true},"useDiffDiskParentFolderPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Diff disk parent folder path' option is enabled or disabled.</para>","nullable":true},"diffDiskParentFolderPath":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Specifies the 'Diff disk parent folder path'.</para>","nullable":true},"useFlipFlopProfileDirectoryName":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.</para>","nullable":true},"flipFlopProfileDirectoryName":{"$ref":"#/components/schemas/EnableState"},"useNoProfileContainingFolder":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.</para>","nullable":true},"noProfileContainingFolder":{"$ref":"#/components/schemas/EnableState"},"useOutlookCachedMode":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.</para>","nullable":true},"outlookCachedMode":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithFailure":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with failures' option is enabled or disabled.</para>","nullable":true},"preventLoginWithFailure":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithTempProfile":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.</para>","nullable":true},"preventLoginWithTempProfile":{"$ref":"#/components/schemas/EnableState"},"useReAttachRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach retry limit' option is enabled or disabled.</para>","nullable":true},"reAttachRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach retry limit'.</para>","format":"int32","nullable":true},"useReAttachIntervalSeconds":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach interval' option is enabled or disabled.</para>","nullable":true},"reAttachIntervalSeconds":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach interval'.</para>","format":"int32","nullable":true},"useRemoveOrphanedOSTFilesOnLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.</para>","nullable":true},"removeOrphanedOSTFilesOnLogoff":{"$ref":"#/components/schemas/EnableState"},"useRoamSearch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Search roaming feature mode' option is enabled or disabled.</para>","nullable":true},"roamSearch":{"$ref":"#/components/schemas/RoamSearch"},"useSIDDirNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.</para>","nullable":true},"sidDirNameMatch":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Specifies the 'User-to-Profile matching pattern'.</para>","nullable":true},"useSIDDirNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile folder naming pattern' option is enabled or disabled.</para>","nullable":true},"sidDirNamePattern":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Specifies the 'Profile folder naming pattern'.</para>","nullable":true},"useSIDDirSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.</para>","nullable":true},"sidDirSDDL":{"maxLength":255,"minLength":0,"type":"string","description":"<para type=\"description\">Specifies the 'Use SSDL on creation of SID container folder'.</para>","nullable":true},"useVHDNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.</para>","nullable":true},"vhdNameMatch":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Specifies the 'Profile VHD(X) file matching pattern'.</para>","nullable":true},"useVHDNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.</para>","nullable":true},"vhdNamePattern":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Specifies the 'Naming pattern for new VHD(X) files'.</para>","nullable":true},"useVHDXSectorSize":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHDX sector size' option is enabled or disabled.</para>","nullable":true},"vhdxSectorSize":{"$ref":"#/components/schemas/VHDXSectorSize"},"useVolumeWaitTimeMS":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Volume wait time' option is enabled or disabled.</para>","nullable":true},"volumeWaitTimeMS":{"type":"integer","description":"<para type=\"description\">Specifies the 'Volume wait time'.</para>","format":"int32","nullable":true},"useIgnoreNonAVD":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled.</para>","nullable":true},"ignoreNonAVD":{"$ref":"#/components/schemas/IgnoreNonAVD"},"useRedirectType":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Redirect type' option is enabled or disabled.</para>","nullable":true},"redirectType":{"$ref":"#/components/schemas/RedirectType"},"useIncludeOfficeActivation":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Office Activation' option is enabled or disabled.</para>","nullable":true},"includeOfficeActivation":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneDrive":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneDrive' option is enabled or disabled.</para>","nullable":true},"includeOneDrive":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneNote":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneNote' option is enabled or disabled.</para>","nullable":true},"includeOneNote":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneNoteUWP":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneNote UWP' option is enabled or disabled.</para>","nullable":true},"includeOneNoteUWP":{"$ref":"#/components/schemas/EnableState"},"useIncludeOutlook":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Outlook' option is enabled or disabled.</para>","nullable":true},"includeOutlook":{"$ref":"#/components/schemas/EnableState"},"useIncludeOutlookPersonalization":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Outlook Personalization' option is enabled or disabled.</para>","nullable":true},"includeOutlookPersonalization":{"$ref":"#/components/schemas/EnableState"},"useIncludeSharepoint":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Sharepoint' option is enabled or disabled.</para>","nullable":true},"includeSharepoint":{"$ref":"#/components/schemas/EnableState"},"useIncludeTeams":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Teams' option is enabled or disabled.</para>","nullable":true},"includeTeams":{"$ref":"#/components/schemas/EnableState"},"useMirrorLocalOSTToVHD":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.</para>","nullable":true},"mirrorLocalOSTToVHD":{"$ref":"#/components/schemas/MirrorLocalOSTToVHD"},"useNumSessionVHDsToKeep":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.</para>","nullable":true},"numSessionVHDsToKeep":{"type":"integer","description":"<para type=\"description\">Specifies the 'Number of Session VHDs to Keep'.</para>","format":"int32","nullable":true},"useOutlookFolderPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Outlook Folder Path' option is enabled or disabled.</para>","nullable":true},"outlookFolderPath":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Specifies the 'Outlook Folder Path'.</para>","nullable":true},"useRefreshUserPolicy":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Refresh User Policy' option is enabled or disabled.</para>","nullable":true},"refreshUserPolicy":{"$ref":"#/components/schemas/EnableState"},"useVHDAccessMode":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHD Access Mode' option is enabled or disabled.</para>","nullable":true},"vhdAccessMode":{"$ref":"#/components/schemas/VHDAccessMode"},"useMaxCacheSizeInMBs":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Max cache size in MBs' option is enabled or disabled.</para>","nullable":true},"maxCacheSizeInMBs":{"type":"integer","description":"<para type=\"description\">Specifies the 'Max cache size in MBs'.</para>","format":"int32","nullable":true},"useClearCacheOnLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Clear cache on logoff' option is enabled or disabled.</para>","nullable":true},"clearCacheOnLogoff":{"$ref":"#/components/schemas/EnableState"},"useHealthyProvidersRequiredForRegister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Healthy providers required for register' option is enabled or disabled.</para>","nullable":true},"healthyProvidersRequiredForRegister":{"type":"integer","description":"<para type=\"description\">Specifies the 'Healthy providers required for register'.</para>","format":"int32","nullable":true},"useHealthyProvidersRequiredForUnregister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.</para>","nullable":true},"healthyProvidersRequiredForUnregister":{"type":"integer","description":"<para type=\"description\">Specifies the 'Healthy providers required for unregister'.</para>","format":"int32","nullable":true},"useUnregisterTimeout":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Unregister timeout' option is enabled or disabled.</para>","nullable":true},"unregisterTimeout":{"type":"integer","description":"<para type=\"description\">Specifies the 'Unregister timeout'.</para>","format":"int32","nullable":true},"useClearCacheOnForcedUnregister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.</para>","nullable":true},"clearCacheOnForcedUnregister":{"$ref":"#/components/schemas/EnableState"}},"additionalProperties":false},"LocationType":{"enum":[["0 = SMBLocation","1 = CloudCache"]],"type":"string","description":"<para type=\"synopsis\">Location Type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProfileDiskFormat":{"enum":[["0 = VHD","1 = VHDX"]],"type":"string","description":"<para type=\"synopsis\">Profile Disk Format values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"AllocationType":{"enum":[["0 = Dynamic","1 = Full"]],"type":"string","description":"<para type=\"synopsis\">Allocation Type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"EnableState":{"enum":[["0 = Disable","1 = Enable"]],"type":"string","description":"<para type=\"synopsis\">Enable State values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"RoamSearch":{"enum":[["0 = Disable","1 = SingleUser","2 = MultiUser"]],"type":"string","description":"<para type=\"synopsis\">Roam search values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"VHDXSectorSize":{"enum":[["0 = SystemDefault","512 = Size_512","4096 = Size_4096"]],"type":"string","description":"<para type=\"synopsis\">Enable State values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"IgnoreNonAVD":{"enum":[["0 = AnySession","1 = AVDSessions"]],"type":"string","description":"<para type=\"synopsis\">Ignore non-AVD values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"RedirectType":{"enum":[["1 = Legacy","2 = Advanced"]],"type":"string","description":"<para type=\"synopsis\">Redirect type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"MirrorLocalOSTToVHD":{"enum":[["0 = DoNothing","1 = Copy","2 = Move"]],"type":"string","description":"<para type=\"synopsis\">Mirror Local OST-VHD values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"VHDAccessMode":{"enum":[["0 = NormalDirectAccess","1 = DiffDiskNetwork","2 = DiffDiskLocal","3 = UniqueVHDPerSession"]],"type":"string","description":"<para type=\"synopsis\">VHD Access Mode values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.parallels.com/landing/ras-rest-api-guide/api-reference/infrastructure/avd/host-pool/fslogix/office-container.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.