Host

List

Retrieve a list of RD Session Host settings. The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.

GET/api/RDS/Host

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

servernullable string

Server name.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

directAddressnullable string

The direct address of the target RD Session Host server.

rasTemplateIdinteger (int32)

The RDSH RAS Template ID.

inheritDefaultAgentSettingsboolean

If true, default agent settings will be inherited.

inheritDefaultPrinterSettingsboolean

If true, default printer settings will be inherited.

inheritDefaultUserProfileSettingsboolean

If true, default User Profile settings will be inherited.

inheritDefaultDesktopAccessSettingsboolean

If true, default desktop access settings will be inherited.

inheritDefaultOptimizationSettingsnullable boolean

If true, default optimization settings will be inherited.

inheritDefaultAppPackageSettingsboolean

If true, default app package settings will be inherited.

portinteger (int32)

The port number of RD Session Host agent.

maxSessionsinteger (int32)

Maximum number of session a RDS Host can have.

disconnectActiveSessionAfterinteger (int32)

Disconnect active session after (in seconds). 0 - Never.

logoffDisconnectedSessionAfterinteger (int32)

Logoff disconnected session after (in seconds). 0 - Never; 1 - Immediate.

allowURLAndMailRedirectionAllowURLAndMailRedirection (enum)

URL and Mail Redirection values.

0 = Disabled,1 = Enabled,2 = EnabledWithAppRegistration

supportShellURLNamespaceObjectsboolean

Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.

allowRemoteExecboolean

Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.

enableAppMonitoringboolean

Specifies if 'Application Monitoring' option is enabled or disabled.

useRemoteAppsboolean

Specifies if 'Use RemoteApps if available' option is enables or disabled.

allowFileTransferboolean

Specifies if 'Allow file transfer' option is enables or disabled. (deprecated)

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

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

fileTransferLocationnullable string

Location where the File Transfer takes place, if and where it is allowed.

fileTransferLockLocationboolean

Lock Location where the File Transfer takes place, if and where it is allowed.

allowDragAndDropboolean

Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated)

dragAndDropModeDragAndDropModeValue (enum)

Drag and drop redirection values.

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

preferredBrokerIdinteger (int32)

The preferred Connection broker ID.

enableDriveRedirectionCacheboolean

Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.

manageRDPTransportProtocolManageRDPTransportProtocol (enum)

Manage RDP transport protocol.

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

enablePrintingboolean

Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.

enableTWAINboolean

Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.

enableWIAboolean

Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.

printerNameFormatPrnNameFormat (enum)

Printer Name Format

0 = PrnFormat_PRN_CMP_SES,1 = PrnFormat_SES_CMP_PRN,2 = PrnFormat_PRN_REDSES

removeClientNameFromPrinterNameboolean

Specifies if 'Remove client name from printer name' option is enabled or disabled.

removeSessionNumberFromPrinterNameboolean

Specifies if 'Remove session number from printer name' option is enabled or disabled.

technologyUserProfileTech (enum)

User Profile Technology values.

0 = DoNotManage,1 = UPD,2 = FSLogix

fsLogixFSLogixSettings (object)

FXLogix Settings

updModeUPDMode (enum)

User Profile Disk Mode.

0 = DoNotChange,1 = Enabled,2 = Disabled

maxUserProfileDiskSizeGBinteger (int32)

Specifies the max user profile disk size (in GB).

diskPathnullable string

Specifies the User Profile Disk path.

roamingModeUPDRoamingMode (enum)

User Profile Disk Roaming Mode.

0 = Exclude,2 = Include

includeFolderPathnullable array of string

Specifies the UPD 'Include' folder paths.

includeFilePathnullable array of string

Specifies the UPD 'Include' file paths.

excludeFolderPathnullable array of string

Specifies the UPD 'Exclude' folder paths.

excludeFilePathnullable array of string

Specifies the UPD 'Exclude' file paths.

restrictDesktopAccessboolean

Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled.

restrictedUsersnullable array of string

Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.

enableOptimizationboolean

optimizationImageOptimization (object)

Image Optimization

appPackagesAssignedAppPackagesAssigned (object)

Application Packages Assigned

Request

JavaScriptCurlPython

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

Response

