1 of 23

RDS Default Settings

App Package Assigned

Auto Upgrade

Messages

Optimization

Registry

Windows Component

Windows Scheduled Task

Windows Service

FSLogix

General

Office Container

CCD Locations

User Exclusion

User Inclusion

VHD Locations

ProfileContainer

CCD Locations

Folder Exclusion

Folder Inclusion

User Exclusion

User Inclusion

VHD Locations

Get

Retrieves FSLogix Office Container CCDLocation List of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/OfficeContainer/CCDLocations

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Office Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/OfficeContainer/CCDLocations'

200

401

404

[
  "text"
]

Success

Add

Adds a CCDLocation to the CCDLocation List of the FSLogix Office Container settings.

post

/api/RDSDefaultSettings/FSLogix/OfficeContainer/CCDLocations

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

ccdLocationstring | nullablerequired

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No body

Created

Remove

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

delete

/api/RDSDefaultSettings/FSLogix/OfficeContainer/CCDLocations

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

ccdLocationstring | nullablerequired

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No body

No Content

Get

Retrieves FSLogix Office Container User Inclusion List of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/OfficeContainer/UserInclusion

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Office Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/OfficeContainer/UserInclusion'

200

401

404

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

Success

Add

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

post

/api/RDSDefaultSettings/FSLogix/OfficeContainer/UserInclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

accountstring | nullable

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

sidstring | nullable

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No body

Created

Remove

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

delete

/api/RDSDefaultSettings/FSLogix/OfficeContainer/UserInclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

accountstring | nullable

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

sidstring | nullable

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No body

No Content

Get

Retrieve FSLogix Profile Container CCDLocation List of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/ProfileContainer/CCDLocations

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/ProfileContainer/CCDLocations'

200

401

404

[
  "text"
]

Success

Add

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

post

/api/RDSDefaultSettings/FSLogix/ProfileContainer/CCDLocations

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

ccdLocationstring | nullablerequired

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No body

Created

Delete

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

delete

/api/RDSDefaultSettings/FSLogix/ProfileContainer/CCDLocations

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

ccdLocationstring | nullablerequired

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No body

No Content

Get

Retrieve FSLogix Profile Container Folder Inclusion List of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/ProfileContainer/FolderInclusion

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/ProfileContainer/FolderInclusion'

200

401

404

[
  "text"
]

Success

Add

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

post

/api/RDSDefaultSettings/FSLogix/ProfileContainer/FolderInclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

folderstring | nullablerequired

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No body

Created

Delete

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

delete

/api/RDSDefaultSettings/FSLogix/ProfileContainer/FolderInclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

folderstring | nullablerequired

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No body

No Content

Get

Retrieve FSLogix Profile Container Folder Exclusion List of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/ProfileContainer/FolderExclusion

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/ProfileContainer/FolderExclusion'

200

401

404

[
  "text"
]

Success

Add

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

post

/api/RDSDefaultSettings/FSLogix/ProfileContainer/FolderExclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

folderstring | nullablerequired

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

excludeFolderCopystring[Flag] · enum

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

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No body

Created

Update

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

put

/api/RDSDefaultSettings/FSLogix/ProfileContainer/FolderExclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

folderstring | nullablerequired

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

excludeFolderCopystring[Flag] · enumrequired

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

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No body

Created

Remove

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

delete

/api/RDSDefaultSettings/FSLogix/ProfileContainer/FolderExclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

folderstring | nullablerequired

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No body

No Content

Get

Retrieve the default assigned application package settings by Site ID.

get

/api/RDSDefaultSettings/AppPackageAssigned

Query parameters

siteIdinteger · int32

The Site ID of the default assigned application package.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/AppPackageAssigned'

200

401

404

[
  {
    "version": "text",
    "tagName": "text",
    "tagId": 1,
    "packageName": "text"
  }
]

Success

Add

Add a default assigned application package.

post

/api/RDSDefaultSettings/AppPackageAssigned

Query parameters

siteIdinteger · int32

The Site ID for which to add the assigned application package.

Body

packageNamestring | nullablerequired

<para type="description">The application package name.</para> <para type="description">This must be the actual application package name used in the RAS farm.</para>

versionstring | nullablerequired

<para type="description">The version of the application package.</para> <para type="description">This must be the actual application package version used in the RAS farm.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/RDSDefaultSettings/AppPackageAssigned' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "packageName": "text",
    "version": "text"
  }'

201

401

404

409

No body

Created

Update

Update the default assigned application package settings with the specified Site ID.

put

/api/RDSDefaultSettings/AppPackageAssigned

Query parameters

siteIdinteger · int32

The Site ID for which to modify the default assigned application package.

Body

packageNamestring | nullablerequired

<para type="description">The name of the application package for which to change the version.</para> <para type="description">This must be the actual application package name used in the RAS farm.</para>

versionstring | nullablerequired

<para type="description">The new version of the application package.</para> <para type="description">This must be the actual application package version used in the RAS farm.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/RDSDefaultSettings/AppPackageAssigned' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "packageName": "text",
    "version": "text"
  }'

204

401

404

No body

No Content

Delete

Remove the default assigned application package.

delete

/api/RDSDefaultSettings/AppPackageAssigned

Query parameters

siteIdinteger · int32

Site ID for which to remove the assigned application package.

Body

packageNamestring | nullablerequired

<para type="description">The name of the application package for which to remove the assigned packaged application.</para> <para type="description">This must be the actual application package name used in the RAS farm.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/RDSDefaultSettings/AppPackageAssigned' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "packageName": "text"
  }'

204

401

404

No body

No Content

Get

Retrieve the RD Session Host Default settings.

get

/api/RDSDefaultSettings

Query parameters

SiteIdinteger · int32

