OfficeContainer | Parallels REST API

Parallels REST API

SupportDocumentation

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

objectOptional

FSLogix Office Container Settings

application/json; api-version=1.0

get

GET /api/RDS/Host/{id}/FSLogix/OfficeContainer HTTP/1.1
Host: 
Accept: */*

{
  "enabled": true,
  "locationType": [
    "0 = SMBLocation",
    "1 = CloudCache"
  ],
  "vhdLocations": [
    "text"
  ],
  "ccdLocations": [
    "text"
  ],
  "profileDiskFormat": [
    "0 = VHD",
    "1 = VHDX"
  ],
  "allocationType": [
    "0 = Dynamic",
    "1 = Full"
  ],
  "defaultSize": 1,
  "userInclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "userExclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "cloudCache": {
    "useMaxCacheSizeInMBs": true,
    "maxCacheSizeInMBs": 1,
    "useClearCacheOnLogoff": true,
    "clearCacheOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useHealthyProvidersRequiredForRegister": true,
    "healthyProvidersRequiredForRegister": 1,
    "useHealthyProvidersRequiredForUnregister": true,
    "healthyProvidersRequiredForUnregister": 1,
    "useUnregisterTimeout": true,
    "unregisterTimeout": 1,
    "useClearCacheOnForcedUnregister": true,
    "clearCacheOnForcedUnregister": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "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"
    ]
  }
}

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.

Available options:

vhdLocationsstring[] | nullableOptional

Specifies the 'VHD Locations'.

ccdLocationsstring[] | nullableOptional

Specifies the 'CDD Locations'.

profileDiskFormatstring · enumOptional

Profile Disk Format values.

Available options:

allocationTypestring · enumOptional

Allocation Type values.

Available options:

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.

Available options:

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.

Available options:

useNoProfileContainingFolderboolean | nullableOptional

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

noProfileContainingFolderstring · enumOptional

Enable State values.

Available options:

useOutlookCachedModeboolean | nullableOptional

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

outlookCachedModestring · enumOptional

Enable State values.

Available options:

usePreventLoginWithFailureboolean | nullableOptional

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

preventLoginWithFailurestring · enumOptional

Enable State values.

Available options:

usePreventLoginWithTempProfileboolean | nullableOptional

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

preventLoginWithTempProfilestring · enumOptional

Enable State values.

Available options:

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.

Available options:

useRoamSearchboolean | nullableOptional

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

roamSearchstring · enumOptional

Roam search values.

Available options:

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.

Available options:

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.

Available options:

useRedirectTypeboolean | nullableOptional

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

redirectTypestring · enumOptional

Redirect type values.

Available options:

useIncludeOfficeActivationboolean | nullableOptional

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

includeOfficeActivationstring · enumOptional

Enable State values.

Available options:

useIncludeOneDriveboolean | nullableOptional

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

includeOneDrivestring · enumOptional

Enable State values.

Available options:

useIncludeOneNoteboolean | nullableOptional

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

includeOneNotestring · enumOptional

Enable State values.

Available options:

useIncludeOneNoteUWPboolean | nullableOptional

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

includeOneNoteUWPstring · enumOptional

Enable State values.

Available options:

useIncludeOutlookboolean | nullableOptional

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

includeOutlookstring · enumOptional

Enable State values.

Available options:

useIncludeOutlookPersonalizationboolean | nullableOptional

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

includeOutlookPersonalizationstring · enumOptional

Enable State values.

Available options:

useIncludeSharepointboolean | nullableOptional

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

includeSharepointstring · enumOptional

Enable State values.

Available options:

useIncludeSkypeboolean | nullableOptional

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

includeSkypestring · enumOptional

Enable State values.

Available options:

useIncludeTeamsboolean | nullableOptional

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

includeTeamsstring · enumOptional

Enable State values.

Available options:

useMirrorLocalOSTToVHDboolean | nullableOptional

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

mirrorLocalOSTToVHDstring · enumOptional

Mirror Local OST-VHD values.

Available options:

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.

Available options:

useVHDAccessModeboolean | nullableOptional

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

vhdAccessModestring · enumOptional

VHD Access Mode values.

Available options:

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.

Available options:

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.

Available options:

Responses

application/json; api-version=1.0

put

PUT /api/RDS/Host/{id}/FSLogix/OfficeContainer HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 3402

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

No content