200401404

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T07:39:24.494Z",
    "timeLastMod": "2024-11-07T07:39:24.494Z",
    "server": "text",
    "enabled": false,
    "description": "text",
    "directAddress": "text",
    "inheritDefaultAgentSettings": false,
    "inheritDefaultPrinterSettings": false,
    "inheritDefaultUserProfileSettings": false,
    "inheritDefaultDesktopAccessSettings": false,
    "inheritDefaultOptimizationSettings": false,
    "inheritDefaultAppPackageSettings": false,
    "allowURLAndMailRedirection": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = EnabledWithAppRegistration"
    ],
    "supportShellURLNamespaceObjects": false,
    "allowRemoteExec": false,
    "enableAppMonitoring": false,
    "useRemoteApps": false,
    "allowFileTransfer": false,
    "fileTransferMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "fileTransferLocation": "text",
    "fileTransferLockLocation": false,
    "allowDragAndDrop": false,
    "dragAndDropMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "enableDriveRedirectionCache": false,
    "manageRDPTransportProtocol": [
      "0 = Disabled",
      "1 = BothUDPTCP",
      "2 = OnlyTCP",
      "3 = EitherUDPTCP"
    ],
    "enablePrinting": false,
    "enableTWAIN": false,
    "enableWIA": false,
    "printerNameFormat": [
      "0 = PrnFormat_PRN_CMP_SES",
      "1 = PrnFormat_SES_CMP_PRN",
      "2 = PrnFormat_PRN_REDSES"
    ],
    "removeClientNameFromPrinterName": false,
    "removeSessionNumberFromPrinterName": false,
    "technology": [
      "0 = DoNotManage",
      "1 = UPD",
      "2 = FSLogix"
    ],
    "fsLogix": {
      "profileContainer": {
        "enabled": false,
        "locationType": [
          "0 = SMBLocation",
          "1 = CloudCache"
        ],
        "vhdLocations": [
          "text"
        ],
        "ccdLocations": [
          "text"
        ],
        "profileDiskFormat": [
          "0 = VHD",
          "1 = VHDX"
        ],
        "allocationType": [
          "0 = Dynamic",
          "1 = Full"
        ],
        "userInclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "userExclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "cloudCache": {
          "useMaxCacheSizeInMBs": false,
          "useClearCacheOnLogoff": false,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": false,
          "useHealthyProvidersRequiredForUnregister": false,
          "useUnregisterTimeout": false,
          "useClearCacheOnForcedUnregister": false,
          "clearCacheOnForcedUnregister": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "customizeProfileFolders": false,
        "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": false,
          "useLockedRetryInterval": false,
          "useAccessNetworkAsComputerObject": false,
          "accessNetworkAsComputerObject": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useAttachVHDSDDL": false,
          "attachVHDSDDL": "text",
          "useDiffDiskParentFolderPath": false,
          "diffDiskParentFolderPath": "text",
          "useFlipFlopProfileDirectoryName": false,
          "flipFlopProfileDirectoryName": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useNoProfileContainingFolder": false,
          "noProfileContainingFolder": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useOutlookCachedMode": false,
          "outlookCachedMode": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithFailure": false,
          "preventLoginWithFailure": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithTempProfile": false,
          "preventLoginWithTempProfile": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useReAttachRetryCount": false,
          "useReAttachIntervalSeconds": false,
          "useRemoveOrphanedOSTFilesOnLogoff": false,
          "removeOrphanedOSTFilesOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamSearch": false,
          "roamSearch": [
            "0 = Disable",
            "1 = SingleUser",
            "2 = MultiUser"
          ],
          "useSIDDirNameMatch": false,
          "sidDirNameMatch": "text",
          "useSIDDirNamePattern": false,
          "sidDirNamePattern": "text",
          "useSIDDirSDDL": false,
          "sidDirSDDL": "text",
          "useVHDNameMatch": false,
          "vhdNameMatch": "text",
          "useVHDNamePattern": false,
          "vhdNamePattern": "text",
          "useVHDXSectorSize": false,
          "vhdxSectorSize": [
            "0 = SystemDefault",
            "512 = Size_512",
            "4096 = Size_4096"
          ],
          "useVolumeWaitTimeMS": false,
          "useIgnoreNonAVD": false,
          "ignoreNonAVD": [
            "0 = AnySession",
            "1 = AVDSessions"
          ],
          "useRedirectType": false,
          "redirectType": [
            "1 = Legacy",
            "2 = Advanced"
          ],
          "useKeepLocalDir": false,
          "keepLocalDir": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useDeleteLocalProfileWhenVHDShouldApply": false,
          "deleteLocalProfileWhenVHDShouldApply": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useProfileDirSDDL": false,
          "profileDirSDDL": "text",
          "useProfileType": false,
          "profileType": [
            "0 = NormalProfile",
            "1 = OnlyRWProfile",
            "2 = OnlyROProfile",
            "3 = RWROProfile"
          ],
          "useSetTempToLocalPath": false,
          "setTempToLocalPath": [
            "0 = TakeNoAction",
            "1 = RedirectTempAndTmp",
            "2 = RedirectINetCache",
            "3 = RedirectTempTmpAndINetCache"
          ],
          "useCleanOutNotifications": false,
          "cleanOutNotifications": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useInstallAppxPackages": false,
          "installAppxPackages": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRebootOnUserLogoff": false,
          "rebootOnUserLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamIdentity": false,
          "roamIdentity": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useShutdownOnUserLogoff": false,
          "shutdownOnUserLogoff": [
            "0 = Disable",
            "1 = Enable"
          ]
        }
      },
      "officeContainer": {
        "enabled": false,
        "locationType": [
          "0 = SMBLocation",
          "1 = CloudCache"
        ],
        "vhdLocations": [
          "text"
        ],
        "ccdLocations": [
          "text"
        ],
        "profileDiskFormat": [
          "0 = VHD",
          "1 = VHDX"
        ],
        "allocationType": [
          "0 = Dynamic",
          "1 = Full"
        ],
        "userInclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "userExclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "cloudCache": {
          "useMaxCacheSizeInMBs": false,
          "useClearCacheOnLogoff": false,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": false,
          "useHealthyProvidersRequiredForUnregister": false,
          "useUnregisterTimeout": false,
          "useClearCacheOnForcedUnregister": false,
          "clearCacheOnForcedUnregister": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "advancedSettings": {
          "useLockedRetryCount": false,
          "useLockedRetryInterval": false,
          "useAccessNetworkAsComputerObject": false,
          "accessNetworkAsComputerObject": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useAttachVHDSDDL": false,
          "attachVHDSDDL": "text",
          "useDiffDiskParentFolderPath": false,
          "diffDiskParentFolderPath": "text",
          "useFlipFlopProfileDirectoryName": false,
          "flipFlopProfileDirectoryName": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useNoProfileContainingFolder": false,
          "noProfileContainingFolder": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useOutlookCachedMode": false,
          "outlookCachedMode": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithFailure": false,
          "preventLoginWithFailure": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithTempProfile": false,
          "preventLoginWithTempProfile": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useReAttachRetryCount": false,
          "useReAttachIntervalSeconds": false,
          "useRemoveOrphanedOSTFilesOnLogoff": false,
          "removeOrphanedOSTFilesOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamSearch": false,
          "roamSearch": [
            "0 = Disable",
            "1 = SingleUser",
            "2 = MultiUser"
          ],
          "useSIDDirNameMatch": false,
          "sidDirNameMatch": "text",
          "useSIDDirNamePattern": false,
          "sidDirNamePattern": "text",
          "useSIDDirSDDL": false,
          "sidDirSDDL": "text",
          "useVHDNameMatch": false,
          "vhdNameMatch": "text",
          "useVHDNamePattern": false,
          "vhdNamePattern": "text",
          "useVHDXSectorSize": false,
          "vhdxSectorSize": [
            "0 = SystemDefault",
            "512 = Size_512",
            "4096 = Size_4096"
          ],
          "useVolumeWaitTimeMS": false,
          "useIgnoreNonAVD": false,
          "ignoreNonAVD": [
            "0 = AnySession",
            "1 = AVDSessions"
          ],
          "useRedirectType": false,
          "redirectType": [
            "1 = Legacy",
            "2 = Advanced"
          ],
          "useIncludeOfficeActivation": false,
          "includeOfficeActivation": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneDrive": false,
          "includeOneDrive": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneNote": false,
          "includeOneNote": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneNoteUWP": false,
          "includeOneNoteUWP": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOutlook": false,
          "includeOutlook": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOutlookPersonalization": false,
          "includeOutlookPersonalization": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeSharepoint": false,
          "includeSharepoint": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeSkype": false,
          "includeSkype": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeTeams": false,
          "includeTeams": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useMirrorLocalOSTToVHD": false,
          "mirrorLocalOSTToVHD": [
            "0 = DoNothing",
            "1 = Copy",
            "2 = Move"
          ],
          "useNumSessionVHDsToKeep": false,
          "useOutlookFolderPath": false,
          "outlookFolderPath": "text",
          "useRefreshUserPolicy": false,
          "refreshUserPolicy": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useVHDAccessMode": false,
          "vhdAccessMode": [
            "0 = NormalDirectAccess",
            "1 = DiffDiskNetwork",
            "2 = DiffDiskLocal",
            "3 = UniqueVHDPerSession"
          ]
        }
      },
      "generalSettings": {
        "appServices": {
          "useCleanupInvalidSessions": false,
          "cleanupInvalidSessions": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamRecycleBin": false,
          "roamRecycleBin": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useVHDCompactDisk": false,
          "vhdCompactDisk": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "cloudCacheGeneral": {
          "useCacheDirectory": false,
          "cacheDirectory": "text",
          "useWriteCacheDirectory": false,
          "writeCacheDirectory": "text",
          "useProxyDirectory": false,
          "proxyDirectory": "text",
          "useSilenceACLWarning": false,
          "silenceACLWarning": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "logging": {
          "logEnabled": [
            "0 = Disable",
            "1 = Specific",
            "2 = All"
          ],
          "logLevel": [
            "0 = Debug",
            "1 = Information",
            "2 = Warning",
            "3 = Error"
          ],
          "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"
    ],
    "diskPath": "text",
    "roamingMode": [
      "0 = Exclude",
      "2 = Include"
    ],
    "includeFolderPath": [
      "text"
    ],
    "includeFilePath": [
      "text"
    ],
    "excludeFolderPath": [
      "text"
    ],
    "excludeFilePath": [
      "text"
    ],
    "restrictDesktopAccess": false,
    "restrictedUsers": [
      "text"
    ],
    "enableOptimization": false,
    "optimization": {
      "enableOptimization": false,
      "optimizationType": [
        "0 = Automatic",
        "1 = Manual"
      ],
      "windowsDefenderATP": {
        "winDefATPTurnOffOn": [
          "0 = TurnOffWindowsDefenderATP",
          "1 = TurnOnWindowsDefenderATP"
        ],
        "disableRealTimeProtection": false,
        "excludeFolders": [
          "text"
        ],
        "excludeProcesses": [
          "text"
        ],
        "excludeExtension": [
          "text"
        ]
      },
      "windowsComponents": {
        "windowsComponentsList": [
          {
            "type": [
              "0 = Predefined",
              "1 = Custom"
            ],
            "componentName": "text",
            "displayName": "text",
            "aliases": "text"
          }
        ]
      },
      "windowsDefenderATPEnabled": false,
      "windowsComponentsEnabled": false,
      "windowsServicesEnabled": false,
      "windowsScheduledTasksEnabled": false,
      "windowsAdvancedOptionsEnabled": false,
      "networkPerformanceEnabled": false,
      "registryEnabled": false,
      "visualEffectsEnabled": false,
      "diskCleanupEnabled": false,
      "customScriptEnabled": false,
      "windowsServices": {
        "windowsServicesList": [
          {
            "type": [
              "0 = Predefined",
              "1 = Custom"
            ],
            "serviceName": "text",
            "displayName": "text",
            "aliases": "text"
          }
        ]
      },
      "windowsAdvancedOptions": {
        "partialStartLayoutContent": "text",
        "hibernate": false,
        "teleCollection": false,
        "systemRestore": false,
        "additionalErrorReport": false,
        "tiles": false,
        "cortana": false,
        "microsoftConsumerExperience": false,
        "windowsTips": false,
        "commonProgramGroups": false,
        "partialStartMenu": false
      },
      "networkPerformance": {
        "fileInfoCacheEnable": false,
        "directoryCacheEnable": false,
        "fileNotFoundCacheEnable": false,
        "dormantFileLimitEnable": false,
        "disableTCP": false,
        "disableIPv6CompEnable": false,
        "disableIPv6ToIPv4": false,
        "disableIsaTap": false
      },
      "customScript": {
        "arguments": "text",
        "command": "text",
        "initDir": "text",
        "user": "text"
      },
      "diskCleanup": {
        "cleanupWinSxSFolder": false,
        "cleanupSystemFiles": false,
        "cleanupTemporaryFileLogs": false,
        "removeOneDrive": false,
        "deleteUserProfiles": false
      },
      "visualEffects": {
        "visualEffectsTypes": [
          "0 = LetWindowsChooseWhatsBest",
          "1 = AdjustForBestAppearance",
          "2 = AdjustForBestPerformance",
          "3 = Custom"
        ],
        "animateControlSelectElements": false,
        "animateWindowsWhenMinimizingMaximizing": false,
        "animateTaskbar": false,
        "enablePeek": false,
        "fadeSlideMenus": false,
        "fadeSlideToolTips": false,
        "fadeOutMenuItems": false,
        "saveTaskbarThumbnail": false,
        "showShadowUnderMouse": false,
        "shadowUnderWindows": false,
        "thumbnailsInsteadOfIcons": false,
        "showTranslucentSelection": false,
        "showWindowsContentWhilstDragging": false,
        "slideOpenComboBoxes": false,
        "smoothEdgesScreenFonts": false,
        "smoothScrollListBoxes": false,
        "dropShadowsIcon": false
      },
      "windowsScheduledTasks": {
        "windowsScheduledTasksList": [
          {
            "task": "text",
            "location": "text",
            "type": [
              "0 = Folder",
              "1 = Task"
            ]
          }
        ]
      },
      "registry": {
        "registryList": [
          {
            "action": [
              "0 = Add",
              "1 = Modify",
              "2 = Delete"
            ],
            "registryName": "text",
            "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",
          "packageName": "text"
        }
      ]
    }
  }
]

Create

Create a new RD Session Host server to a site. The RD Session Host agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall parameter.

POST/api/RDS/Host

Query parameters

Body

application/json; api-version=1.0

RD Session Host settings

server*nullable string

A RD Session Host server FQDN or IP address.

siteIdinteger (int32)

The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.

addUsersToRDSUsersnullable array of string

Specifies the list of users or groups in UPN or SID format to be added to the RDSUsers Group in csv format.

Response

201401409

Created

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

servernullable string

Server name.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

directAddressnullable string

The direct address of the target RD Session Host server.

rasTemplateIdinteger (int32)

The RDSH RAS Template ID.

inheritDefaultAgentSettingsboolean

If true, default agent settings will be inherited.

inheritDefaultPrinterSettingsboolean

If true, default printer settings will be inherited.

inheritDefaultUserProfileSettingsboolean

If true, default User Profile settings will be inherited.

inheritDefaultDesktopAccessSettingsboolean

If true, default desktop access settings will be inherited.

inheritDefaultOptimizationSettingsnullable boolean

If true, default optimization settings will be inherited.

inheritDefaultAppPackageSettingsboolean

If true, default app package settings will be inherited.

portinteger (int32)

The port number of RD Session Host agent.

maxSessionsinteger (int32)

Maximum number of session a RDS Host can have.

disconnectActiveSessionAfterinteger (int32)

Disconnect active session after (in seconds). 0 - Never.

logoffDisconnectedSessionAfterinteger (int32)

Logoff disconnected session after (in seconds). 0 - Never; 1 - Immediate.

allowURLAndMailRedirectionAllowURLAndMailRedirection (enum)

URL and Mail Redirection values.

0 = Disabled,1 = Enabled,2 = EnabledWithAppRegistration

supportShellURLNamespaceObjectsboolean

Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.

allowRemoteExecboolean

Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.

enableAppMonitoringboolean

Specifies if 'Application Monitoring' option is enabled or disabled.

useRemoteAppsboolean

Specifies if 'Use RemoteApps if available' option is enables or disabled.

allowFileTransferboolean

Specifies if 'Allow file transfer' option is enables or disabled. (deprecated)

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

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

fileTransferLocationnullable string

Location where the File Transfer takes place, if and where it is allowed.

fileTransferLockLocationboolean

Lock Location where the File Transfer takes place, if and where it is allowed.

allowDragAndDropboolean

Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated)

dragAndDropModeDragAndDropModeValue (enum)

Drag and drop redirection values.

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

preferredBrokerIdinteger (int32)

The preferred Connection broker ID.

enableDriveRedirectionCacheboolean

Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.

manageRDPTransportProtocolManageRDPTransportProtocol (enum)

Manage RDP transport protocol.

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

enablePrintingboolean

Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.

enableTWAINboolean

Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.

enableWIAboolean

Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.

printerNameFormatPrnNameFormat (enum)

Printer Name Format

0 = PrnFormat_PRN_CMP_SES,1 = PrnFormat_SES_CMP_PRN,2 = PrnFormat_PRN_REDSES

removeClientNameFromPrinterNameboolean

Specifies if 'Remove client name from printer name' option is enabled or disabled.

removeSessionNumberFromPrinterNameboolean

Specifies if 'Remove session number from printer name' option is enabled or disabled.

technologyUserProfileTech (enum)

User Profile Technology values.

0 = DoNotManage,1 = UPD,2 = FSLogix

fsLogixFSLogixSettings (object)

FXLogix Settings

updModeUPDMode (enum)

User Profile Disk Mode.

0 = DoNotChange,1 = Enabled,2 = Disabled

maxUserProfileDiskSizeGBinteger (int32)

Specifies the max user profile disk size (in GB).

diskPathnullable string

Specifies the User Profile Disk path.

roamingModeUPDRoamingMode (enum)

User Profile Disk Roaming Mode.

0 = Exclude,2 = Include

includeFolderPathnullable array of string

Specifies the UPD 'Include' folder paths.

includeFilePathnullable array of string

Specifies the UPD 'Include' file paths.

excludeFolderPathnullable array of string

Specifies the UPD 'Exclude' folder paths.

excludeFilePathnullable array of string

Specifies the UPD 'Exclude' file paths.

restrictDesktopAccessboolean

Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled.

restrictedUsersnullable array of string

Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.

enableOptimizationboolean

optimizationImageOptimization (object)

Image Optimization

appPackagesAssignedAppPackagesAssigned (object)

Application Packages Assigned

Request

JavaScriptCurlPython

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

Response

201401409

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:39:24.494Z",
  "timeLastMod": "2024-11-07T07:39:24.494Z",
  "server": "text",
  "enabled": false,
  "description": "text",
  "directAddress": "text",
  "inheritDefaultAgentSettings": false,
  "inheritDefaultPrinterSettings": false,
  "inheritDefaultUserProfileSettings": false,
  "inheritDefaultDesktopAccessSettings": false,
  "inheritDefaultOptimizationSettings": false,
  "inheritDefaultAppPackageSettings": false,
  "allowURLAndMailRedirection": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = EnabledWithAppRegistration"
  ],
  "supportShellURLNamespaceObjects": false,
  "allowRemoteExec": false,
  "enableAppMonitoring": false,
  "useRemoteApps": false,
  "allowFileTransfer": false,
  "fileTransferMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "fileTransferLocation": "text",
  "fileTransferLockLocation": false,
  "allowDragAndDrop": false,
  "dragAndDropMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "enableDriveRedirectionCache": false,
  "manageRDPTransportProtocol": [
    "0 = Disabled",
    "1 = BothUDPTCP",
    "2 = OnlyTCP",
    "3 = EitherUDPTCP"
  ],
  "enablePrinting": false,
  "enableTWAIN": false,
  "enableWIA": false,
  "printerNameFormat": [
    "0 = PrnFormat_PRN_CMP_SES",
    "1 = PrnFormat_SES_CMP_PRN",
    "2 = PrnFormat_PRN_REDSES"
  ],
  "removeClientNameFromPrinterName": false,
  "removeSessionNumberFromPrinterName": false,
  "technology": [
    "0 = DoNotManage",
    "1 = UPD",
    "2 = FSLogix"
  ],
  "fsLogix": {
    "profileContainer": {
      "enabled": false,
      "locationType": [
        "0 = SMBLocation",
        "1 = CloudCache"
      ],
      "vhdLocations": [
        "text"
      ],
      "ccdLocations": [
        "text"
      ],
      "profileDiskFormat": [
        "0 = VHD",
        "1 = VHDX"
      ],
      "allocationType": [
        "0 = Dynamic",
        "1 = Full"
      ],
      "userInclusionList": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ],
      "userExclusionList": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ],
      "cloudCache": {
        "useMaxCacheSizeInMBs": false,
        "useClearCacheOnLogoff": false,
        "clearCacheOnLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useHealthyProvidersRequiredForRegister": false,
        "useHealthyProvidersRequiredForUnregister": false,
        "useUnregisterTimeout": false,
        "useClearCacheOnForcedUnregister": false,
        "clearCacheOnForcedUnregister": [
          "0 = Disable",
          "1 = Enable"
        ]
      },
      "customizeProfileFolders": false,
      "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": false,
        "useLockedRetryInterval": false,
        "useAccessNetworkAsComputerObject": false,
        "accessNetworkAsComputerObject": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useAttachVHDSDDL": false,
        "attachVHDSDDL": "text",
        "useDiffDiskParentFolderPath": false,
        "diffDiskParentFolderPath": "text",
        "useFlipFlopProfileDirectoryName": false,
        "flipFlopProfileDirectoryName": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useNoProfileContainingFolder": false,
        "noProfileContainingFolder": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useOutlookCachedMode": false,
        "outlookCachedMode": [
          "0 = Disable",
          "1 = Enable"
        ],
        "usePreventLoginWithFailure": false,
        "preventLoginWithFailure": [
          "0 = Disable",
          "1 = Enable"
        ],
        "usePreventLoginWithTempProfile": false,
        "preventLoginWithTempProfile": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useReAttachRetryCount": false,
        "useReAttachIntervalSeconds": false,
        "useRemoveOrphanedOSTFilesOnLogoff": false,
        "removeOrphanedOSTFilesOnLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRoamSearch": false,
        "roamSearch": [
          "0 = Disable",
          "1 = SingleUser",
          "2 = MultiUser"
        ],
        "useSIDDirNameMatch": false,
        "sidDirNameMatch": "text",
        "useSIDDirNamePattern": false,
        "sidDirNamePattern": "text",
        "useSIDDirSDDL": false,
        "sidDirSDDL": "text",
        "useVHDNameMatch": false,
        "vhdNameMatch": "text",
        "useVHDNamePattern": false,
        "vhdNamePattern": "text",
        "useVHDXSectorSize": false,
        "vhdxSectorSize": [
          "0 = SystemDefault",
          "512 = Size_512",
          "4096 = Size_4096"
        ],
        "useVolumeWaitTimeMS": false,
        "useIgnoreNonAVD": false,
        "ignoreNonAVD": [
          "0 = AnySession",
          "1 = AVDSessions"
        ],
        "useRedirectType": false,
        "redirectType": [
          "1 = Legacy",
          "2 = Advanced"
        ],
        "useKeepLocalDir": false,
        "keepLocalDir": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useDeleteLocalProfileWhenVHDShouldApply": false,
        "deleteLocalProfileWhenVHDShouldApply": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useProfileDirSDDL": false,
        "profileDirSDDL": "text",
        "useProfileType": false,
        "profileType": [
          "0 = NormalProfile",
          "1 = OnlyRWProfile",
          "2 = OnlyROProfile",
          "3 = RWROProfile"
        ],
        "useSetTempToLocalPath": false,
        "setTempToLocalPath": [
          "0 = TakeNoAction",
          "1 = RedirectTempAndTmp",
          "2 = RedirectINetCache",
          "3 = RedirectTempTmpAndINetCache"
        ],
        "useCleanOutNotifications": false,
        "cleanOutNotifications": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useInstallAppxPackages": false,
        "installAppxPackages": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRebootOnUserLogoff": false,
        "rebootOnUserLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRoamIdentity": false,
        "roamIdentity": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useShutdownOnUserLogoff": false,
        "shutdownOnUserLogoff": [
          "0 = Disable",
          "1 = Enable"
        ]
      }
    },
    "officeContainer": {
      "enabled": false,
      "locationType": [
        "0 = SMBLocation",
        "1 = CloudCache"
      ],
      "vhdLocations": [
        "text"
      ],
      "ccdLocations": [
        "text"
      ],
      "profileDiskFormat": [
        "0 = VHD",
        "1 = VHDX"
      ],
      "allocationType": [
        "0 = Dynamic",
        "1 = Full"
      ],
      "userInclusionList": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ],
      "userExclusionList": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ],
      "cloudCache": {
        "useMaxCacheSizeInMBs": false,
        "useClearCacheOnLogoff": false,
        "clearCacheOnLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useHealthyProvidersRequiredForRegister": false,
        "useHealthyProvidersRequiredForUnregister": false,
        "useUnregisterTimeout": false,
        "useClearCacheOnForcedUnregister": false,
        "clearCacheOnForcedUnregister": [
          "0 = Disable",
          "1 = Enable"
        ]
      },
      "advancedSettings": {
        "useLockedRetryCount": false,
        "useLockedRetryInterval": false,
        "useAccessNetworkAsComputerObject": false,
        "accessNetworkAsComputerObject": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useAttachVHDSDDL": false,
        "attachVHDSDDL": "text",
        "useDiffDiskParentFolderPath": false,
        "diffDiskParentFolderPath": "text",
        "useFlipFlopProfileDirectoryName": false,
        "flipFlopProfileDirectoryName": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useNoProfileContainingFolder": false,
        "noProfileContainingFolder": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useOutlookCachedMode": false,
        "outlookCachedMode": [
          "0 = Disable",
          "1 = Enable"
        ],
        "usePreventLoginWithFailure": false,
        "preventLoginWithFailure": [
          "0 = Disable",
          "1 = Enable"
        ],
        "usePreventLoginWithTempProfile": false,
        "preventLoginWithTempProfile": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useReAttachRetryCount": false,
        "useReAttachIntervalSeconds": false,
        "useRemoveOrphanedOSTFilesOnLogoff": false,
        "removeOrphanedOSTFilesOnLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRoamSearch": false,
        "roamSearch": [
          "0 = Disable",
          "1 = SingleUser",
          "2 = MultiUser"
        ],
        "useSIDDirNameMatch": false,
        "sidDirNameMatch": "text",
        "useSIDDirNamePattern": false,
        "sidDirNamePattern": "text",
        "useSIDDirSDDL": false,
        "sidDirSDDL": "text",
        "useVHDNameMatch": false,
        "vhdNameMatch": "text",
        "useVHDNamePattern": false,
        "vhdNamePattern": "text",
        "useVHDXSectorSize": false,
        "vhdxSectorSize": [
          "0 = SystemDefault",
          "512 = Size_512",
          "4096 = Size_4096"
        ],
        "useVolumeWaitTimeMS": false,
        "useIgnoreNonAVD": false,
        "ignoreNonAVD": [
          "0 = AnySession",
          "1 = AVDSessions"
        ],
        "useRedirectType": false,
        "redirectType": [
          "1 = Legacy",
          "2 = Advanced"
        ],
        "useIncludeOfficeActivation": false,
        "includeOfficeActivation": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeOneDrive": false,
        "includeOneDrive": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeOneNote": false,
        "includeOneNote": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeOneNoteUWP": false,
        "includeOneNoteUWP": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeOutlook": false,
        "includeOutlook": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeOutlookPersonalization": false,
        "includeOutlookPersonalization": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeSharepoint": false,
        "includeSharepoint": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeSkype": false,
        "includeSkype": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeTeams": false,
        "includeTeams": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useMirrorLocalOSTToVHD": false,
        "mirrorLocalOSTToVHD": [
          "0 = DoNothing",
          "1 = Copy",
          "2 = Move"
        ],
        "useNumSessionVHDsToKeep": false,
        "useOutlookFolderPath": false,
        "outlookFolderPath": "text",
        "useRefreshUserPolicy": false,
        "refreshUserPolicy": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useVHDAccessMode": false,
        "vhdAccessMode": [
          "0 = NormalDirectAccess",
          "1 = DiffDiskNetwork",
          "2 = DiffDiskLocal",
          "3 = UniqueVHDPerSession"
        ]
      }
    },
    "generalSettings": {
      "appServices": {
        "useCleanupInvalidSessions": false,
        "cleanupInvalidSessions": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRoamRecycleBin": false,
        "roamRecycleBin": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useVHDCompactDisk": false,
        "vhdCompactDisk": [
          "0 = Disable",
          "1 = Enable"
        ]
      },
      "cloudCacheGeneral": {
        "useCacheDirectory": false,
        "cacheDirectory": "text",
        "useWriteCacheDirectory": false,
        "writeCacheDirectory": "text",
        "useProxyDirectory": false,
        "proxyDirectory": "text",
        "useSilenceACLWarning": false,
        "silenceACLWarning": [
          "0 = Disable",
          "1 = Enable"
        ]
      },
      "logging": {
        "logEnabled": [
          "0 = Disable",
          "1 = Specific",
          "2 = All"
        ],
        "logLevel": [
          "0 = Debug",
          "1 = Information",
          "2 = Warning",
          "3 = Error"
        ],
        "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"
  ],
  "diskPath": "text",
  "roamingMode": [
    "0 = Exclude",
    "2 = Include"
  ],
  "includeFolderPath": [
    "text"
  ],
  "includeFilePath": [
    "text"
  ],
  "excludeFolderPath": [
    "text"
  ],
  "excludeFilePath": [
    "text"
  ],
  "restrictDesktopAccess": false,
  "restrictedUsers": [
    "text"
  ],
  "enableOptimization": false,
  "optimization": {
    "enableOptimization": false,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": false,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": false,
    "windowsComponentsEnabled": false,
    "windowsServicesEnabled": false,
    "windowsScheduledTasksEnabled": false,
    "windowsAdvancedOptionsEnabled": false,
    "networkPerformanceEnabled": false,
    "registryEnabled": false,
    "visualEffectsEnabled": false,
    "diskCleanupEnabled": false,
    "customScriptEnabled": false,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": false,
      "teleCollection": false,
      "systemRestore": false,
      "additionalErrorReport": false,
      "tiles": false,
      "cortana": false,
      "microsoftConsumerExperience": false,
      "windowsTips": false,
      "commonProgramGroups": false,
      "partialStartMenu": false
    },
    "networkPerformance": {
      "fileInfoCacheEnable": false,
      "directoryCacheEnable": false,
      "fileNotFoundCacheEnable": false,
      "dormantFileLimitEnable": false,
      "disableTCP": false,
      "disableIPv6CompEnable": false,
      "disableIPv6ToIPv4": false,
      "disableIsaTap": false
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": false,
      "cleanupSystemFiles": false,
      "cleanupTemporaryFileLogs": false,
      "removeOneDrive": false,
      "deleteUserProfiles": false
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": false,
      "animateWindowsWhenMinimizingMaximizing": false,
      "animateTaskbar": false,
      "enablePeek": false,
      "fadeSlideMenus": false,
      "fadeSlideToolTips": false,
      "fadeOutMenuItems": false,
      "saveTaskbarThumbnail": false,
      "showShadowUnderMouse": false,
      "shadowUnderWindows": false,
      "thumbnailsInsteadOfIcons": false,
      "showTranslucentSelection": false,
      "showWindowsContentWhilstDragging": false,
      "slideOpenComboBoxes": false,
      "smoothEdgesScreenFonts": false,
      "smoothScrollListBoxes": false,
      "dropShadowsIcon": false
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "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",
        "packageName": "text"
      }
    ]
  }
}