Site ID for which to retrieve RD Session Host Default settings (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings'

200

401

404

{
  "port": 1,
  "maxSessions": 1,
  "disconnectActiveSessionAfter": 1,
  "logoffDisconnectedSessionAfter": 1,
  "allowURLAndMailRedirection": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = EnabledWithAppRegistration"
  ],
  "supportShellURLNamespaceObjects": true,
  "preferredBrokerId": 1,
  "enableDriveRedirectionCache": true,
  "allowRemoteExec": true,
  "enableAppMonitoring": true,
  "useRemoteApps": true,
  "allowFileTransfer": true,
  "fileTransferMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "fileTransferLocation": "text",
  "fileTransferLockLocation": true,
  "allowDragAndDrop": true,
  "dragAndDropMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "manageRDPTransportProtocol": [
    "0 = Disabled",
    "1 = BothUDPTCP",
    "2 = OnlyTCP",
    "3 = EitherUDPTCP"
  ],
  "printerNameFormat": [
    "0 = PrnFormat_PRN_CMP_SES",
    "1 = PrnFormat_SES_CMP_PRN",
    "2 = PrnFormat_PRN_REDSES"
  ],
  "removeClientNameFromPrinterName": true,
  "removeSessionNumberFromPrinterName": true,
  "technology": [
    "0 = DoNotManage",
    "1 = UPD",
    "2 = FSLogix"
  ],
  "fsLogix": {
    "profileContainer": {
      "enabled": true,
      "locationType": [
        "0 = SMBLocation",
        "1 = CloudCache"
      ],
      "vhdLocations": [
        "text"
      ],
      "ccdLocations": [
        "text"
      ],
      "profileDiskFormat": [
        "0 = VHD",
        "1 = VHDX"
      ],
      "allocationType": [
        "0 = Dynamic",
        "1 = Full"
      ],
      "defaultSize": 1,
      "userInclusionList": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ],
      "userExclusionList": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ],
      "cloudCache": {
        "useMaxCacheSizeInMBs": true,
        "maxCacheSizeInMBs": 1,
        "useClearCacheOnLogoff": true,
        "clearCacheOnLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useHealthyProvidersRequiredForRegister": true,
        "healthyProvidersRequiredForRegister": 1,
        "useHealthyProvidersRequiredForUnregister": true,
        "healthyProvidersRequiredForUnregister": 1,
        "useUnregisterTimeout": true,
        "unregisterTimeout": 1,
        "useClearCacheOnForcedUnregister": true,
        "clearCacheOnForcedUnregister": [
          "0 = Disable",
          "1 = Enable"
        ]
      },
      "customizeProfileFolders": true,
      "excludeCommonFolders": [
        "1 = Contacts",
        "2 = Desktop",
        "4 = Documents",
        "8 = Links",
        "16 = MusicPodcasts",
        "32 = PicturesVideos",
        "64 = FoldersLowIntegProcesses",
        "128 = Downloads"
      ],
      "folderInclusionList": [
        "text"
      ],
      "folderExclusionList": [
        {
          "folder": "text",
          "excludeFolderCopy": [
            "0 = None",
            "1 = CopyBase",
            "2 = CopyBack"
          ]
        }
      ],
      "advancedSettings": {
        "useLockedRetryCount": true,
        "lockedRetryCount": 1,
        "useLockedRetryInterval": true,
        "lockedRetryInterval": 1,
        "useAccessNetworkAsComputerObject": true,
        "accessNetworkAsComputerObject": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useAttachVHDSDDL": true,
        "attachVHDSDDL": "text",
        "useDiffDiskParentFolderPath": true,
        "diffDiskParentFolderPath": "text",
        "useFlipFlopProfileDirectoryName": true,
        "flipFlopProfileDirectoryName": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useNoProfileContainingFolder": true,
        "noProfileContainingFolder": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useOutlookCachedMode": true,
        "outlookCachedMode": [
          "0 = Disable",
          "1 = Enable"
        ],
        "usePreventLoginWithFailure": true,
        "preventLoginWithFailure": [
          "0 = Disable",
          "1 = Enable"
        ],
        "usePreventLoginWithTempProfile": true,
        "preventLoginWithTempProfile": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useReAttachRetryCount": true,
        "reAttachRetryCount": 1,
        "useReAttachIntervalSeconds": true,
        "reAttachIntervalSeconds": 1,
        "useRemoveOrphanedOSTFilesOnLogoff": true,
        "removeOrphanedOSTFilesOnLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRoamSearch": true,
        "roamSearch": [
          "0 = Disable",
          "1 = SingleUser",
          "2 = MultiUser"
        ],
        "useSIDDirNameMatch": true,
        "sidDirNameMatch": "text",
        "useSIDDirNamePattern": true,
        "sidDirNamePattern": "text",
        "useSIDDirSDDL": true,
        "sidDirSDDL": "text",
        "useVHDNameMatch": true,
        "vhdNameMatch": "text",
        "useVHDNamePattern": true,
        "vhdNamePattern": "text",
        "useVHDXSectorSize": true,
        "vhdxSectorSize": [
          "0 = SystemDefault",
          "512 = Size_512",
          "4096 = Size_4096"
        ],
        "useVolumeWaitTimeMS": true,
        "volumeWaitTimeMS": 1,
        "useIgnoreNonAVD": true,
        "ignoreNonAVD": [
          "0 = AnySession",
          "1 = AVDSessions"
        ],
        "useRedirectType": true,
        "redirectType": [
          "1 = Legacy",
          "2 = Advanced"
        ],
        "useKeepLocalDir": true,
        "keepLocalDir": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useDeleteLocalProfileWhenVHDShouldApply": true,
        "deleteLocalProfileWhenVHDShouldApply": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useProfileDirSDDL": true,
        "profileDirSDDL": "text",
        "useProfileType": true,
        "profileType": [
          "0 = NormalProfile",
          "1 = OnlyRWProfile",
          "2 = OnlyROProfile",
          "3 = RWROProfile"
        ],
        "useSetTempToLocalPath": true,
        "setTempToLocalPath": [
          "0 = TakeNoAction",
          "1 = RedirectTempAndTmp",
          "2 = RedirectINetCache",
          "3 = RedirectTempTmpAndINetCache"
        ],
        "useCleanOutNotifications": true,
        "cleanOutNotifications": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useInstallAppxPackages": true,
        "installAppxPackages": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRebootOnUserLogoff": true,
        "rebootOnUserLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRoamIdentity": true,
        "roamIdentity": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useShutdownOnUserLogoff": true,
        "shutdownOnUserLogoff": [
          "0 = Disable",
          "1 = Enable"
        ]
      }
    },
    "officeContainer": {
      "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"
        ]
      }
    },
    "generalSettings": {
      "appServices": {
        "useCleanupInvalidSessions": true,
        "cleanupInvalidSessions": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRoamRecycleBin": true,
        "roamRecycleBin": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useVHDCompactDisk": true,
        "vhdCompactDisk": [
          "0 = Disable",
          "1 = Enable"
        ]
      },
      "cloudCacheGeneral": {
        "useCacheDirectory": true,
        "cacheDirectory": "text",
        "useWriteCacheDirectory": true,
        "writeCacheDirectory": "text",
        "useProxyDirectory": true,
        "proxyDirectory": "text",
        "useSilenceACLWarning": true,
        "silenceACLWarning": [
          "0 = Disable",
          "1 = Enable"
        ]
      },
      "logging": {
        "logEnabled": [
          "0 = Disable",
          "1 = Specific",
          "2 = All"
        ],
        "logLevel": [
          "0 = Debug",
          "1 = Information",
          "2 = Warning",
          "3 = Error"
        ],
        "logFileKeepingPeriod": 1,
        "logDirectory": "text",
        "robocopyLogPath": "text",
        "logSpecificComponents": [
          "1 = ProfileConfigTool",
          "2 = IEPlugin",
          "4 = RuleEditor",
          "8 = JavaRuleEditor",
          "16 = FSLogixAgentService",
          "32 = Profile",
          "64 = JavaLauncher",
          "128 = OfficeContainer",
          "256 = RuleCompilation",
          "512 = FontVisibility",
          "1024 = Network",
          "2048 = PrinterVisibility",
          "4096 = ADSComputerGroup",
          "8192 = DriverInterface",
          "16384 = WindowsSearchRoaming",
          "32768 = WindowsSearchPlugin",
          "65536 = ProcessStartMonitor"
        ]
      }
    }
  },
  "updMode": [
    "0 = DoNotChange",
    "1 = Enabled",
    "2 = Disabled"
  ],
  "maxUserProfileDiskSizeGB": 1,
  "diskPath": "text",
  "roamingMode": [
    "0 = Exclude",
    "2 = Include"
  ],
  "includeFolderPath": [
    "text"
  ],
  "includeFilePath": [
    "text"
  ],
  "excludeFolderPath": [
    "text"
  ],
  "excludeFilePath": [
    "text"
  ],
  "restrictDesktopAccess": true,
  "restrictedUsers": [
    "text"
  ],
  "optimization": {
    "enableOptimization": true,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": true,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": true,
    "windowsComponentsEnabled": true,
    "windowsServicesEnabled": true,
    "windowsScheduledTasksEnabled": true,
    "windowsAdvancedOptionsEnabled": true,
    "networkPerformanceEnabled": true,
    "registryEnabled": true,
    "visualEffectsEnabled": true,
    "diskCleanupEnabled": true,
    "customScriptEnabled": true,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": true,
      "teleCollection": true,
      "systemRestore": true,
      "additionalErrorReport": true,
      "tiles": true,
      "cortana": true,
      "microsoftConsumerExperience": true,
      "windowsTips": true,
      "commonProgramGroups": true,
      "partialStartMenu": true
    },
    "networkPerformance": {
      "dirCacheMax": 1,
      "dormantFileLimit": 1,
      "fileNotFoundCache": 1,
      "fileInfoCache": 1,
      "fileInfoCacheEnable": true,
      "directoryCacheEnable": true,
      "fileNotFoundCacheEnable": true,
      "dormantFileLimitEnable": true,
      "disableTCP": true,
      "disableIPv6CompEnable": true,
      "disableIPv6ToIPv4": true,
      "disableIsaTap": true
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": true,
      "cleanupSystemFiles": true,
      "cleanupTemporaryFileLogs": true,
      "removeOneDrive": true,
      "deleteUserProfiles": true
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": true,
      "animateWindowsWhenMinimizingMaximizing": true,
      "animateTaskbar": true,
      "enablePeek": true,
      "fadeSlideMenus": true,
      "fadeSlideToolTips": true,
      "fadeOutMenuItems": true,
      "saveTaskbarThumbnail": true,
      "showShadowUnderMouse": true,
      "shadowUnderWindows": true,
      "thumbnailsInsteadOfIcons": true,
      "showTranslucentSelection": true,
      "showWindowsContentWhilstDragging": true,
      "slideOpenComboBoxes": true,
      "smoothEdgesScreenFonts": true,
      "smoothScrollListBoxes": true,
      "dropShadowsIcon": true
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "id": 1,
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "dwordValue": 1,
          "displayName": "text",
          "hiveType": [
            "0 = HKEY_CURRENT_CONFIG",
            "1 = HKEY_USERS",
            "2 = HKEY_LOCAL_MACHINE",
            "3 = HKEY_CLASSES_ROOT"
          ],
          "path": "text",
          "regType": [
            "0 = REG_SZ",
            "1 = REG_DWORD",
            "2 = REG_QWORD",
            "3 = REG_MULTI_SZ",
            "4 = REG_EXPAND_SZ"
          ],
          "stringValue": "text"
        }
      ]
    },
    "uwpApps": {
      "allExcept": [
        "text"
      ],
      "followingPkgs": [
        "text"
      ],
      "removeType": [
        "0 = AllExcept",
        "1 = FollowingPkgs"
      ]
    }
  },
  "appPackagesAssigned": {
    "applicationPackagesAssigned": [
      {
        "version": "text",
        "tagName": "text",
        "tagId": 1,
        "packageName": "text"
      }
    ]
  },
  "autoUpgrade": {
    "enabled": true,
    "startDateTime": "2025-03-11T06:59:49.171Z",
    "drainModeDurationInSecs": 1,
    "forceLogoffSessions": true,
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ]
  },
  "siteId": 1
}

Success

Update

Modify the RD Session Host server default settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

put

/api/RDSDefaultSettings

Query parameters

SiteIdinteger · int32

Site ID for which to update the RD Session Host Default settings (optional)

Body

portinteger · int32 | nullable

<para type="description">Specifies the RD Session Host agent port number.</para>

maxSessionsinteger · int32 | nullable

<para type="description">Specifies the 'Maximum Sessions' option.</para>

disconnectActiveSessionAfterinteger · int32 | nullable

<para type="description">Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.</para>

logoffDisconnectedSessionAfterinteger · int32 | nullable

<para type="description">Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.</para>

allowURLAndMailRedirectionstring · enum

<para type="synopsis">URL and Mail Redirection values.</para> <para type="description"></para> <para type="description"></para>

Options: 0 = Disabled,1 = Enabled,2 = EnabledWithAppRegistration

supportShellURLNamespaceObjectsboolean | nullable

<para type="description">Enable or disable the 'Support Shell URL Namespace Objects' option.</para>

autoPreferredBrokerboolean · default: false

<para type="description">Set the 'Preferred Connection Broker' option to 'Automatically".</para>

preferredBrokerIdinteger · int32 | nullable

<para type="description">The preferred Connection Broker.</para>

enableDriveRedirectionCacheboolean | nullable

<para type="description">Enable or disable the 'Enable Drive Redirection Cache' option.</para>

allowRemoteExecboolean | nullable

<para type="description">Enable or disable the 'Allow 2XRemoteExec to send command to the client' option. </para>

enableAppMonitoringboolean | nullable

<para type="description">Enable or disable the 'Enable application monitoring' option.</para>

useRemoteAppsboolean | nullable

<para type="description">Enable or disable the 'Use RemoteApps if available' option.</para>

allowFileTransferboolean | nullableDeprecated

<para type="description">Deprecated: use FileTransferMode instead.</para> <para type="description">Enable or disable the 'Allow file transfer' option.</para>

fileTransferModestring · enum

<para type="synopsis">File Transfer Control modes.</para> <para type="description"></para>

Options: 0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

fileTransferLocationstring | nullable

<para type="description">Location where the File Transfer takes place, if and where it is allowed.</para>

fileTransferLockLocationboolean | nullable

<para type="description">Lock Location where the File Transfer takes place, if and where it is allowed.</para>

allowDragAndDropboolean | nullableDeprecated

<para type="description">Enable or disable the 'Allow local to remote drag and drop' option. (deprecated)</para>

dragAndDropModestring · enum

<para type="synopsis">Drag and drop redirection values.</para> <para type="description"></para>

Options: 0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

manageRDPTransportProtocolstring · enum

<para type="synopsis">Manage RDP transport protocol.</para> <para type="description"></para>

Options: 0 = Disabled,1 = BothUDPTCP,2 = OnlyTCP,3 = EitherUDPTCP

printerNameFormatstring · enum

<para type="synopsis">Printer Name Format</para> <para type="description"></para> <para type="description"></para>

Options: 0 = PrnFormat_PRN_CMP_SES,1 = PrnFormat_SES_CMP_PRN,2 = PrnFormat_PRN_REDSES

removeClientNameFromPrinterNameboolean | nullable

<para type="description">Enable or disable the 'Remove client name from printer name' option.</para>

removeSessionNumberFromPrinterNameboolean | nullable

<para type="description">Enable or disable the 'Remove session number from printer name' option.</para>

technologystring · enum

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

Options: 0 = DoNotManage,1 = UPD,2 = FSLogix

updModestring · enum

<para type="synopsis">User Profile Disk Mode.</para> <para type="description"></para> <para type="description"></para>

Options: 0 = DoNotChange,1 = Enabled,2 = Disabled

updRoamingModestring · enum

<para type="synopsis">User Profile Disk Roaming Mode.</para> <para type="description"></para> <para type="description"></para>

Options: 0 = Exclude,2 = Include

upDiskPathstring | nullable

<para type="description">Specifies the User Profile Disk path.</para>

maxUserProfileDiskSizeGBinteger · int32 | nullable

<para type="description">Specifies the max user profile disk size (in GB).</para>

includeFolderPathstring[] | nullable

<para type="description">Specifies the UPD 'Include' folder paths.</para>

includeFilePathstring[] | nullable

