OfficeContainer

Get

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

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

Path parameters

id*integer (int32)

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

Response

200401404

Success

Body

application/json; api-version=1.0

enabledboolean

Specifies if the Container is enabled or disabled.

locationTypeLocationType (enum)

Location Type values.

0 = SMBLocation,1 = CloudCache

vhdLocationsnullable array of string

Specifies the 'VHD Locations'.

ccdLocationsnullable array of string

Specifies the 'CCDLocations'.

profileDiskFormatProfileDiskFormat (enum)

Profile Disk Format values.

0 = VHD,1 = VHDX

allocationTypeAllocationType (enum)

Allocation Type values.

0 = Dynamic,1 = Full

defaultSizeinteger (int32)

Specifies the 'Default size'.

userInclusionListnullable array of UserFilter (object)

Specifies the 'User Inclusion List'.

userExclusionListnullable array of UserFilter (object)

Specifies the 'User Exclusion List'.

cloudCacheCloudCacheSettings (object)

FSLogix Cloud Cache Settings

advancedSettingsOfficeContainerAdvancedSettings (object)

FSLogix Office Container Advanced Settings

Request

JavaScriptCurlPython

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

Response

200401404

{
  "enabled": false,
  "locationType": [
    "0 = SMBLocation",
    "1 = CloudCache"
  ],
  "vhdLocations": [
    "text"
  ],
  "ccdLocations": [
    "text"
  ],
  "profileDiskFormat": [
    "0 = VHD",
    "1 = VHDX"
  ],
  "allocationType": [
    "0 = Dynamic",
    "1 = Full"
  ],
  "defaultSize": 0,
  "userInclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "userExclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "cloudCache": {
    "useMaxCacheSizeInMBs": false,
    "maxCacheSizeInMBs": 0,
    "useClearCacheOnLogoff": false,
    "clearCacheOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useHealthyProvidersRequiredForRegister": false,
    "healthyProvidersRequiredForRegister": 0,
    "useHealthyProvidersRequiredForUnregister": false,
    "healthyProvidersRequiredForUnregister": 0,
    "useUnregisterTimeout": false,
    "unregisterTimeout": 0,
    "useClearCacheOnForcedUnregister": false,
    "clearCacheOnForcedUnregister": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "advancedSettings": {
    "useLockedRetryCount": false,
    "lockedRetryCount": 0,
    "useLockedRetryInterval": false,
    "lockedRetryInterval": 0,
    "useAccessNetworkAsComputerObject": false,
    "accessNetworkAsComputerObject": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useAttachVHDSDDL": false,
    "attachVHDSDDL": "text",
    "useDiffDiskParentFolderPath": false,
    "diffDiskParentFolderPath": "text",
    "useFlipFlopProfileDirectoryName": false,
    "flipFlopProfileDirectoryName": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useNoProfileContainingFolder": false,
    "noProfileContainingFolder": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useOutlookCachedMode": false,
    "outlookCachedMode": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithFailure": false,
    "preventLoginWithFailure": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithTempProfile": false,
    "preventLoginWithTempProfile": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useReAttachRetryCount": false,
    "reAttachRetryCount": 0,
    "useReAttachIntervalSeconds": false,
    "reAttachIntervalSeconds": 0,
    "useRemoveOrphanedOSTFilesOnLogoff": false,
    "removeOrphanedOSTFilesOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamSearch": false,
    "roamSearch": [
      "0 = Disable",
      "1 = SingleUser",
      "2 = MultiUser"
    ],
    "useSIDDirNameMatch": false,
    "sidDirNameMatch": "text",
    "useSIDDirNamePattern": false,
    "sidDirNamePattern": "text",
    "useSIDDirSDDL": false,
    "sidDirSDDL": "text",
    "useVHDNameMatch": false,
    "vhdNameMatch": "text",
    "useVHDNamePattern": false,
    "vhdNamePattern": "text",
    "useVHDXSectorSize": false,
    "vhdxSectorSize": [
      "0 = SystemDefault",
      "512 = Size_512",
      "4096 = Size_4096"
    ],
    "useVolumeWaitTimeMS": false,
    "volumeWaitTimeMS": 0,
    "useIgnoreNonAVD": false,
    "ignoreNonAVD": [
      "0 = AnySession",
      "1 = AVDSessions"
    ],
    "useRedirectType": false,
    "redirectType": [
      "1 = Legacy",
      "2 = Advanced"
    ],
    "useIncludeOfficeActivation": false,
    "includeOfficeActivation": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneDrive": false,
    "includeOneDrive": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNote": false,
    "includeOneNote": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNoteUWP": false,
    "includeOneNoteUWP": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlook": false,
    "includeOutlook": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlookPersonalization": false,
    "includeOutlookPersonalization": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSharepoint": false,
    "includeSharepoint": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSkype": false,
    "includeSkype": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeTeams": false,
    "includeTeams": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useMirrorLocalOSTToVHD": false,
    "mirrorLocalOSTToVHD": [
      "0 = DoNothing",
      "1 = Copy",
      "2 = Move"
    ],
    "useNumSessionVHDsToKeep": false,
    "numSessionVHDsToKeep": 0,
    "useOutlookFolderPath": false,
    "outlookFolderPath": "text",
    "useRefreshUserPolicy": false,
    "refreshUserPolicy": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDAccessMode": false,
    "vhdAccessMode": [
      "0 = NormalDirectAccess",
      "1 = DiffDiskNetwork",
      "2 = DiffDiskLocal",
      "3 = UniqueVHDPerSession"
    ]
  }
}

Update

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

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

Path parameters

id*integer (int32)

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

Body

application/json; api-version=1.0

FSLogix Office Container settings.

officeContainerEnablednullable boolean

Specifies if the Office Container is enabled or disabled.

locationTypeLocationType (enum)

Location Type values.

0 = SMBLocation,1 = CloudCache

vhdLocationsnullable array of string

Specifies the 'VHD Locations'.

ccdLocationsnullable array of string

Specifies the 'CDD Locations'.

profileDiskFormatProfileDiskFormat (enum)

Profile Disk Format values.

0 = VHD,1 = VHDX

allocationTypeAllocationType (enum)

Allocation Type values.

0 = Dynamic,1 = Full

defaultSizenullable integer (int32)

Specifies the 'Default size'.

useLockedRetryCountnullable boolean

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

lockedRetryCountnullable integer (int32)

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

useLockedRetryIntervalnullable boolean

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

lockedRetryIntervalnullable integer (int32)

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

useAccessNetworkAsComputerObjectnullable boolean

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

accessNetworkAsComputerObjectEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useAttachVHDSDDLnullable boolean

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

attachVHDSDDLnullable string

Specifies the 'SDDL used when attaching the VHD'.

useDiffDiskParentFolderPathnullable boolean

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

diffDiskParentFolderPathnullable string

Specifies the 'Diff disk parent folder path'.

useFlipFlopProfileDirectoryNamenullable boolean

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

flipFlopProfileDirectoryNameEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useNoProfileContainingFoldernullable boolean

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

noProfileContainingFolderEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useOutlookCachedModenullable boolean

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

outlookCachedModeEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithFailurenullable boolean

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

preventLoginWithFailureEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

usePreventLoginWithTempProfilenullable boolean

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

preventLoginWithTempProfileEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useReAttachRetryCountnullable boolean

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

reAttachRetryCountnullable integer (int32)

Specifies the 'Re-attach retry limit'.

useReAttachIntervalSecondsnullable boolean

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

reAttachIntervalSecondsnullable integer (int32)

Specifies the 'Re-attach interval'.

useRemoveOrphanedOSTFilesOnLogoffnullable boolean

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

removeOrphanedOSTFilesOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useRoamSearchnullable boolean

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

roamSearchRoamSearch (enum)

Roam search values.

0 = Disable,1 = SingleUser,2 = MultiUser

useSIDDirNameMatchnullable boolean

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

sidDirNameMatchnullable string

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

useSIDDirNamePatternnullable boolean

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

sidDirNamePatternnullable string

Specifies the 'Profile folder naming pattern'.

useSIDDirSDDLnullable boolean

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

sidDirSDDLnullable string

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

useVHDNameMatchnullable boolean

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

vhdNameMatchnullable string

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

useVHDNamePatternnullable boolean

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

vhdNamePatternnullable string

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

useVHDXSectorSizenullable boolean

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

vhdxSectorSizeVHDXSectorSize (enum)

Enable State values.

0 = SystemDefault,512 = Size_512,4096 = Size_4096

useVolumeWaitTimeMSnullable boolean

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

volumeWaitTimeMSnullable integer (int32)

Specifies the 'Volume wait time'.

useIgnoreNonAVDnullable boolean

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

ignoreNonAVDIgnoreNonAVD (enum)

Ignore non-AVD values.

0 = AnySession,1 = AVDSessions

useRedirectTypenullable boolean

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

redirectTypeRedirectType (enum)

Redirect type values.

1 = Legacy,2 = Advanced

useIncludeOfficeActivationnullable boolean

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

includeOfficeActivationEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOneDrivenullable boolean

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

includeOneDriveEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOneNotenullable boolean

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

includeOneNoteEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOneNoteUWPnullable boolean

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

includeOneNoteUWPEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOutlooknullable boolean

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

includeOutlookEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeOutlookPersonalizationnullable boolean

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

includeOutlookPersonalizationEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeSharepointnullable boolean

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

includeSharepointEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeSkypenullable boolean

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

includeSkypeEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useIncludeTeamsnullable boolean

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

includeTeamsEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useMirrorLocalOSTToVHDnullable boolean

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

mirrorLocalOSTToVHDMirrorLocalOSTToVHD (enum)

Mirror Local OST-VHD values.

0 = DoNothing,1 = Copy,2 = Move

useNumSessionVHDsToKeepnullable boolean

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

numSessionVHDsToKeepnullable integer (int32)

Specifies the 'Number of Session VHDs to Keep'.

useOutlookFolderPathnullable boolean

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

outlookFolderPathnullable string

Specifies the 'Outlook Folder Path'.

useRefreshUserPolicynullable boolean

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

refreshUserPolicyEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useVHDAccessModenullable boolean

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

vhdAccessModeVHDAccessMode (enum)

VHD Access Mode values.

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

useMaxCacheSizeInMBsnullable boolean

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

maxCacheSizeInMBsnullable integer (int32)

Specifies the 'Max cache size in MBs'.

useClearCacheOnLogoffnullable boolean

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

clearCacheOnLogoffEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

useHealthyProvidersRequiredForRegisternullable boolean

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

healthyProvidersRequiredForRegisternullable integer (int32)

Specifies the 'Healthy providers required for register'.

useHealthyProvidersRequiredForUnregisternullable boolean

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

healthyProvidersRequiredForUnregisternullable integer (int32)

Specifies the 'Healthy providers required for unregister'.

useUnregisterTimeoutnullable boolean

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

unregisterTimeoutnullable integer (int32)

Specifies the 'Unregister timeout'.

useClearCacheOnForcedUnregisternullable boolean

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

clearCacheOnForcedUnregisterEnableState (enum)

Enable State values.

0 = Disable,1 = Enable

Response

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

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