Get

Retrieve a specific RD Session Host by ID. The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.

GET/api/RDS/Host/{id}

Path parameters

id*integer (int32)

RD Session Host ID

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

servernullable string

Server name.

enabledboolean

Whether the server is enabled or not.

descriptionnullable string

Description of the server.

siteIdinteger (int32)

ID of the site.

directAddressnullable string

The direct address of the target RD Session Host server.

rasTemplateIdinteger (int32)

The RDSH RAS Template ID.

inheritDefaultAgentSettingsboolean

If true, default agent settings will be inherited.

inheritDefaultPrinterSettingsboolean

If true, default printer settings will be inherited.

inheritDefaultUserProfileSettingsboolean

If true, default User Profile settings will be inherited.

inheritDefaultDesktopAccessSettingsboolean

If true, default desktop access settings will be inherited.

inheritDefaultOptimizationSettingsnullable boolean

If true, default optimization settings will be inherited.

inheritDefaultAppPackageSettingsboolean

If true, default app package settings will be inherited.

portinteger (int32)

The port number of RD Session Host agent.

maxSessionsinteger (int32)

Maximum number of session a RDS Host can have.

disconnectActiveSessionAfterinteger (int32)

Disconnect active session after (in seconds). 0 - Never.

logoffDisconnectedSessionAfterinteger (int32)