<para type="description">Specifies the UPD 'Include' file paths.</para>

excludeFolderPathstring[] | nullable

<para type="description">Specifies the UPD 'Exclude' folder paths.</para>

excludeFilePathstring[] | nullable

<para type="description">Specifies the UPD 'Exclude' file paths.</para>

restrictDesktopAccessboolean | nullable

<para type="description">Enable or disable the 'Restrict direct desktop access to the following users' option.</para> <para type="description">To specify the list of users, use the RestrictedUsers parameter.</para>

restrictedUsersstring[] | nullable

<para type="description">Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled).</para> <para type="description">The list can contain User account names and User SIDs.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/RDSDefaultSettings' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "port": 1,
    "maxSessions": 1,
    "disconnectActiveSessionAfter": 1,
    "logoffDisconnectedSessionAfter": 1,
    "allowURLAndMailRedirection": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = EnabledWithAppRegistration"
    ],
    "supportShellURLNamespaceObjects": true,
    "autoPreferredBroker": false,
    "preferredBrokerId": 1,
    "enableDriveRedirectionCache": true,
    "allowRemoteExec": true,
    "enableAppMonitoring": true,
    "useRemoteApps": true,
    "allowFileTransfer": true,
    "fileTransferMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "fileTransferLocation": "text",
    "fileTransferLockLocation": true,
    "allowDragAndDrop": true,
    "dragAndDropMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "manageRDPTransportProtocol": [
      "0 = Disabled",
      "1 = BothUDPTCP",
      "2 = OnlyTCP",
      "3 = EitherUDPTCP"
    ],
    "printerNameFormat": [
      "0 = PrnFormat_PRN_CMP_SES",
      "1 = PrnFormat_SES_CMP_PRN",
      "2 = PrnFormat_PRN_REDSES"
    ],
    "removeClientNameFromPrinterName": true,
    "removeSessionNumberFromPrinterName": true,
    "technology": [
      "0 = DoNotManage",
      "1 = UPD",
      "2 = FSLogix"
    ],
    "updMode": [
      "0 = DoNotChange",
      "1 = Enabled",
      "2 = Disabled"
    ],
    "updRoamingMode": [
      "0 = Exclude",
      "2 = Include"
    ],
    "upDiskPath": "text",
    "maxUserProfileDiskSizeGB": 1,
    "includeFolderPath": [
      "text"
    ],
    "includeFilePath": [
      "text"
    ],
    "excludeFolderPath": [
      "text"
    ],
    "excludeFilePath": [
      "text"
    ],
    "restrictDesktopAccess": true,
    "restrictedUsers": [
      "text"
    ]
  }'

204

401

404

No body

No Content

List

Retrieve Auto-upgrade Message(s).

get

/api/RDSDefaultSettings/AutoUpgrade/Messages

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/AutoUpgrade/Messages'

200

401

404

[
  {
    "id": 1,
    "enabled": true,
    "messageTitle": "text",
    "message": "text",
    "sendMsgSecs": 1,
    "sendMsgWhen": [
      "0 = Before",
      "1 = After"
    ]
  }
]

Success

Create

Create an Auto-upgrade Message.

post

/api/RDSDefaultSettings/AutoUpgrade/Messages

Body

enabledboolean

<para type="description">Whether to enable or disable the message.</para>

messageTitlestring | nullablerequired

<para type="description">The title of the message.</para>

messagestring | nullablerequired

<para type="description">A message that should be sent to users before the job starts.</para>

sendMsgSecsinteger · int32

<para type="description">Time interval in seconds before the job starts when the message to users should be sent.</para>

sendMsgWhenstring · enum

<para type="synopsis">Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.</para> <para type="description"></para>

Options: 0 = Before,1 = After

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/RDSDefaultSettings/AutoUpgrade/Messages' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enabled": true,
    "messageTitle": "text",
    "message": "text",
    "sendMsgSecs": 1,
    "sendMsgWhen": [
      "0 = Before",
      "1 = After"
    ]
  }'

201

401

404

No body

Created

Get

Retrieve an Auto-upgrade Message.

get

/api/RDSDefaultSettings/AutoUpgrade/Messages/{messageId}

Path parameters

messageIdinteger · int32required

The ID of the message to retrieve.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/AutoUpgrade/Messages/{messageId}'

200

401

404

{
  "id": 1,
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

Success

Update

Update an Auto-upgrade Message.

put

/api/RDSDefaultSettings/AutoUpgrade/Messages/{messageId}

Path parameters

messageIdinteger · int32required

The ID of the message to modify.

Body

enabledboolean | nullable

<para type="description">Whether to enable or disable the message.</para>

messageTitlestring | nullable

<para type="description">The title of the message.</para>

messagestring | nullable

<para type="description">A message that should be sent to users before the job starts.</para>

sendMsgSecsinteger · int32 | nullable

<para type="description">Time interval in seconds before the job starts when the message to users should be sent.</para>

sendMsgWhenstring · enum

<para type="synopsis">Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.</para> <para type="description"></para>

Options: 0 = Before,1 = After

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/RDSDefaultSettings/AutoUpgrade/Messages/{messageId}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enabled": true,
    "messageTitle": "text",
    "message": "text",
    "sendMsgSecs": 1,
    "sendMsgWhen": [
      "0 = Before",
      "1 = After"
    ]
  }'

204

401

404

No body

No Content

Delete

Delete an Auto-upgrade Message by ID.

delete

/api/RDSDefaultSettings/AutoUpgrade/Messages/{messageId}

Path parameters

messageIdinteger · int32required

The ID of the message to remove.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/RDSDefaultSettings/AutoUpgrade/Messages/{messageId}'

204

401

404

No body

No Content

Get

Retrieve the default image optimization settings by Site Id.

get

/api/RDSDefaultSettings/Optimization

Query parameters

siteIdinteger · int32

The Site Id of the default image optimization

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/Optimization'

200

401

404

{
  "enableOptimization": true,
  "optimizationType": [
    "0 = Automatic",
    "1 = Manual"
  ],
  "windowsDefenderATP": {
    "winDefATPTurnOffOn": [
      "0 = TurnOffWindowsDefenderATP",
      "1 = TurnOnWindowsDefenderATP"
    ],
    "disableRealTimeProtection": true,
    "excludeFolders": [
      "text"
    ],
    "excludeProcesses": [
      "text"
    ],
    "excludeExtension": [
      "text"
    ]
  },
  "windowsComponents": {
    "windowsComponentsList": [
      {
        "type": [
          "0 = Predefined",
          "1 = Custom"
        ],
        "componentName": "text",
        "displayName": "text",
        "aliases": "text"
      }
    ]
  },
  "windowsDefenderATPEnabled": true,
  "windowsComponentsEnabled": true,
  "windowsServicesEnabled": true,
  "windowsScheduledTasksEnabled": true,
  "windowsAdvancedOptionsEnabled": true,
  "networkPerformanceEnabled": true,
  "registryEnabled": true,
  "visualEffectsEnabled": true,
  "diskCleanupEnabled": true,
  "customScriptEnabled": true,
  "windowsServices": {
    "windowsServicesList": [
      {
        "type": [
          "0 = Predefined",
          "1 = Custom"
        ],
        "serviceName": "text",
        "displayName": "text",
        "aliases": "text"
      }
    ]
  },
  "windowsAdvancedOptions": {
    "partialStartLayoutContent": "text",
    "hibernate": true,
    "teleCollection": true,
    "systemRestore": true,
    "additionalErrorReport": true,
    "tiles": true,
    "cortana": true,
    "microsoftConsumerExperience": true,
    "windowsTips": true,
    "commonProgramGroups": true,
    "partialStartMenu": true
  },
  "networkPerformance": {
    "dirCacheMax": 1,
    "dormantFileLimit": 1,
    "fileNotFoundCache": 1,
    "fileInfoCache": 1,
    "fileInfoCacheEnable": true,
    "directoryCacheEnable": true,
    "fileNotFoundCacheEnable": true,
    "dormantFileLimitEnable": true,
    "disableTCP": true,
    "disableIPv6CompEnable": true,
    "disableIPv6ToIPv4": true,
    "disableIsaTap": true
  },
  "customScript": {
    "arguments": "text",
    "command": "text",
    "initDir": "text",
    "user": "text"
  },
  "diskCleanup": {
    "cleanupWinSxSFolder": true,
    "cleanupSystemFiles": true,
    "cleanupTemporaryFileLogs": true,
    "removeOneDrive": true,
    "deleteUserProfiles": true
  },
  "visualEffects": {
    "visualEffectsTypes": [
      "0 = LetWindowsChooseWhatsBest",
      "1 = AdjustForBestAppearance",
      "2 = AdjustForBestPerformance",
      "3 = Custom"
    ],
    "animateControlSelectElements": true,
    "animateWindowsWhenMinimizingMaximizing": true,
    "animateTaskbar": true,
    "enablePeek": true,
    "fadeSlideMenus": true,
    "fadeSlideToolTips": true,
    "fadeOutMenuItems": true,
    "saveTaskbarThumbnail": true,
    "showShadowUnderMouse": true,
    "shadowUnderWindows": true,
    "thumbnailsInsteadOfIcons": true,
    "showTranslucentSelection": true,
    "showWindowsContentWhilstDragging": true,
    "slideOpenComboBoxes": true,
    "smoothEdgesScreenFonts": true,
    "smoothScrollListBoxes": true,
    "dropShadowsIcon": true
  },
  "windowsScheduledTasks": {
    "windowsScheduledTasksList": [
      {
        "task": "text",
        "location": "text",
        "type": [
          "0 = Folder",
          "1 = Task"
        ]
      }
    ]
  },
  "registry": {
    "registryList": [
      {
        "id": 1,
        "action": [
          "0 = Add",
          "1 = Modify",
          "2 = Delete"
        ],
        "registryName": "text",
        "dwordValue": 1,
        "displayName": "text",
        "hiveType": [
          "0 = HKEY_CURRENT_CONFIG",
          "1 = HKEY_USERS",
          "2 = HKEY_LOCAL_MACHINE",
          "3 = HKEY_CLASSES_ROOT"
        ],
        "path": "text",
        "regType": [
          "0 = REG_SZ",
          "1 = REG_DWORD",
          "2 = REG_QWORD",
          "3 = REG_MULTI_SZ",
          "4 = REG_EXPAND_SZ"
        ],
        "stringValue": "text"
      }
    ]
  },
  "uwpApps": {
    "allExcept": [
      "text"
    ],
    "followingPkgs": [
      "text"
    ],
    "removeType": [
      "0 = AllExcept",
      "1 = FollowingPkgs"
    ]
  }
}

Success

Update

Update the Default Image Optimization settings with the specified Site ID.

put

/api/RDSDefaultSettings/Optimization

Query parameters

siteIdinteger · int32

The Site Id for which to modify the Image Optimization.

Body

enableOptimizationboolean | nullable

<para type="synopsis">Whether Optimization is Enabled or not</para> <para type="description"></para>

optimizationTypestring · enum

<para type="synopsis">Optimization Type</para> <para type="description"></para>

Options: 0 = Automatic,1 = Manual

