Members

PreviousCreateHosts NextRecreateHosts

Was this helpful?

List

Retrieve the list of RD Session Host servers which are members of the specified group.

GET/api/RDS/HostPool/{hostPoolId}/Members

Path parameters

hostPoolId*integer (int32)

ID of the RD Session Host Pool of which members information will be retrieved

Response

Success

Body

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.

allowURLAndMailRedirectionenum

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)

fileTransferModeenum

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)

dragAndDropModeenum

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.

manageRDPTransportProtocolenum

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.

printerNameFormatenum

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.

technologyenum

User Profile Technology values.

0 = DoNotManage,1 = UPD,2 = FSLogix

fsLogixobject

FXLogix Settings

updModeenum

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.

roamingModeenum

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

optimizationobject

Image Optimization

appPackagesAssignedobject

Application Packages Assigned

Request

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

Response

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-02-05T03:56:46.658Z",
    "timeLastMod": "2025-02-05T03:56:46.658Z",
    "server": "text",
    "enabled": true,
    "description": "text",
    "siteId": 1,
    "directAddress": "text",
    "rasTemplateId": 1,
    "inheritDefaultAgentSettings": true,
    "inheritDefaultPrinterSettings": true,
    "inheritDefaultUserProfileSettings": true,
    "inheritDefaultDesktopAccessSettings": true,
    "inheritDefaultOptimizationSettings": true,
    "inheritDefaultAppPackageSettings": true,
    "port": 1,
    "maxSessions": 1,
    "disconnectActiveSessionAfter": 1,
    "logoffDisconnectedSessionAfter": 1,
    "allowURLAndMailRedirection": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = EnabledWithAppRegistration"
    ],
    "supportShellURLNamespaceObjects": 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"
    ],
    "preferredBrokerId": 1,
    "enableDriveRedirectionCache": true,
    "manageRDPTransportProtocol": [
      "0 = Disabled",
      "1 = BothUDPTCP",
      "2 = OnlyTCP",
      "3 = EitherUDPTCP"
    ],
    "enablePrinting": true,
    "enableTWAIN": true,
    "enableWIA": true,
    "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"
    ],
    "enableOptimization": true,
    "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"
        }
      ]
    }
  }
]

Move

Move a member to a RD Session Host Pool.

PUT/api/RDS/HostPool/{hostPoolId}/Members

Path parameters

hostPoolId*integer (int32)

ID of the member to be added to a RD Session Host Pool

Body

RD Session Host group member configuration

object

Move a member to the RD Session Host Pool

Response

No Content

Request

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

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Delete

Delete a member from a RD Session Host server group. This endpoint is obsolete, use Move Member endpoint instead.

DELETE/api/RDS/HostPool/{groupId}/Members/{rdsid}

Path parameters

groupId*integer (int32)

ID of the member of a RD Session Host server group to be deleted

rdsid*integer (int32)

ID of the RD Session Host server group of which the member will be deleted

Response

No Content

Request

const response = await fetch('/api/RDS/HostPool/{groupId}/Members/{rdsid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Add

Add a member to a RD Session Host server group. This endpoint is obsolete, use Move Member endpoint instead.

POST/api/RDS/HostPool/{groupId}/Members

Path parameters

groupId*integer (int32)

ID of the member to be added to a RD Session Host server group

Body

RD Session Host group member configuration

rdsIds*nullable array of integer (int32)

The IDs of RD Session Host servers to be added to the specified group.

Response

No Content

Request

const response = await fetch('/api/RDS/HostPool/{groupId}/Members', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "rdsIds": [
        null
      ]
    }),
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}