Logoff disconnected session after (in seconds). 0 - Never; 1 - Immediate.

allowURLAndMailRedirectionAllowURLAndMailRedirection (enum)

URL and Mail Redirection values.

0 = Disabled,1 = Enabled,2 = EnabledWithAppRegistration

supportShellURLNamespaceObjectsboolean

Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.

allowRemoteExecboolean

Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.

enableAppMonitoringboolean

Specifies if 'Application Monitoring' option is enabled or disabled.

useRemoteAppsboolean

Specifies if 'Use RemoteApps if available' option is enables or disabled.

allowFileTransferboolean

Specifies if 'Allow file transfer' option is enables or disabled. (deprecated)

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

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

fileTransferLocationnullable string

Location where the File Transfer takes place, if and where it is allowed.

fileTransferLockLocationboolean

Lock Location where the File Transfer takes place, if and where it is allowed.

allowDragAndDropboolean

Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated)

dragAndDropModeDragAndDropModeValue (enum)

Drag and drop redirection values.

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

preferredBrokerIdinteger (int32)

The preferred Connection broker ID.

enableDriveRedirectionCacheboolean

Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.

manageRDPTransportProtocolManageRDPTransportProtocol (enum)

Manage RDP transport protocol.

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

enablePrintingboolean

Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.

enableTWAINboolean

Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.