windowsDefenderATPEnabledboolean | nullable

<para type="synopsis">Whether Windows Defender ATP is enabled or not</para> <para type="description"></para>

windowsComponentsEnabledboolean | nullable

<para type="synopsis">Whether Windows Components is enabled or not</para> <para type="description"></para>

windowsServicesEnabledboolean | nullable

<para type="synopsis">Whether Windows Services is enabled or not</para> <para type="description"></para>

windowsScheduledTasksEnabledboolean | nullable

<para type="synopsis">Whether Windows Scheduled Task is enabled or not</para> <para type="description"></para>

windowsAdvancedOptionsEnabledboolean | nullable

<para type="synopsis">Whether Windows Advanced Options is enabled or not</para> <para type="description"></para>

networkPerformanceEnabledboolean | nullable

<para type="synopsis">Whether Network Performance is enabled or not</para> <para type="description"></para>

registryEnabledboolean | nullable

<para type="synopsis">Whether Registry is enabled or not</para> <para type="description"></para>

visualEffectsEnabledboolean | nullable

<para type="synopsis">Whether Visual Effects is enabled or not</para> <para type="description"></para>

diskCleanupEnabledboolean | nullable

<para type="synopsis">Whether Disk Cleanup is enabled or not</para> <para type="description"></para>

customScriptEnabledboolean | nullable

<para type="synopsis">Whether Custom Script is enabled or not</para> <para type="description"></para>

winDefATPTurnOffOnstring · enum

<para type="synopsis">Windows enable options</para> <para type="description"></para>

Options: 0 = TurnOffWindowsDefenderATP,1 = TurnOnWindowsDefenderATP

disableRealTimeProtectionboolean | nullable

<para type="synopsis">Disable Real Time Protection</para> <para type="description"></para>

excludeFoldersstring[] | nullable

<para type="synopsis">Exclude Folders List</para> <para type="description"></para>

excludeProcessesstring[] | nullable

<para type="synopsis">Exclude Processes</para> <para type="description"></para>

excludeExtensionstring[] | nullable

<para type="synopsis">Exclude Extensions</para> <para type="description"></para>

partialStartLayoutContentstring | nullable

<para type="synopsis">Partial Start menu layout</para> <para type="description"></para>

hibernateboolean | nullable

<para type="synopsis">Whether Hibernate is enabled or not</para> <para type="description"></para>

teleCollectionboolean | nullable

<para type="synopsis">Whether TeleCollection is enabled or not</para> <para type="description"></para>

systemRestoreboolean | nullable

<para type="synopsis">Whether System Restore is enabled or not</para> <para type="description"></para>

additionalErrorReportboolean | nullable

<para type="synopsis">Whether Additional Error Reporting is enabled or not</para> <para type="description"></para>

tilesboolean | nullable

<para type="synopsis">Whether Tiles is enabled or not</para> <para type="description"></para>

cortanaboolean | nullable

<para type="synopsis">Whether Cortana is enabled or not</para> <para type="description"></para>

microsoftConsumerExperienceboolean | nullable

<para type="synopsis">Whether Microsoft Consumer Experience is enabled or not</para> <para type="description"></para>

windowsTipsboolean | nullable

<para type="synopsis">Whether Windows Tips is enabled or not</para> <para type="description"></para>

commonProgramGroupsboolean | nullable

<para type="synopsis">Whether Common Program Groups is enabled or not</para> <para type="description"></para>

partialStartMenuboolean | nullable

<para type="synopsis">Whether Partial Start Menu is enabled or not</para> <para type="description"></para>

dirCacheMaxinteger · int32 | nullable

<para type="synopsis">Directory Cache Value</para> <para type="description"></para>

dormantFileLimitinteger · int32 | nullable

<para type="synopsis">Dormant File Limit Value</para> <para type="description"></para>

fileNotFoundCacheinteger · int32 | nullable

<para type="synopsis">File Not Found Cache Value</para> <para type="description"></para>

fileInfoCacheinteger · int32 | nullable

<para type="synopsis">File Info Cache Value</para> <para type="description"></para>

fileInfoCacheEnableboolean | nullable

<para type="synopsis">Whether File Info Cache is enabled or not</para> <para type="description"></para>

directoryCacheEnableboolean | nullable

<para type="synopsis">Whether Directory Cache is enabled or not</para> <para type="description"></para>

fileNotFoundCacheEnableboolean | nullable

<para type="synopsis">Whether File Not Found Cache is enabled or not</para> <para type="description"></para>

dormantFileLimitEnableboolean | nullable

<para type="synopsis">Whether Dormant File Limit is enabled or not</para> <para type="description"></para>

disableTCPboolean | nullable

<para type="synopsis">Whether Disable TCP is enabled or not</para> <para type="description"></para>

disableIPv6CompEnableboolean | nullable

<para type="synopsis">Whether Disable IPv6 Components is enabled or not</para> <para type="description"></para>

disableIPv6ToIPv4boolean | nullable

<para type="synopsis">Whether Disable IPv6 To IPv4 is enabled or not</para> <para type="description"></para>

disableIsaTapboolean | nullable

<para type="synopsis">Whether Disable IsaTap for IPv6 is enabled or not</para> <para type="description"></para>

argumentsstring | nullable

<para type="synopsis">Arguments</para> <para type="description"></para>

commandstring | nullable

<para type="synopsis">Command</para> <para type="description"></para>

initDirstring | nullable

<para type="synopsis">Initial Directory</para> <para type="description"></para>

userstring | nullable

passwordstring | nullable

<para type="synopsis">Password</para> <para type="description"></para>

cleanupWinSxSFolderboolean | nullable

<para type="synopsis">Whether Clean up windows SxS Folder is enabled or not</para> <para type="description"></para>

cleanupSystemFilesboolean | nullable

<para type="synopsis">Whether Clean up system files is enabled or not</para> <para type="description"></para>

cleanupTemporaryFileLogsboolean | nullable

<para type="synopsis">Whether Clean up temporary file logs is enabled or not</para> <para type="description"></para>

removeOneDriveboolean | nullable

<para type="synopsis">Whether Remove One Drives is enabled or not</para> <para type="description"></para>

deleteUserProfilesboolean | nullable

<para type="synopsis">Whether Delete User Profiles is enabled or not</para> <para type="description"></para>

visualEffectsTypesstring · enum

<para type="synopsis">Visual Effects Type</para> <para type="description"></para>

Options: 0 = LetWindowsChooseWhatsBest,1 = AdjustForBestAppearance,2 = AdjustForBestPerformance,3 = Custom

animateControlSelectElementsboolean | nullable

<para type="synopsis">Whether Animate Control Select Elements is enabled or not</para> <para type="description"></para>

animateWindowsWhenMinimizingMaximizingboolean | nullable

<para type="synopsis">Whether Animate Windows When Minimizing Or Maximizing is enabled or not</para> <para type="description"></para>

animateTaskbarboolean | nullable

<para type="synopsis">Whether Animate Taskbar is enabled or not</para> <para type="description"></para>

enablePeekboolean | nullable

<para type="synopsis">Whether Peek is enabled or not</para> <para type="description"></para>

fadeSlideMenusboolean | nullable

<para type="synopsis">Whether Fade Slide Menus is enabled or not</para> <para type="description"></para>

fadeSlideToolTipsboolean | nullable

<para type="synopsis">Whether Fade Slide Tool Tips is enabled or not</para> <para type="description"></para>

fadeOutMenuItemsboolean | nullable

<para type="synopsis">Whether Fade Out Menu Items is enabled or not</para> <para type="description"></para>

saveTaskbarThumbnailboolean | nullable

<para type="synopsis">Whether Taskbar Thumbnail is enabled or not</para> <para type="description"></para>

showShadowUnderMouseboolean | nullable

<para type="synopsis">Whether Shadow Under Mouse is enabled or not</para> <para type="description"></para>

shadowUnderWindowsboolean | nullable

<para type="synopsis">Whether Shadow Under Windows is enabled or not</para> <para type="description"></para>

thumbnailsInsteadOfIconsboolean | nullable

<para type="synopsis">Whether Thumbnails instead of icons is enabled or not</para> <para type="description"></para>

showTranslucentSelectionboolean | nullable

<para type="synopsis">Whether Translucent Selection is enabled or not</para> <para type="description"></para>

showWindowsContentWhilstDraggingboolean | nullable

<para type="synopsis">Whether Windows Content Whilst Dragging is enabled or not</para> <para type="description"></para>

slideOpenComboBoxesboolean | nullable

<para type="synopsis">Whether Slide open combo boxes is enabled or not</para> <para type="description"></para>

smoothEdgesScreenFontsboolean | nullable

<para type="synopsis">Whether Smooth Edges Screen Fonts is enabled or not</para> <para type="description"></para>

smoothScrollListBoxesboolean | nullable

<para type="synopsis">Whether Smooth Scroll List Boxes is enabled or not</para> <para type="description"></para>

dropShadowsIconboolean | nullable

<para type="synopsis">Whether Drop Shadow Icon is enabled or not</para> <para type="description"></para>

forceboolean · default: false

<para type="description">Force Optimization.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/RDSDefaultSettings/Optimization' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enableOptimization": true,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATPEnabled": true,
    "windowsComponentsEnabled": true,
    "windowsServicesEnabled": true,
    "windowsScheduledTasksEnabled": true,
    "windowsAdvancedOptionsEnabled": true,
    "networkPerformanceEnabled": true,
    "registryEnabled": true,
    "visualEffectsEnabled": true,
    "diskCleanupEnabled": true,
    "customScriptEnabled": true,
    "winDefATPTurnOffOn": [
      "0 = TurnOffWindowsDefenderATP",
      "1 = TurnOnWindowsDefenderATP"
    ],
    "disableRealTimeProtection": true,
    "excludeFolders": [
      "text"
    ],
    "excludeProcesses": [
      "text"
    ],
    "excludeExtension": [
      "text"
    ],
    "partialStartLayoutContent": "text",
    "hibernate": true,
    "teleCollection": true,
    "systemRestore": true,
    "additionalErrorReport": true,
    "tiles": true,
    "cortana": true,
    "microsoftConsumerExperience": true,
    "windowsTips": true,
    "commonProgramGroups": true,
    "partialStartMenu": true,
    "dirCacheMax": 1,
    "dormantFileLimit": 1,
    "fileNotFoundCache": 1,
    "fileInfoCache": 1,
    "fileInfoCacheEnable": true,
    "directoryCacheEnable": true,
    "fileNotFoundCacheEnable": true,
    "dormantFileLimitEnable": true,
    "disableTCP": true,
    "disableIPv6CompEnable": true,
    "disableIPv6ToIPv4": true,
    "disableIsaTap": true,
    "arguments": "text",
    "command": "text",
    "initDir": "text",
    "user": "text",
    "password": "text",
    "cleanupWinSxSFolder": true,
    "cleanupSystemFiles": true,
    "cleanupTemporaryFileLogs": true,
    "removeOneDrive": true,
    "deleteUserProfiles": true,
    "visualEffectsTypes": [
      "0 = LetWindowsChooseWhatsBest",
      "1 = AdjustForBestAppearance",
      "2 = AdjustForBestPerformance",
      "3 = Custom"
    ],
    "animateControlSelectElements": true,
    "animateWindowsWhenMinimizingMaximizing": true,
    "animateTaskbar": true,
    "enablePeek": true,
    "fadeSlideMenus": true,
    "fadeSlideToolTips": true,
    "fadeOutMenuItems": true,
    "saveTaskbarThumbnail": true,
    "showShadowUnderMouse": true,
    "shadowUnderWindows": true,
    "thumbnailsInsteadOfIcons": true,
    "showTranslucentSelection": true,
    "showWindowsContentWhilstDragging": true,
    "slideOpenComboBoxes": true,
    "smoothEdgesScreenFonts": true,
    "smoothScrollListBoxes": true,
    "dropShadowsIcon": true,
    "force": false
  }'

204

401

404

No body

No Content

Get

Retrieve the Auto-upgrade settings of a Site Defaults object.

get

/api/RDSDefaultSettings/AutoUpgrade

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the Auto-upgrade settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/AutoUpgrade'

200

401

404

{
  "enabled": true,
  "startDateTime": "2025-03-11T06:59:49.171Z",
  "drainModeDurationInSecs": 1,
  "forceLogoffSessions": true,
  "repeat": [
    "0 = Never",
    "1 = EveryDay",
    "2 = EveryWeek",
    "3 = Every2Weeks",
    "4 = EveryMonth",
    "5 = EveryYear",
    "6 = SpecificDays"
  ],
  "specificDays": [
    "0 = Never",
    "1 = Sunday",
    "2 = Monday",
    "4 = Tuesday",
    "8 = Wednesday",
    "16 = Thursday",
    "32 = Friday",
    "64 = Saturday"
  ],
  "messages": [
    {
      "id": 1,
      "enabled": true,
      "messageTitle": "text",
      "message": "text",
      "sendMsgSecs": 1,
      "sendMsgWhen": [
        "0 = Before",
        "1 = After"
      ]
    }
  ]
}

Success

Update

Update the Auto-upgrade settings of a Site Defaults object.

put

/api/RDSDefaultSettings/AutoUpgrade

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to modify the Auto-upgrade settings (optional).

Body

object

<para type="synopsis">Modify the Auto-upgrade settings</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/RDSDefaultSettings/AutoUpgrade' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{}'

204

401

404

No body

No Content

List

Retrieve default Registry.

get

/api/RDSDefaultSettings/Optimization/Registry

Query parameters

siteidinteger · int32

The Site Id of the optimization setting to retrieve the registry.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/Optimization/Registry'

200

401

404

[
  {
    "id": 1,
    "action": [
      "0 = Add",
      "1 = Modify",
      "2 = Delete"
    ],
    "registryName": "text",
    "dwordValue": 1,
    "displayName": "text",
    "hiveType": [
      "0 = HKEY_CURRENT_CONFIG",
      "1 = HKEY_USERS",
      "2 = HKEY_LOCAL_MACHINE",
      "3 = HKEY_CLASSES_ROOT"
    ],
    "path": "text",
    "regType": [
      "0 = REG_SZ",
      "1 = REG_DWORD",
      "2 = REG_QWORD",
      "3 = REG_MULTI_SZ",
      "4 = REG_EXPAND_SZ"
    ],
    "stringValue": "text"
  }
]

Success

Add

Adds Registry to the default optimization.

post

/api/RDSDefaultSettings/Optimization/Registry

Query parameters

siteIdinteger · int32

The Site Id of the optimization to retrieve the registry.

Body

actionstring · enum

<para type="synopsis">The action type for add registry entry</para> <para type="description"></para>

Options: 0 = Add,1 = Modify,2 = Delete

registryNamestring | nullable

dwordValueinteger · int32

<para type="synopsis">Value</para> <para type="description"></para>

displayNamestring | nullablerequired

<para type="synopsis">Display Name</para> <para type="description"></para>

hiveTypestring · enum

<para type="synopsis">The hive type for add registry entry</para> <para type="description"></para>

Options: 0 = HKEY_CURRENT_CONFIG,1 = HKEY_USERS,2 = HKEY_LOCAL_MACHINE,3 = HKEY_CLASSES_ROOT

pathstring | nullablerequired

regTypestring · enum

<para type="synopsis">The value type for add registry entry</para> <para type="description"></para>

Options: 0 = REG_SZ,1 = REG_DWORD,2 = REG_QWORD,3 = REG_MULTI_SZ,4 = REG_EXPAND_SZ

stringValuestring | nullable

<para type="synopsis">String Value</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/RDSDefaultSettings/Optimization/Registry' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "action": [
      "0 = Add",
      "1 = Modify",
      "2 = Delete"
    ],
    "registryName": "text",
    "dwordValue": 1,
    "displayName": "text",
    "hiveType": [
      "0 = HKEY_CURRENT_CONFIG",
      "1 = HKEY_USERS",
      "2 = HKEY_LOCAL_MACHINE",
      "3 = HKEY_CLASSES_ROOT"
    ],
    "path": "text",
    "regType": [
      "0 = REG_SZ",
      "1 = REG_DWORD",
      "2 = REG_QWORD",
      "3 = REG_MULTI_SZ",
      "4 = REG_EXPAND_SZ"
    ],
    "stringValue": "text"
  }'

201

401

404

409

No body

Created

Delete

Remove Default Registry Image Optimization Object.

delete

/api/RDSDefaultSettings/Optimization/Registry

Query parameters

siteIdinteger · int32

The Site Id of the Optimization Settings to remove the registry object.

Body

registryIdinteger · int32required

<para type="synopsis">Registry Id</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/RDSDefaultSettings/Optimization/Registry' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "registryId": 1
  }'

204

401

404

No body

No Content

List

Retrieve Default Windows Scheduled Task

get

/api/RDSDefaultSettings/Optimization/WindowsScheduledTask

Query parameters

siteIdinteger · int32

The Site Id of the optimization setting to retrieve the windows scheduled task.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/Optimization/WindowsScheduledTask'

200

401

404

[
  {
    "task": "text",
    "location": "text",
    "type": [
      "0 = Folder",
      "1 = Task"
    ]
  }
]

Success

Add

Adds a Windows Scheduled task to default optimization.

post

/api/RDSDefaultSettings/Optimization/WindowsScheduledTask

Query parameters

siteIdinteger · int32

The Site Id of the Optimization settings to retrieve the windows scheduled task.

Body

taskstring | nullablerequired

<para type="synopsis">Scheduled Task Name</para> <para type="description"></para>

locationstring | nullablerequired

<para type="synopsis">Scheduled Task Location</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/RDSDefaultSettings/Optimization/WindowsScheduledTask' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "task": "text",
    "location": "text"
  }'

201

401

404

409

No body

Created

Delete

Removes Default Windows Scheduled Task From Optimization.

delete

/api/RDSDefaultSettings/Optimization/WindowsScheduledTask

Query parameters

siteIdinteger · int32

The Site Id of the optimization setting to remove the windows scheduled task.

Body

taskstring | nullablerequired

<para type="synopsis">Scheduled Task</para> <para type="description"></para>

locationstring | nullablerequired

<para type="synopsis">Scheduled Task Location</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/RDSDefaultSettings/Optimization/WindowsScheduledTask' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "task": "text",
    "location": "text"
  }'

204

401

404

No body

No Content

Get

Retrieves the FSLogix General Settings of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/General

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix General Settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/General'

200

401

404

{
  "appServices": {
    "useCleanupInvalidSessions": true,
    "cleanupInvalidSessions": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamRecycleBin": true,
    "roamRecycleBin": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDCompactDisk": true,
    "vhdCompactDisk": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "cloudCacheGeneral": {
    "useCacheDirectory": true,
    "cacheDirectory": "text",
    "useWriteCacheDirectory": true,
    "writeCacheDirectory": "text",
    "useProxyDirectory": true,
    "proxyDirectory": "text",
    "useSilenceACLWarning": true,
    "silenceACLWarning": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "logging": {
    "logEnabled": [
      "0 = Disable",
      "1 = Specific",
      "2 = All"
    ],
    "logLevel": [
      "0 = Debug",
      "1 = Information",
      "2 = Warning",
      "3 = Error"
    ],
    "logFileKeepingPeriod": 1,
    "logDirectory": "text",
    "robocopyLogPath": "text",
    "logSpecificComponents": [
      "1 = ProfileConfigTool",
      "2 = IEPlugin",
      "4 = RuleEditor",
      "8 = JavaRuleEditor",
      "16 = FSLogixAgentService",
      "32 = Profile",
      "64 = JavaLauncher",
      "128 = OfficeContainer",
      "256 = RuleCompilation",
      "512 = FontVisibility",
      "1024 = Network",
      "2048 = PrinterVisibility",
      "4096 = ADSComputerGroup",
      "8192 = DriverInterface",
      "16384 = WindowsSearchRoaming",
      "32768 = WindowsSearchPlugin",
      "65536 = ProcessStartMonitor"
    ]
  }
}

Success

Update

Update the FSLogix General Settings of a Site Defaults object.

put

/api/RDSDefaultSettings/FSLogix/General

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix General Settings (optional).

Body

useCleanupInvalidSessionsboolean | nullable

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

cleanupInvalidSessionsstring · enum

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

Options: 0 = Disable,1 = Enable

useRoamRecycleBinboolean | nullable

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

roamRecycleBinstring · enum

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

Options: 0 = Disable,1 = Enable

useVHDCompactDiskboolean | nullable

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

vhdCompactDiskstring · enum

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

Options: 0 = Disable,1 = Enable

useCacheDirectoryboolean | nullable

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

cacheDirectorystring | nullable

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

useWriteCacheDirectoryboolean | nullable

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

writeCacheDirectorystring | nullable

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

useProxyDirectoryboolean | nullable

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

proxyDirectorystring | nullable

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

useSilenceACLWarningboolean | nullable

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

silenceACLWarningstring · enum

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

Options: 0 = Disable,1 = Enable

logEnabledstring · enum

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

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

logLevelstring · enum

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

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

logFileKeepingPeriodinteger · int32 | nullable

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

logDirectorystring | nullable

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

robocopyLogPathstring | nullable

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

logSpecificComponentsstring[Flag] · enum

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

Options:

1 = ProfileConfigTool,2 = IEPlugin,4 = RuleEditor,8 = JavaRuleEditor,16 = FSLogixAgentService,32 = Profile,64 = JavaLauncher,128 = OfficeContainer,256 = RuleCompilation,512 = FontVisibility,1024 = Network,2048 = PrinterVisibility,4096 = ADSComputerGroup,8192 = DriverInterface,16384 = WindowsSearchRoaming,32768 = WindowsSearchPlugin,65536 = ProcessStartMonitor

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/RDSDefaultSettings/FSLogix/General' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "useCleanupInvalidSessions": true,
    "cleanupInvalidSessions": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamRecycleBin": true,
    "roamRecycleBin": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDCompactDisk": true,
    "vhdCompactDisk": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useCacheDirectory": true,
    "cacheDirectory": "text",
    "useWriteCacheDirectory": true,
    "writeCacheDirectory": "text",
    "useProxyDirectory": true,
    "proxyDirectory": "text",
    "useSilenceACLWarning": true,
    "silenceACLWarning": [
      "0 = Disable",
      "1 = Enable"
    ],
    "logEnabled": [
      "0 = Disable",
      "1 = Specific",
      "2 = All"
    ],
    "logLevel": [
      "0 = Debug",
      "1 = Information",
      "2 = Warning",
      "3 = Error"
    ],
    "logFileKeepingPeriod": 1,
    "logDirectory": "text",
    "robocopyLogPath": "text",
    "logSpecificComponents": [
      "1 = ProfileConfigTool",
      "2 = IEPlugin",
      "4 = RuleEditor",
      "8 = JavaRuleEditor",
      "16 = FSLogixAgentService",
      "32 = Profile",
      "64 = JavaLauncher",
      "128 = OfficeContainer",
      "256 = RuleCompilation",
      "512 = FontVisibility",
      "1024 = Network",
      "2048 = PrinterVisibility",
      "4096 = ADSComputerGroup",
      "8192 = DriverInterface",
      "16384 = WindowsSearchRoaming",
      "32768 = WindowsSearchPlugin",
      "65536 = ProcessStartMonitor"
    ]
  }'

204

401

404

No body

No Content

List

Retrieve Default Windows Service Custom

get

/api/RDSDefaultSettings/Optimization/WindowsService

Query parameters

siteIDinteger · int32

The Site ID of the optimization setting to retrieve the windows service custom list.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/Optimization/WindowsService'

200

401

404

[
  {
    "type": [
      "0 = Predefined",
      "1 = Custom"
    ],
    "serviceName": "text",
    "displayName": "text",
    "aliases": "text"
  }
]

Success

Add

Adds a default Windows Service Custom to optimization.

post

/api/RDSDefaultSettings/Optimization/WindowsService

Query parameters

siteIDinteger · int32

The Site ID of the Optimization settings to retrieve the windows services custom.

Body

aliasesstring | nullable

<para type="synopsis">Windows Services Alias</para> <para type="description"></para>

displayNamestring | nullable

<para type="synopsis">Windows Services Diplay Name</para> <para type="description"></para>

serviceNamestring | nullable

<para type="synopsis">Windows Service Name</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/RDSDefaultSettings/Optimization/WindowsService' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "aliases": "text",
    "displayName": "text",
    "serviceName": "text"
  }'