enableWIAboolean

Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.

printerNameFormatPrnNameFormat (enum)

Printer Name Format

0 = PrnFormat_PRN_CMP_SES,1 = PrnFormat_SES_CMP_PRN,2 = PrnFormat_PRN_REDSES

removeClientNameFromPrinterNameboolean

Specifies if 'Remove client name from printer name' option is enabled or disabled.

removeSessionNumberFromPrinterNameboolean

Specifies if 'Remove session number from printer name' option is enabled or disabled.

technologyUserProfileTech (enum)

User Profile Technology values.

0 = DoNotManage,1 = UPD,2 = FSLogix

fsLogixFSLogixSettings (object)

FXLogix Settings

updModeUPDMode (enum)

User Profile Disk Mode.

0 = DoNotChange,1 = Enabled,2 = Disabled

maxUserProfileDiskSizeGBinteger (int32)

Specifies the max user profile disk size (in GB).

diskPathnullable string

Specifies the User Profile Disk path.

roamingModeUPDRoamingMode (enum)

User Profile Disk Roaming Mode.

0 = Exclude,2 = Include

includeFolderPathnullable array of string

Specifies the UPD 'Include' folder paths.

includeFilePathnullable array of string

Specifies the UPD 'Include' file paths.

excludeFolderPathnullable array of string