201

401

404

409

No body

Created

Delete

Removes Default Windows Service Custom From Optimization.

delete

/api/RDSDefaultSettings/Optimization/WindowsService

Query parameters

siteIDinteger · int32

The ID of the optimization setting to remove the windows Service custom.

Body

serviceNamestring | nullable

<para type="synopsis">Windows Service Name</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/RDSDefaultSettings/Optimization/WindowsService' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "serviceName": "text"
  }'

204

401

404

No body

No Content

List

Retrieve Default Windows Custom Component

get

/api/RDSDefaultSettings/Optimization/WindowsComponent

Query parameters

siteIDinteger · int32

The Site ID of the optimization setting to retrieve the windows component custom list.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/Optimization/WindowsComponent'

200

401

404

[
  {
    "type": [
      "0 = Predefined",
      "1 = Custom"
    ],
    "componentName": "text",
    "displayName": "text",
    "aliases": "text"
  }
]

Success

Add

Adds a default Windows Component Custom to optimization.

post

/api/RDSDefaultSettings/Optimization/WindowsComponent

Query parameters

siteIDinteger · int32

The site ID of the Optimization settings to retrieve the windows component custom.

Body

aliasesstring | nullable

<para type="synopsis">Windows Components Alias</para> <para type="description"></para>

displayNamestring | nullable

<para type="synopsis">Windows Components Diplay Name</para> <para type="description"></para>

componentNamestring | nullable

<para type="synopsis">Windows Components Name</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/RDSDefaultSettings/Optimization/WindowsComponent' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "aliases": "text",
    "displayName": "text",
    "componentName": "text"
  }'

201

401

404

409

No body

Created

Delete

Removes Default Windows Component Custom From Optimization.

delete

/api/RDSDefaultSettings/Optimization/WindowsComponent

Query parameters

siteIDinteger · int32

The Site ID of the optimization setting to remove the windows component custom.

Body

componentNamestring | nullable

<para type="synopsis">Windows Component Name</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/RDSDefaultSettings/Optimization/WindowsComponent' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "componentName": "text"
  }'

204

401

404

No body

No Content

Get

Retrieves the FSLogix Office Container settings of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/OfficeContainer

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Office Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/OfficeContainer'

200

401

404

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

Success

Update

Update the FSLogix Office Container settings of a Site Defaults object.

put

/api/RDSDefaultSettings/FSLogix/OfficeContainer

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

officeContainerEnabledboolean | nullable

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

locationTypestring · enum

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

Options: 0 = SMBLocation,1 = CloudCache

vhdLocationsstring[] | nullable

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

ccdLocationsstring[] | nullable

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

profileDiskFormatstring · enum

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

Options: 0 = VHD,1 = VHDX

allocationTypestring · enum

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

Options: 0 = Dynamic,1 = Full

defaultSizeinteger · int32 | nullable

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

useLockedRetryCountboolean | nullable

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

lockedRetryCountinteger · int32 | nullable

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

useLockedRetryIntervalboolean | nullable

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

lockedRetryIntervalinteger · int32 | nullable

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

useAccessNetworkAsComputerObjectboolean | nullable

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

accessNetworkAsComputerObjectstring · enum

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

Options: 0 = Disable,1 = Enable

useAttachVHDSDDLboolean | nullable

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

attachVHDSDDLstring | nullable

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

useDiffDiskParentFolderPathboolean | nullable

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

diffDiskParentFolderPathstring | nullable

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

useFlipFlopProfileDirectoryNameboolean | nullable

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

flipFlopProfileDirectoryNamestring · enum

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

Options: 0 = Disable,1 = Enable

useNoProfileContainingFolderboolean | nullable

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

noProfileContainingFolderstring · enum

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

Options: 0 = Disable,1 = Enable

useOutlookCachedModeboolean | nullable

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

outlookCachedModestring · enum

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

Options: 0 = Disable,1 = Enable

usePreventLoginWithFailureboolean | nullable

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

preventLoginWithFailurestring · enum

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

Options: 0 = Disable,1 = Enable

usePreventLoginWithTempProfileboolean | nullable

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

preventLoginWithTempProfilestring · enum

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

Options: 0 = Disable,1 = Enable

useReAttachRetryCountboolean | nullable

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

reAttachRetryCountinteger · int32 | nullable

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

useReAttachIntervalSecondsboolean | nullable

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

reAttachIntervalSecondsinteger · int32 | nullable

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

useRemoveOrphanedOSTFilesOnLogoffboolean | nullable

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

removeOrphanedOSTFilesOnLogoffstring · enum

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

Options: 0 = Disable,1 = Enable

useRoamSearchboolean | nullable

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

roamSearchstring · enum

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

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

useSIDDirNameMatchboolean | nullable

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

sidDirNameMatchstring | nullable

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

useSIDDirNamePatternboolean | nullable

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

sidDirNamePatternstring | nullable

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

useSIDDirSDDLboolean | nullable

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

sidDirSDDLstring | nullable

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

useVHDNameMatchboolean | nullable

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

vhdNameMatchstring | nullable

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

useVHDNamePatternboolean | nullable

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

vhdNamePatternstring | nullable

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

useVHDXSectorSizeboolean | nullable

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

vhdxSectorSizestring · enum

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

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

useVolumeWaitTimeMSboolean | nullable

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

volumeWaitTimeMSinteger · int32 | nullable

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

useIgnoreNonAVDboolean | nullable

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

ignoreNonAVDstring · enum

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

Options: 0 = AnySession,1 = AVDSessions

useRedirectTypeboolean | nullable

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

redirectTypestring · enum

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

Options: 1 = Legacy,2 = Advanced

useIncludeOfficeActivationboolean | nullable

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

includeOfficeActivationstring · enum

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

Options: 0 = Disable,1 = Enable

useIncludeOneDriveboolean | nullable

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

includeOneDrivestring · enum

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

Options: 0 = Disable,1 = Enable

useIncludeOneNoteboolean | nullable

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

includeOneNotestring · enum

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

Options: 0 = Disable,1 = Enable

useIncludeOneNoteUWPboolean | nullable

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

includeOneNoteUWPstring · enum

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

Options: 0 = Disable,1 = Enable

useIncludeOutlookboolean | nullable

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

includeOutlookstring · enum

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

Options: 0 = Disable,1 = Enable

useIncludeOutlookPersonalizationboolean | nullable

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

includeOutlookPersonalizationstring · enum

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

Options: 0 = Disable,1 = Enable

useIncludeSharepointboolean | nullable

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

includeSharepointstring · enum

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

Options: 0 = Disable,1 = Enable

useIncludeSkypeboolean | nullable

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

includeSkypestring · enum

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

Options: 0 = Disable,1 = Enable

useIncludeTeamsboolean | nullable

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

includeTeamsstring · enum

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

Options: 0 = Disable,1 = Enable

useMirrorLocalOSTToVHDboolean | nullable

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

mirrorLocalOSTToVHDstring · enum

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

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

useNumSessionVHDsToKeepboolean | nullable

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

numSessionVHDsToKeepinteger · int32 | nullable

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

useOutlookFolderPathboolean | nullable

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

outlookFolderPathstring | nullable

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

useRefreshUserPolicyboolean | nullable

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

refreshUserPolicystring · enum

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

Options: 0 = Disable,1 = Enable

useVHDAccessModeboolean | nullable

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

vhdAccessModestring · enum

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

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

useMaxCacheSizeInMBsboolean | nullable

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

maxCacheSizeInMBsinteger · int32 | nullable

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

useClearCacheOnLogoffboolean | nullable

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

clearCacheOnLogoffstring · enum

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

Options: 0 = Disable,1 = Enable

useHealthyProvidersRequiredForRegisterboolean | nullable

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

healthyProvidersRequiredForRegisterinteger · int32 | nullable

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

useHealthyProvidersRequiredForUnregisterboolean | nullable

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

healthyProvidersRequiredForUnregisterinteger · int32 | nullable

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

useUnregisterTimeoutboolean | nullable

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

unregisterTimeoutinteger · int32 | nullable

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

useClearCacheOnForcedUnregisterboolean | nullable

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

clearCacheOnForcedUnregisterstring · enum

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