Specifies the UPD 'Exclude' folder paths.

excludeFilePathnullable array of string

Specifies the UPD 'Exclude' file paths.

restrictDesktopAccessboolean

Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled.

restrictedUsersnullable array of string

Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.

enableOptimizationboolean

optimizationImageOptimization (object)

Image Optimization

appPackagesAssignedAppPackagesAssigned (object)

Application Packages Assigned

Request

JavaScriptCurlPython

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

Response

200401404

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:39:24.494Z",
  "timeLastMod": "2024-11-07T07:39:24.494Z",
  "server": "text",
  "enabled": false,
  "description": "text",
  "directAddress": "text",
  "inheritDefaultAgentSettings": false,
  "inheritDefaultPrinterSettings": false,
  "inheritDefaultUserProfileSettings": false,
  "inheritDefaultDesktopAccessSettings": false,
  "inheritDefaultOptimizationSettings": false,
  "inheritDefaultAppPackageSettings": false,
  "allowURLAndMailRedirection": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = EnabledWithAppRegistration"
  ],
  "supportShellURLNamespaceObjects": false,
  "allowRemoteExec": false,
  "enableAppMonitoring": false,
  "useRemoteApps": false,
  "allowFileTransfer": false,
  "fileTransferMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "fileTransferLocation": "text",
  "fileTransferLockLocation": false,
  "allowDragAndDrop": false,
  "dragAndDropMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "enableDriveRedirectionCache": false,
  "manageRDPTransportProtocol": [
    "0 = Disabled",
    "1 = BothUDPTCP",
    "2 = OnlyTCP",
    "3 = EitherUDPTCP"
  ],
  "enablePrinting": false,
  "enableTWAIN": false,
  "enableWIA": false,
  "printerNameFormat": [
    "0 = PrnFormat_PRN_CMP_SES",
    "1 = PrnFormat_SES_CMP_PRN",
    "2 = PrnFormat_PRN_REDSES"
  ],
  "removeClientNameFromPrinterName": false,
  "removeSessionNumberFromPrinterName": false,
  "technology": [
    "0 = DoNotManage",
    "1 = UPD",
    "2 = FSLogix"
  ],
  "fsLogix": {
    "profileContainer": {
      "enabled": false,
      "locationType": [
        "0 = SMBLocation",
        "1 = CloudCache"
      ],
      "vhdLocations": [
        "text"
      ],
      "ccdLocations": [
        "text"
      ],
      "profileDiskFormat": [
        "0 = VHD",
        "1 = VHDX"
      ],
      "allocationType": [
        "0 = Dynamic",
        "1 = Full"
      ],
      "userInclusionList": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ],
      "userExclusionList": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ],
      "cloudCache": {
        "useMaxCacheSizeInMBs": false,
        "useClearCacheOnLogoff": false,
        "clearCacheOnLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useHealthyProvidersRequiredForRegister": false,
        "useHealthyProvidersRequiredForUnregister": false,
        "useUnregisterTimeout": false,
        "useClearCacheOnForcedUnregister": false,
        "clearCacheOnForcedUnregister": [
          "0 = Disable",
          "1 = Enable"
        ]
      },
      "customizeProfileFolders": false,
      "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": false,
        "useLockedRetryInterval": false,
        "useAccessNetworkAsComputerObject": false,
        "accessNetworkAsComputerObject": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useAttachVHDSDDL": false,
        "attachVHDSDDL": "text",
        "useDiffDiskParentFolderPath": false,
        "diffDiskParentFolderPath": "text",
        "useFlipFlopProfileDirectoryName": false,
        "flipFlopProfileDirectoryName": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useNoProfileContainingFolder": false,
        "noProfileContainingFolder": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useOutlookCachedMode": false,
        "outlookCachedMode": [
          "0 = Disable",
          "1 = Enable"
        ],
        "usePreventLoginWithFailure": false,
        "preventLoginWithFailure": [
          "0 = Disable",
          "1 = Enable"
        ],
        "usePreventLoginWithTempProfile": false,
        "preventLoginWithTempProfile": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useReAttachRetryCount": false,
        "useReAttachIntervalSeconds": false,
        "useRemoveOrphanedOSTFilesOnLogoff": false,
        "removeOrphanedOSTFilesOnLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRoamSearch": false,
        "roamSearch": [
          "0 = Disable",
          "1 = SingleUser",
          "2 = MultiUser"
        ],
        "useSIDDirNameMatch": false,
        "sidDirNameMatch": "text",
        "useSIDDirNamePattern": false,
        "sidDirNamePattern": "text",
        "useSIDDirSDDL": false,
        "sidDirSDDL": "text",
        "useVHDNameMatch": false,
        "vhdNameMatch": "text",
        "useVHDNamePattern": false,
        "vhdNamePattern": "text",
        "useVHDXSectorSize": false,
        "vhdxSectorSize": [
          "0 = SystemDefault",
          "512 = Size_512",
          "4096 = Size_4096"
        ],
        "useVolumeWaitTimeMS": false,
        "useIgnoreNonAVD": false,
        "ignoreNonAVD": [
          "0 = AnySession",
          "1 = AVDSessions"
        ],
        "useRedirectType": false,
        "redirectType": [
          "1 = Legacy",
          "2 = Advanced"
        ],
        "useKeepLocalDir": false,
        "keepLocalDir": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useDeleteLocalProfileWhenVHDShouldApply": false,
        "deleteLocalProfileWhenVHDShouldApply": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useProfileDirSDDL": false,
        "profileDirSDDL": "text",
        "useProfileType": false,
        "profileType": [
          "0 = NormalProfile",
          "1 = OnlyRWProfile",
          "2 = OnlyROProfile",
          "3 = RWROProfile"
        ],
        "useSetTempToLocalPath": false,
        "setTempToLocalPath": [
          "0 = TakeNoAction",
          "1 = RedirectTempAndTmp",
          "2 = RedirectINetCache",
          "3 = RedirectTempTmpAndINetCache"
        ],
        "useCleanOutNotifications": false,
        "cleanOutNotifications": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useInstallAppxPackages": false,
        "installAppxPackages": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRebootOnUserLogoff": false,
        "rebootOnUserLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRoamIdentity": false,
        "roamIdentity": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useShutdownOnUserLogoff": false,
        "shutdownOnUserLogoff": [
          "0 = Disable",
          "1 = Enable"
        ]
      }
    },
    "officeContainer": {
      "enabled": false,
      "locationType": [
        "0 = SMBLocation",
        "1 = CloudCache"
      ],
      "vhdLocations": [
        "text"
      ],
      "ccdLocations": [
        "text"
      ],
      "profileDiskFormat": [
        "0 = VHD",
        "1 = VHDX"
      ],
      "allocationType": [
        "0 = Dynamic",
        "1 = Full"
      ],
      "userInclusionList": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ],
      "userExclusionList": [
        {
          "account": "text",
          "type": [
            "1 = User",
            "2 = Group",
            "3 = ForeignSecurityPrincipal",
            "4 = Computer"
          ],
          "sid": "text"
        }
      ],
      "cloudCache": {
        "useMaxCacheSizeInMBs": false,
        "useClearCacheOnLogoff": false,
        "clearCacheOnLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useHealthyProvidersRequiredForRegister": false,
        "useHealthyProvidersRequiredForUnregister": false,
        "useUnregisterTimeout": false,
        "useClearCacheOnForcedUnregister": false,
        "clearCacheOnForcedUnregister": [
          "0 = Disable",
          "1 = Enable"
        ]
      },
      "advancedSettings": {
        "useLockedRetryCount": false,
        "useLockedRetryInterval": false,
        "useAccessNetworkAsComputerObject": false,
        "accessNetworkAsComputerObject": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useAttachVHDSDDL": false,
        "attachVHDSDDL": "text",
        "useDiffDiskParentFolderPath": false,
        "diffDiskParentFolderPath": "text",
        "useFlipFlopProfileDirectoryName": false,
        "flipFlopProfileDirectoryName": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useNoProfileContainingFolder": false,
        "noProfileContainingFolder": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useOutlookCachedMode": false,
        "outlookCachedMode": [
          "0 = Disable",
          "1 = Enable"
        ],
        "usePreventLoginWithFailure": false,
        "preventLoginWithFailure": [
          "0 = Disable",
          "1 = Enable"
        ],
        "usePreventLoginWithTempProfile": false,
        "preventLoginWithTempProfile": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useReAttachRetryCount": false,
        "useReAttachIntervalSeconds": false,
        "useRemoveOrphanedOSTFilesOnLogoff": false,
        "removeOrphanedOSTFilesOnLogoff": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRoamSearch": false,
        "roamSearch": [
          "0 = Disable",
          "1 = SingleUser",
          "2 = MultiUser"
        ],
        "useSIDDirNameMatch": false,
        "sidDirNameMatch": "text",
        "useSIDDirNamePattern": false,
        "sidDirNamePattern": "text",
        "useSIDDirSDDL": false,
        "sidDirSDDL": "text",
        "useVHDNameMatch": false,
        "vhdNameMatch": "text",
        "useVHDNamePattern": false,
        "vhdNamePattern": "text",
        "useVHDXSectorSize": false,
        "vhdxSectorSize": [
          "0 = SystemDefault",
          "512 = Size_512",
          "4096 = Size_4096"
        ],
        "useVolumeWaitTimeMS": false,
        "useIgnoreNonAVD": false,
        "ignoreNonAVD": [
          "0 = AnySession",
          "1 = AVDSessions"
        ],
        "useRedirectType": false,
        "redirectType": [
          "1 = Legacy",
          "2 = Advanced"
        ],
        "useIncludeOfficeActivation": false,
        "includeOfficeActivation": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeOneDrive": false,
        "includeOneDrive": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeOneNote": false,
        "includeOneNote": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeOneNoteUWP": false,
        "includeOneNoteUWP": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeOutlook": false,
        "includeOutlook": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeOutlookPersonalization": false,
        "includeOutlookPersonalization": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeSharepoint": false,
        "includeSharepoint": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeSkype": false,
        "includeSkype": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useIncludeTeams": false,
        "includeTeams": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useMirrorLocalOSTToVHD": false,
        "mirrorLocalOSTToVHD": [
          "0 = DoNothing",
          "1 = Copy",
          "2 = Move"
        ],
        "useNumSessionVHDsToKeep": false,
        "useOutlookFolderPath": false,
        "outlookFolderPath": "text",
        "useRefreshUserPolicy": false,
        "refreshUserPolicy": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useVHDAccessMode": false,
        "vhdAccessMode": [
          "0 = NormalDirectAccess",
          "1 = DiffDiskNetwork",
          "2 = DiffDiskLocal",
          "3 = UniqueVHDPerSession"
        ]
      }
    },
    "generalSettings": {
      "appServices": {
        "useCleanupInvalidSessions": false,
        "cleanupInvalidSessions": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useRoamRecycleBin": false,
        "roamRecycleBin": [
          "0 = Disable",
          "1 = Enable"
        ],
        "useVHDCompactDisk": false,
        "vhdCompactDisk": [
          "0 = Disable",
          "1 = Enable"
        ]
      },
      "cloudCacheGeneral": {
        "useCacheDirectory": false,
        "cacheDirectory": "text",
        "useWriteCacheDirectory": false,
        "writeCacheDirectory": "text",
        "useProxyDirectory": false,
        "proxyDirectory": "text",
        "useSilenceACLWarning": false,
        "silenceACLWarning": [
          "0 = Disable",
          "1 = Enable"
        ]
      },
      "logging": {
        "logEnabled": [
          "0 = Disable",
          "1 = Specific",
          "2 = All"
        ],
        "logLevel": [
          "0 = Debug",
          "1 = Information",
          "2 = Warning",
          "3 = Error"
        ],
        "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"
  ],
  "diskPath": "text",
  "roamingMode": [
    "0 = Exclude",
    "2 = Include"
  ],
  "includeFolderPath": [
    "text"
  ],
  "includeFilePath": [
    "text"
  ],
  "excludeFolderPath": [
    "text"
  ],
  "excludeFilePath": [
    "text"
  ],
  "restrictDesktopAccess": false,
  "restrictedUsers": [
    "text"
  ],
  "enableOptimization": false,
  "optimization": {
    "enableOptimization": false,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": false,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": false,
    "windowsComponentsEnabled": false,
    "windowsServicesEnabled": false,
    "windowsScheduledTasksEnabled": false,
    "windowsAdvancedOptionsEnabled": false,
    "networkPerformanceEnabled": false,
    "registryEnabled": false,
    "visualEffectsEnabled": false,
    "diskCleanupEnabled": false,
    "customScriptEnabled": false,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": false,
      "teleCollection": false,
      "systemRestore": false,
      "additionalErrorReport": false,
      "tiles": false,
      "cortana": false,
      "microsoftConsumerExperience": false,
      "windowsTips": false,
      "commonProgramGroups": false,
      "partialStartMenu": false
    },
    "networkPerformance": {
      "fileInfoCacheEnable": false,
      "directoryCacheEnable": false,
      "fileNotFoundCacheEnable": false,
      "dormantFileLimitEnable": false,
      "disableTCP": false,
      "disableIPv6CompEnable": false,
      "disableIPv6ToIPv4": false,
      "disableIsaTap": false
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": false,
      "cleanupSystemFiles": false,
      "cleanupTemporaryFileLogs": false,
      "removeOneDrive": false,
      "deleteUserProfiles": false
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": false,
      "animateWindowsWhenMinimizingMaximizing": false,
      "animateTaskbar": false,
      "enablePeek": false,
      "fadeSlideMenus": false,
      "fadeSlideToolTips": false,
      "fadeOutMenuItems": false,
      "saveTaskbarThumbnail": false,
      "showShadowUnderMouse": false,
      "shadowUnderWindows": false,
      "thumbnailsInsteadOfIcons": false,
      "showTranslucentSelection": false,
      "showWindowsContentWhilstDragging": false,
      "slideOpenComboBoxes": false,
      "smoothEdgesScreenFonts": false,
      "smoothScrollListBoxes": false,
      "dropShadowsIcon": false
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "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",
        "packageName": "text"
      }
    ]
  }
}