Options: 0 = Disable,1 = Enable

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/RDSDefaultSettings/FSLogix/OfficeContainer' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "officeContainerEnabled": true,
    "locationType": [
      "0 = SMBLocation",
      "1 = CloudCache"
    ],
    "vhdLocations": [
      "text"
    ],
    "ccdLocations": [
      "text"
    ],
    "profileDiskFormat": [
      "0 = VHD",
      "1 = VHDX"
    ],
    "allocationType": [
      "0 = Dynamic",
      "1 = Full"
    ],
    "defaultSize": 1,
    "useLockedRetryCount": true,
    "lockedRetryCount": 1,
    "useLockedRetryInterval": true,
    "lockedRetryInterval": 1,
    "useAccessNetworkAsComputerObject": true,
    "accessNetworkAsComputerObject": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useAttachVHDSDDL": true,
    "attachVHDSDDL": "text",
    "useDiffDiskParentFolderPath": true,
    "diffDiskParentFolderPath": "text",
    "useFlipFlopProfileDirectoryName": true,
    "flipFlopProfileDirectoryName": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useNoProfileContainingFolder": true,
    "noProfileContainingFolder": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useOutlookCachedMode": true,
    "outlookCachedMode": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithFailure": true,
    "preventLoginWithFailure": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithTempProfile": true,
    "preventLoginWithTempProfile": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useReAttachRetryCount": true,
    "reAttachRetryCount": 1,
    "useReAttachIntervalSeconds": true,
    "reAttachIntervalSeconds": 1,
    "useRemoveOrphanedOSTFilesOnLogoff": true,
    "removeOrphanedOSTFilesOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamSearch": true,
    "roamSearch": [
      "0 = Disable",
      "1 = SingleUser",
      "2 = MultiUser"
    ],
    "useSIDDirNameMatch": true,
    "sidDirNameMatch": "text",
    "useSIDDirNamePattern": true,
    "sidDirNamePattern": "text",
    "useSIDDirSDDL": true,
    "sidDirSDDL": "text",
    "useVHDNameMatch": true,
    "vhdNameMatch": "text",
    "useVHDNamePattern": true,
    "vhdNamePattern": "text",
    "useVHDXSectorSize": true,
    "vhdxSectorSize": [
      "0 = SystemDefault",
      "512 = Size_512",
      "4096 = Size_4096"
    ],
    "useVolumeWaitTimeMS": true,
    "volumeWaitTimeMS": 1,
    "useIgnoreNonAVD": true,
    "ignoreNonAVD": [
      "0 = AnySession",
      "1 = AVDSessions"
    ],
    "useRedirectType": true,
    "redirectType": [
      "1 = Legacy",
      "2 = Advanced"
    ],
    "useIncludeOfficeActivation": true,
    "includeOfficeActivation": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneDrive": true,
    "includeOneDrive": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNote": true,
    "includeOneNote": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNoteUWP": true,
    "includeOneNoteUWP": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlook": true,
    "includeOutlook": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlookPersonalization": true,
    "includeOutlookPersonalization": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSharepoint": true,
    "includeSharepoint": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSkype": true,
    "includeSkype": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeTeams": true,
    "includeTeams": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useMirrorLocalOSTToVHD": true,
    "mirrorLocalOSTToVHD": [
      "0 = DoNothing",
      "1 = Copy",
      "2 = Move"
    ],
    "useNumSessionVHDsToKeep": true,
    "numSessionVHDsToKeep": 1,
    "useOutlookFolderPath": true,
    "outlookFolderPath": "text",
    "useRefreshUserPolicy": true,
    "refreshUserPolicy": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDAccessMode": true,
    "vhdAccessMode": [
      "0 = NormalDirectAccess",
      "1 = DiffDiskNetwork",
      "2 = DiffDiskLocal",
      "3 = UniqueVHDPerSession"
    ],
    "useMaxCacheSizeInMBs": true,
    "maxCacheSizeInMBs": 1,
    "useClearCacheOnLogoff": true,
    "clearCacheOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useHealthyProvidersRequiredForRegister": true,
    "healthyProvidersRequiredForRegister": 1,
    "useHealthyProvidersRequiredForUnregister": true,
    "healthyProvidersRequiredForUnregister": 1,
    "useUnregisterTimeout": true,
    "unregisterTimeout": 1,
    "useClearCacheOnForcedUnregister": true,
    "clearCacheOnForcedUnregister": [
      "0 = Disable",
      "1 = Enable"
    ]
  }'

204

401

404

No body

No Content

Get

Retrieves FSLogix Office Container User Exclusion List of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/OfficeContainer/UserExclusion

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Office Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/OfficeContainer/UserExclusion'

200

401

404

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

Success

Add

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

post

/api/RDSDefaultSettings/FSLogix/OfficeContainer/UserExclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

accountstring | nullable

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

sidstring | nullable

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No body

Created

Remove

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

delete

/api/RDSDefaultSettings/FSLogix/OfficeContainer/UserExclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

accountstring | nullable

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

sidstring | nullable

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No body

No Content

Get

Retrieve the FSLogix Profile Container settings of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/ProfileContainer

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/ProfileContainer'

200

401

404