Update

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

PUT/api/RDS/Host/{id}

Path parameters

id*integer (int32)

RD Session Host ID

Body

application/json; api-version=1.0

RD Session Host settings

enablednullable boolean

Enable or disable the specified RD Session Host server in a site.

servernullable string

A new server name. This must be either the server's FQDN or IP address.

descriptionnullable string

A user-defined RD Session Host server description.

directAddressnullable string

Specifies the RD Session Host server direct address.

inheritDefaultAgentSettingsnullable boolean

Enable or disable the 'Inherit default agent settings' option. This will inherit RD Session Host agent settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.

inheritDefaultPrinterSettingsnullable boolean

Enable or disable the 'Inherit default printer settings' option. This will inherit RD Session Host printer settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.

inheritDefaultUserProfileSettingsnullable boolean

Enable or disable the 'Inherit default user profile settings' option. This will inherit RD Session Host User Profile settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.

inheritDefaultDesktopAccessSettingsnullable boolean

Enable or disable the 'Inherit default desktop access settings' option. This will inherit RD Session Host Desktop Access settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.

inheritDefaultOptimizationSettingsnullable boolean

Enable or disable the 'Inherit default Optimization Settings' option. This will inherit Image Optimization settings from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.

inheritDefaultAppPackageSettingsnullable boolean