{
  "enabled": true,
  "locationType": [
    "0 = SMBLocation",
    "1 = CloudCache"
  ],
  "vhdLocations": [
    "text"
  ],
  "ccdLocations": [
    "text"
  ],
  "profileDiskFormat": [
    "0 = VHD",
    "1 = VHDX"
  ],
  "allocationType": [
    "0 = Dynamic",
    "1 = Full"
  ],
  "defaultSize": 1,
  "userInclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "userExclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "cloudCache": {
    "useMaxCacheSizeInMBs": true,
    "maxCacheSizeInMBs": 1,
    "useClearCacheOnLogoff": true,
    "clearCacheOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useHealthyProvidersRequiredForRegister": true,
    "healthyProvidersRequiredForRegister": 1,
    "useHealthyProvidersRequiredForUnregister": true,
    "healthyProvidersRequiredForUnregister": 1,
    "useUnregisterTimeout": true,
    "unregisterTimeout": 1,
    "useClearCacheOnForcedUnregister": true,
    "clearCacheOnForcedUnregister": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "customizeProfileFolders": true,
  "excludeCommonFolders": [
    "1 = Contacts",
    "2 = Desktop",
    "4 = Documents",
    "8 = Links",
    "16 = MusicPodcasts",
    "32 = PicturesVideos",
    "64 = FoldersLowIntegProcesses",
    "128 = Downloads"
  ],
  "folderInclusionList": [
    "text"
  ],
  "folderExclusionList": [
    {
      "folder": "text",
      "excludeFolderCopy": [
        "0 = None",
        "1 = CopyBase",
        "2 = CopyBack"
      ]
    }
  ],
  "advancedSettings": {
    "useLockedRetryCount": true,
    "lockedRetryCount": 1,
    "useLockedRetryInterval": true,
    "lockedRetryInterval": 1,
    "useAccessNetworkAsComputerObject": true,
    "accessNetworkAsComputerObject": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useAttachVHDSDDL": true,
    "attachVHDSDDL": "text",
    "useDiffDiskParentFolderPath": true,
    "diffDiskParentFolderPath": "text",
    "useFlipFlopProfileDirectoryName": true,
    "flipFlopProfileDirectoryName": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useNoProfileContainingFolder": true,
    "noProfileContainingFolder": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useOutlookCachedMode": true,
    "outlookCachedMode": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithFailure": true,
    "preventLoginWithFailure": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithTempProfile": true,
    "preventLoginWithTempProfile": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useReAttachRetryCount": true,
    "reAttachRetryCount": 1,
    "useReAttachIntervalSeconds": true,
    "reAttachIntervalSeconds": 1,
    "useRemoveOrphanedOSTFilesOnLogoff": true,
    "removeOrphanedOSTFilesOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamSearch": true,
    "roamSearch": [
      "0 = Disable",
      "1 = SingleUser",
      "2 = MultiUser"
    ],
    "useSIDDirNameMatch": true,
    "sidDirNameMatch": "text",
    "useSIDDirNamePattern": true,
    "sidDirNamePattern": "text",
    "useSIDDirSDDL": true,
    "sidDirSDDL": "text",
    "useVHDNameMatch": true,
    "vhdNameMatch": "text",
    "useVHDNamePattern": true,
    "vhdNamePattern": "text",
    "useVHDXSectorSize": true,
    "vhdxSectorSize": [
      "0 = SystemDefault",
      "512 = Size_512",
      "4096 = Size_4096"
    ],
    "useVolumeWaitTimeMS": true,
    "volumeWaitTimeMS": 1,
    "useIgnoreNonAVD": true,
    "ignoreNonAVD": [
      "0 = AnySession",
      "1 = AVDSessions"
    ],
    "useRedirectType": true,
    "redirectType": [
      "1 = Legacy",
      "2 = Advanced"
    ],
    "useKeepLocalDir": true,
    "keepLocalDir": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useDeleteLocalProfileWhenVHDShouldApply": true,
    "deleteLocalProfileWhenVHDShouldApply": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useProfileDirSDDL": true,
    "profileDirSDDL": "text",
    "useProfileType": true,
    "profileType": [
      "0 = NormalProfile",
      "1 = OnlyRWProfile",
      "2 = OnlyROProfile",
      "3 = RWROProfile"
    ],
    "useSetTempToLocalPath": true,
    "setTempToLocalPath": [
      "0 = TakeNoAction",
      "1 = RedirectTempAndTmp",
      "2 = RedirectINetCache",
      "3 = RedirectTempTmpAndINetCache"
    ],
    "useCleanOutNotifications": true,
    "cleanOutNotifications": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useInstallAppxPackages": true,
    "installAppxPackages": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRebootOnUserLogoff": true,
    "rebootOnUserLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamIdentity": true,
    "roamIdentity": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useShutdownOnUserLogoff": true,
    "shutdownOnUserLogoff": [
      "0 = Disable",
      "1 = Enable"
    ]
  }
}

Success

Update

Update the FSLogix Profile Container settings of a Site Defaults object.

put

/api/RDSDefaultSettings/FSLogix/ProfileContainer

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to modify the FSLogix Profile Container settings (optional).

Body

profileContainerEnabledboolean | nullable

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

locationTypestring · enum

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

Options: 0 = SMBLocation,1 = CloudCache

vhdLocationsstring[] | nullable

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

ccdLocationsstring[] | nullable

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

profileDiskFormatstring · enum

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

Options: 0 = VHD,1 = VHDX

allocationTypestring · enum

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

Options: 0 = Dynamic,1 = Full

defaultSizeinteger · int32 | nullable

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

customizeProfileFoldersboolean | nullable

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

excludeCommonFoldersstring[Flag] · enum

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

Options:

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

useLockedRetryCountboolean | nullable

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

lockedRetryCountinteger · int32 | nullable

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

useLockedRetryIntervalboolean | nullable

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

lockedRetryIntervalinteger · int32 | nullable

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

useAccessNetworkAsComputerObjectboolean | nullable

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

accessNetworkAsComputerObjectstring · enum

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

Options: 0 = Disable,1 = Enable

useAttachVHDSDDLboolean | nullable

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

attachVHDSDDLstring | nullable

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

useDiffDiskParentFolderPathboolean | nullable

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

diffDiskParentFolderPathstring | nullable

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

useFlipFlopProfileDirectoryNameboolean | nullable

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

flipFlopProfileDirectoryNamestring · enum

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

Options: 0 = Disable,1 = Enable

useNoProfileContainingFolderboolean | nullable

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

noProfileContainingFolderstring · enum

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

Options: 0 = Disable,1 = Enable

useOutlookCachedModeboolean | nullable

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

outlookCachedModestring · enum

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

Options: 0 = Disable,1 = Enable

usePreventLoginWithFailureboolean | nullable

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

preventLoginWithFailurestring · enum

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

Options: 0 = Disable,1 = Enable

usePreventLoginWithTempProfileboolean | nullable

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

preventLoginWithTempProfilestring · enum

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

Options: 0 = Disable,1 = Enable

useReAttachRetryCountboolean | nullable

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

reAttachRetryCountinteger · int32 | nullable

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

useReAttachIntervalSecondsboolean | nullable

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

reAttachIntervalSecondsinteger · int32 | nullable

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

useRemoveOrphanedOSTFilesOnLogoffboolean | nullable

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

removeOrphanedOSTFilesOnLogoffstring · enum

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

Options: 0 = Disable,1 = Enable

useRoamSearchboolean | nullable

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

roamSearchstring · enum

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

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

useSIDDirNameMatchboolean | nullable

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

sidDirNameMatchstring | nullable

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

useSIDDirNamePatternboolean | nullable

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

sidDirNamePatternstring | nullable

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

useSIDDirSDDLboolean | nullable

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

sidDirSDDLstring | nullable

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

useVHDNameMatchboolean | nullable

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

vhdNameMatchstring | nullable

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

useVHDNamePatternboolean | nullable

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

vhdNamePatternstring | nullable

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

useVHDXSectorSizeboolean | nullable

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

vhdxSectorSizestring · enum

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

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

useVolumeWaitTimeMSboolean | nullable

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

volumeWaitTimeMSinteger · int32 | nullable

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

useIgnoreNonAVDboolean | nullable

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

ignoreNonAVDstring · enum

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

Options: 0 = AnySession,1 = AVDSessions

useRedirectTypeboolean | nullable

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

redirectTypestring · enum

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

Options: 1 = Legacy,2 = Advanced

useKeepLocalDirboolean | nullable

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

keepLocalDirstring · enum

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

Options: 0 = Disable,1 = Enable

useDeleteLocalProfileWhenVHDShouldApplyboolean | nullable

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

deleteLocalProfileWhenVHDShouldApplystring · enum

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

Options: 0 = Disable,1 = Enable

useProfileDirSDDLboolean | nullable

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

profileDirSDDLstring | nullable

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

useProfileTypeboolean | nullable

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

profileTypestring · enum

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

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

useSetTempToLocalPathboolean | nullable

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

setTempToLocalPathstring · enum

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

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

useCleanOutNotificationsboolean | nullable

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

cleanOutNotificationsstring · enum

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

Options: 0 = Disable,1 = Enable

useInstallAppxPackagesboolean | nullable

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

installAppxPackagesstring · enum

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

Options: 0 = Disable,1 = Enable

useRebootOnUserLogoffboolean | nullable

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

rebootOnUserLogoffstring · enum

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

Options: 0 = Disable,1 = Enable

useRoamIdentityboolean | nullable

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

roamIdentitystring · enum

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

Options: 0 = Disable,1 = Enable

useShutdownOnUserLogoffboolean | nullable

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

shutdownOnUserLogoffstring · enum

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

Options: 0 = Disable,1 = Enable

useMaxCacheSizeInMBsboolean | nullable

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

maxCacheSizeInMBsinteger · int32 | nullable

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

useClearCacheOnLogoffboolean | nullable

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

clearCacheOnLogoffstring · enum

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

Options: 0 = Disable,1 = Enable

useHealthyProvidersRequiredForRegisterboolean | nullable

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

healthyProvidersRequiredForRegisterinteger · int32 | nullable

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

useHealthyProvidersRequiredForUnregisterboolean | nullable

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

healthyProvidersRequiredForUnregisterinteger · int32 | nullable

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

useUnregisterTimeoutboolean | nullable

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

unregisterTimeoutinteger · int32 | nullable

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

useClearCacheOnForcedUnregisterboolean | nullable

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

clearCacheOnForcedUnregisterstring · enum

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

Options: 0 = Disable,1 = Enable

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/RDSDefaultSettings/FSLogix/ProfileContainer' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "profileContainerEnabled": true,
    "locationType": [
      "0 = SMBLocation",
      "1 = CloudCache"
    ],
    "vhdLocations": [
      "text"
    ],
    "ccdLocations": [
      "text"
    ],
    "profileDiskFormat": [
      "0 = VHD",
      "1 = VHDX"
    ],
    "allocationType": [
      "0 = Dynamic",
      "1 = Full"
    ],
    "defaultSize": 1,
    "customizeProfileFolders": true,
    "excludeCommonFolders": [
      "1 = Contacts",
      "2 = Desktop",
      "4 = Documents",
      "8 = Links",
      "16 = MusicPodcasts",
      "32 = PicturesVideos",
      "64 = FoldersLowIntegProcesses",
      "128 = Downloads"
    ],
    "useLockedRetryCount": true,
    "lockedRetryCount": 1,
    "useLockedRetryInterval": true,
    "lockedRetryInterval": 1,
    "useAccessNetworkAsComputerObject": true,
    "accessNetworkAsComputerObject": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useAttachVHDSDDL": true,
    "attachVHDSDDL": "text",
    "useDiffDiskParentFolderPath": true,
    "diffDiskParentFolderPath": "text",
    "useFlipFlopProfileDirectoryName": true,
    "flipFlopProfileDirectoryName": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useNoProfileContainingFolder": true,
    "noProfileContainingFolder": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useOutlookCachedMode": true,
    "outlookCachedMode": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithFailure": true,
    "preventLoginWithFailure": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithTempProfile": true,
    "preventLoginWithTempProfile": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useReAttachRetryCount": true,
    "reAttachRetryCount": 1,
    "useReAttachIntervalSeconds": true,
    "reAttachIntervalSeconds": 1,
    "useRemoveOrphanedOSTFilesOnLogoff": true,
    "removeOrphanedOSTFilesOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamSearch": true,
    "roamSearch": [
      "0 = Disable",
      "1 = SingleUser",
      "2 = MultiUser"
    ],
    "useSIDDirNameMatch": true,
    "sidDirNameMatch": "text",
    "useSIDDirNamePattern": true,
    "sidDirNamePattern": "text",
    "useSIDDirSDDL": true,
    "sidDirSDDL": "text",
    "useVHDNameMatch": true,
    "vhdNameMatch": "text",
    "useVHDNamePattern": true,
    "vhdNamePattern": "text",
    "useVHDXSectorSize": true,
    "vhdxSectorSize": [
      "0 = SystemDefault",
      "512 = Size_512",
      "4096 = Size_4096"
    ],
    "useVolumeWaitTimeMS": true,
    "volumeWaitTimeMS": 1,
    "useIgnoreNonAVD": true,
    "ignoreNonAVD": [
      "0 = AnySession",
      "1 = AVDSessions"
    ],
    "useRedirectType": true,
    "redirectType": [
      "1 = Legacy",
      "2 = Advanced"
    ],
    "useKeepLocalDir": true,
    "keepLocalDir": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useDeleteLocalProfileWhenVHDShouldApply": true,
    "deleteLocalProfileWhenVHDShouldApply": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useProfileDirSDDL": true,
    "profileDirSDDL": "text",
    "useProfileType": true,
    "profileType": [
      "0 = NormalProfile",
      "1 = OnlyRWProfile",
      "2 = OnlyROProfile",
      "3 = RWROProfile"
    ],
    "useSetTempToLocalPath": true,
    "setTempToLocalPath": [
      "0 = TakeNoAction",
      "1 = RedirectTempAndTmp",
      "2 = RedirectINetCache",
      "3 = RedirectTempTmpAndINetCache"
    ],
    "useCleanOutNotifications": true,
    "cleanOutNotifications": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useInstallAppxPackages": true,
    "installAppxPackages": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRebootOnUserLogoff": true,
    "rebootOnUserLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamIdentity": true,
    "roamIdentity": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useShutdownOnUserLogoff": true,
    "shutdownOnUserLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useMaxCacheSizeInMBs": true,
    "maxCacheSizeInMBs": 1,
    "useClearCacheOnLogoff": true,
    "clearCacheOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useHealthyProvidersRequiredForRegister": true,
    "healthyProvidersRequiredForRegister": 1,
    "useHealthyProvidersRequiredForUnregister": true,
    "healthyProvidersRequiredForUnregister": 1,
    "useUnregisterTimeout": true,
    "unregisterTimeout": 1,
    "useClearCacheOnForcedUnregister": true,
    "clearCacheOnForcedUnregister": [
      "0 = Disable",
      "1 = Enable"
    ]
  }'

204

401

404

No body

No Content

Get

Retrieves FSLogix Office Container VHDLocation List of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/OfficeContainer/VHDLocations

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Office Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/OfficeContainer/VHDLocations'

200

401

404

[
  "text"
]

Success

Add

Adds a VHDLocation to the VHDLocation List of the FSLogix Office Container settings.

post

/api/RDSDefaultSettings/FSLogix/OfficeContainer/VHDLocations

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

vhdLocationstring | nullablerequired

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No body

Created

Remove

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

delete

/api/RDSDefaultSettings/FSLogix/OfficeContainer/VHDLocations

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

vhdLocationstring | nullablerequired

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No body

No Content

Get

Retrieve FSLogix Profile Container User Exclusion List of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/ProfileContainer/UserExclusion

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/ProfileContainer/UserExclusion'

200

401

404

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

Success

Add

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

post

/api/RDSDefaultSettings/FSLogix/ProfileContainer/UserExclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

accountstring | nullable

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

sidstring | nullable

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No body

Created

Delete

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

delete

/api/RDSDefaultSettings/FSLogix/ProfileContainer/UserExclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

accountstring | nullable

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

sidstring | nullable

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No body

No Content

Get

Retrieve FSLogix Profile Container User Inclusion List of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/ProfileContainer/UserInclusion

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/ProfileContainer/UserInclusion'

200

401

404

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

Success

Add

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

post

/api/RDSDefaultSettings/FSLogix/ProfileContainer/UserInclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

accountstring | nullable

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

sidstring | nullable

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No body

Created

Delete

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

delete

/api/RDSDefaultSettings/FSLogix/ProfileContainer/UserInclusion

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

accountstring | nullable

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

sidstring | nullable

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No body

No Content

Get

Retrieve FSLogix Profile Container VHDLocation List of a Site Defaults object.

get

/api/RDSDefaultSettings/FSLogix/ProfileContainer/VHDLocations

Query parameters

siteIdinteger · int32

The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSDefaultSettings/FSLogix/ProfileContainer/VHDLocations'

200

401

404

[
  "text"
]

Success

Add

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

post

/api/RDSDefaultSettings/FSLogix/ProfileContainer/VHDLocations

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

vhdLocationstring | nullablerequired

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No body

Created

Delete

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

delete

/api/RDSDefaultSettings/FSLogix/ProfileContainer/VHDLocations

Query parameters

siteIdinteger · int32

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

vhdLocationstring | nullablerequired

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No body

No Content