Enable or disable the 'Inherit default App Package Settings' option. This will inherit Application Packages from the default profile. If you would like to specify custom settings, you need to disable this option and specify the desired parameters.

portnullable integer (int32)

Specifies the port number for the RD Session Host agent.

maxSessionsnullable integer (int32)

Specifies the 'Maximum Sessions' property.

disconnectActiveSessionAfternullable integer (int32)

Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.

logoffDisconnectedSessionAfternullable integer (int32)

Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.

allowURLAndMailRedirectionAllowURLAndMailRedirection (enum)

URL and Mail Redirection values.

0 = Disabled,1 = Enabled,2 = EnabledWithAppRegistration

supportShellURLNamespaceObjectsnullable boolean

Enable or disable the 'Support Shell URL Namespace Objects' option.

allowRemoteExecnullable boolean

Enable or disable the 'Allow 2XRemoteExec to send command to the client' option.

enableAppMonitoringnullable boolean

Enable or disable the 'Application Monitoring' option.

useRemoteAppsnullable boolean

Enable or disable the 'Use RemoteApps if available' option.

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

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

fileTransferLocationnullable string

Location where the File Transfer takes place, if and where it is allowed.

fileTransferLockLocationnullable boolean

Lock Location where the File Transfer takes place, if and where it is allowed.

dragAndDropModeDragAndDropModeValue (enum)

Drag and drop redirection values.

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

manageRDPTransportProtocolManageRDPTransportProtocol (enum)

Manage RDP transport protocol.

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

enablePrintingnullable boolean

Enables or disables Universal Printing on the RD Session Host server. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.

enableTWAINnullable boolean

Enable or disable TWAIN (Universal Scanning) on the RD Session Host server. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.

enableWIAnullable boolean

Enable or disable WIA (Universal Scanning) on the RD Session Host server. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.

printerNameFormatPrnNameFormat (enum)

Printer Name Format

0 = PrnFormat_PRN_CMP_SES,1 = PrnFormat_SES_CMP_PRN,2 = PrnFormat_PRN_REDSES

removeClientNameFromPrinterNamenullable boolean

Enable or disable the 'Remove client name from printer name' option.

removeSessionNumberFromPrinterNamenullable boolean

Enable or disable the 'Remove session number from printer name' option.

autoPreferredBrokerboolean

Set the 'Preferred Connection Broker' option to 'Automatically".

preferredBrokerIdnullable integer (int32)

The preferred Connection Broker ID.

enableDriveRedirectionCachenullable boolean

Enable or disable the 'Enable Drive Redirection Cache' option.

technologyUserProfileTech (enum)

User Profile Technology values.

0 = DoNotManage,1 = UPD,2 = FSLogix

updModeUPDMode (enum)

User Profile Disk Mode.

0 = DoNotChange,1 = Enabled,2 = Disabled

updRoamingModeUPDRoamingMode (enum)

User Profile Disk Roaming Mode.

0 = Exclude,2 = Include

upDiskPathnullable string

Specifies the User Profile Disk path.

maxUserProfileDiskSizeGBnullable integer (int32)

Specifies the max user profile disk size (in GB).

includeFolderPathnullable array of string

Specifies the UPD 'Include' folder paths.

includeFilePathnullable array of string

Specifies the UPD 'Include' file paths.

excludeFolderPathnullable array of string

Specifies the UPD 'Exclude' folder paths.

excludeFilePathnullable array of string

Specifies the UPD 'Exclude' file paths.

restrictDesktopAccessnullable boolean

Enable or disable the 'Restrict direct desktop access to the following users' option. Use the RestrictedUsers parameter to specify the list of users.

restrictedUsersnullable array of string

Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.

Response

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

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

Delete

Delete a RD Session Host server from a site. The RD Session Host agent will be uninstalled from the server by default. You can optionally keep it by including the noUninstall parameter.

DELETE/api/RDS/Host/{id}

Path parameters

id*integer (int32)

RD Session Host ID

Query parameters

Response

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

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