RDS

PreviousAVD NextVDI

Was this helpful?

Get

get

Retrieve information about a specified published RD Session Host desktop.

Path parameters

idinteger · int32required

ID of the published RD Session Host desktop to be retrieved

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/PubItems/{id}/Desktops/RDS'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:49:02.153Z",
  "timeLastMod": "2025-04-06T01:49:02.153Z",
  "maintenanceMessages": {
    "maintenanceMessage_en_US": "text",
    "maintenanceMessage_ja_JP": "text",
    "maintenanceMessage_fr_FR": "text",
    "maintenanceMessage_es_ES": "text",
    "maintenanceMessage_it_IT": "text",
    "maintenanceMessage_pt_BR": "text",
    "maintenanceMessage_nl_NL": "text",
    "maintenanceMessage_zh_TW": "text",
    "maintenanceMessage_zh_CN": "text",
    "maintenanceMessage_ko_KR": "text",
    "maintenanceMessage_de_DE": "text"
  },
  "inheritMaintenance": true,
  "replicateMaintenance": true,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "parentId": 1,
  "previousId": 1,
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": true,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": true,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": true,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": true,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": true,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "webClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "wyse": true,
    "windows": true
  },
  "preferredRoutingEnabled": true,
  "preferredRoutes": [
    {
      "id": 1,
      "priority": 1,
      "name": "text",
      "description": "text",
      "enabled": true,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ],
      "referenceId": 1
    }
  ],
  "filter": {
    "rules": [
      {
        "id": 1,
        "priority": 1,
        "enabled": true,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": true,
              "android": true,
              "webClient": true,
              "iOS": true,
              "linux": true,
              "mac": true,
              "wyse": true,
              "windows": true
            }
          },
          "iPs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": [
              1
            ]
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": true,
  "excludePrelaunch": true,
  "inheritShortcutDefaultSettings": true,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": true,
  "startPath": "text",
  "createShortcutInStartUpFolder": true,
  "replicateShortcutSettings": true,
  "desktopSize": [
    "0 = UseAvailableArea",
    "1 = FullScreen",
    "2 = W640xH480",
    "3 = W800xH600",
    "4 = W854xH480",
    "5 = W1024xH576",
    "6 = W1024xH768",
    "7 = W1152xH864",
    "8 = W1280xH720",
    "9 = W1280xH768",
    "10 = W1280xH800",
    "11 = W1280xH960",
    "12 = W1280xH1024",
    "13 = W1360xH768",
    "14 = W1366xH768",
    "15 = W1400xH1050",
    "16 = W1440xH900",
    "17 = W1600xH900",
    "18 = W1600xH1024",
    "19 = W1600xH1200",
    "20 = W1680xH1050",
    "21 = W1920xH1080",
    "22 = W1920xH1200",
    "23 = W1920xH1440",
    "24 = W2048xH1152",
    "25 = Custom"
  ],
  "width": 1,
  "height": 1,
  "allowMultiMonitor": [
    "0 = Enabled",
    "1 = Disabled",
    "2 = UseClientSettings"
  ],
  "connectToConsole": true,
  "publishFromServer": [
    1
  ],
  "publishFromHostPool": [
    1
  ],
  "publishFrom": [
    "0 = All",
    "1 = HostPool",
    "2 = Host"
  ]
}

Success

Delete

delete

Delete a published RD Session Host desktop

Path parameters

idinteger · int32required

ID of the published RD Session Host desktop to be deleted

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/PubItems/{id}/Desktops/RDS'

204

401

404

No Content

List

get

Retrieve a list of all the published RD Session Host desktops

Query parameters

SiteIdinteger · int32optional

Site ID for which to retrieve all the published RD Session Host desktops (optional)

Namestringoptional

Filter the result by name (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/PubItems/Desktops/RDS'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:49:02.153Z",
  "timeLastMod": "2025-04-06T01:49:02.153Z",
  "maintenanceMessages": {
    "maintenanceMessage_en_US": "text",
    "maintenanceMessage_ja_JP": "text",
    "maintenanceMessage_fr_FR": "text",
    "maintenanceMessage_es_ES": "text",
    "maintenanceMessage_it_IT": "text",
    "maintenanceMessage_pt_BR": "text",
    "maintenanceMessage_nl_NL": "text",
    "maintenanceMessage_zh_TW": "text",
    "maintenanceMessage_zh_CN": "text",
    "maintenanceMessage_ko_KR": "text",
    "maintenanceMessage_de_DE": "text"
  },
  "inheritMaintenance": true,
  "replicateMaintenance": true,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "parentId": 1,
  "previousId": 1,
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": true,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": true,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": true,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": true,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": true,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "webClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "wyse": true,
    "windows": true
  },
  "preferredRoutingEnabled": true,
  "preferredRoutes": [
    {
      "id": 1,
      "priority": 1,
      "name": "text",
      "description": "text",
      "enabled": true,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ],
      "referenceId": 1
    }
  ],
  "filter": {
    "rules": [
      {
        "id": 1,
        "priority": 1,
        "enabled": true,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": true,
              "android": true,
              "webClient": true,
              "iOS": true,
              "linux": true,
              "mac": true,
              "wyse": true,
              "windows": true
            }
          },
          "iPs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": [
              1
            ]
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": true,
  "excludePrelaunch": true,
  "inheritShortcutDefaultSettings": true,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": true,
  "startPath": "text",
  "createShortcutInStartUpFolder": true,
  "replicateShortcutSettings": true,
  "desktopSize": [
    "0 = UseAvailableArea",
    "1 = FullScreen",
    "2 = W640xH480",
    "3 = W800xH600",
    "4 = W854xH480",
    "5 = W1024xH576",
    "6 = W1024xH768",
    "7 = W1152xH864",
    "8 = W1280xH720",
    "9 = W1280xH768",
    "10 = W1280xH800",
    "11 = W1280xH960",
    "12 = W1280xH1024",
    "13 = W1360xH768",
    "14 = W1366xH768",
    "15 = W1400xH1050",
    "16 = W1440xH900",
    "17 = W1600xH900",
    "18 = W1600xH1024",
    "19 = W1600xH1200",
    "20 = W1680xH1050",
    "21 = W1920xH1080",
    "22 = W1920xH1200",
    "23 = W1920xH1440",
    "24 = W2048xH1152",
    "25 = Custom"
  ],
  "width": 1,
  "height": 1,
  "allowMultiMonitor": [
    "0 = Enabled",
    "1 = Disabled",
    "2 = UseClientSettings"
  ],
  "connectToConsole": true,
  "publishFromServer": [
    1
  ],
  "publishFromHostPool": [
    1
  ],
  "publishFrom": [
    "0 = All",
    "1 = HostPool",
    "2 = Host"
  ]
}

Success

Create

post

Add a published RD Session Host desktop to a site.

Body

Create a new published desktop from a RD Session Host

namestring | nullablerequired

Published resource name.

parentIdinteger · int32 | nullableoptional

Parent publishing folder ID.

previousIdinteger · int32 | nullableoptional

Previous published ID.

replicateMaintenanceboolean | nullableoptional

Whether the option 'Replicate Maintenance' is enabled or not.

inheritMaintenanceboolean | nullableoptional

Whether to inherit default Maintenance settings.

enabledboolean | nullableoptionalDeprecated

Enable or disable a published resource.

enabledModestring · enumoptional

Published resource availability modes.

Available options:

maintenanceMessage_en_USstring | nullableoptional

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPstring | nullableoptional

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRstring | nullableoptional

Maintenance message for the published resource in French.

maintenanceMessage_es_ESstring | nullableoptional

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITstring | nullableoptional

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRstring | nullableoptional

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEstring | nullableoptional

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLstring | nullableoptional

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWstring | nullableoptional

Maintenance message for the published resource in Chinese (Traditional).

maintenanceMessage_zh_CNstring | nullableoptional

Maintenance message for the published resource in Chinese (Simplified).

maintenanceMessage_ko_KRstring | nullableoptional

Maintenance message for the published resource in Korean.

descriptionstring | nullableoptional

Published resource description.

publishToSiteIdsinteger · int32[] | nullableoptional

An array of Sites IDs to which to publish a resource.

siteIdinteger · int32optional

Site ID in which to publish the specified Item. If the parameter is omitted, the site ID of the Licensing Server will be used.

ipFilterEnabledboolean | nullableoptionalDeprecated

Enable or disable IP filters.

clientFilterEnabledboolean | nullableoptionalDeprecated

Enable or disable client filters.

macFilterEnabledboolean | nullableoptionalDeprecated

Enable or disable mac filters.

userFilterEnabledboolean | nullableoptionalDeprecated

Enable or disable user filters.

gatewayFilterEnabledboolean | nullableoptionalDeprecated

Enable or disable Secure Gateway filters.

startOnLogonbooleanoptional

Enable or disable the 'Start automatically when user logs on' option.

Default: false

widthinteger · int32optional

Specifies a custom desktop width.

heightinteger · int32optional

Specifies a custom desktop height.

desktopSizestring · enumoptional

Desktop size options for published desktops.

Available options:

allowMultiMonitorstring · enumoptional

Multi-monitor options for published desktops.

Available options:

connectToConsolebooleanoptional

Enable or disable the 'Connect to console' option.

Default: false

publishFromstring · enumoptional

Publish From' options for published items.

Available options:

publishFromHostPoolIdsinteger · int32[] | nullableoptional

Specifies one or multiple host pool Ids from which to publish a desktop. The PublishFrom parameter must specify 1 (HostPool).

publishFromServerIdsinteger · int32[] | nullableoptional

Specifies one or multiple RDS Host server Ids from which to publish a desktop. The PublishFrom parameter must specify 2 (Host).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/PubItems/Desktops/RDS' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "parentId": 1,
    "previousId": 1,
    "replicateMaintenance": true,
    "inheritMaintenance": true,
    "enabledMode": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = Maintenance"
    ],
    "maintenanceMessage_en_US": "text",
    "maintenanceMessage_ja_JP": "text",
    "maintenanceMessage_fr_FR": "text",
    "maintenanceMessage_es_ES": "text",
    "maintenanceMessage_it_IT": "text",
    "maintenanceMessage_pt_BR": "text",
    "maintenanceMessage_de_DE": "text",
    "maintenanceMessage_nl_NL": "text",
    "maintenanceMessage_zh_TW": "text",
    "maintenanceMessage_zh_CN": "text",
    "maintenanceMessage_ko_KR": "text",
    "description": "text",
    "publishToSiteIds": [
      1
    ],
    "siteId": 1,
    "startOnLogon": true,
    "width": 1,
    "height": 1,
    "desktopSize": [
      "0 = UseAvailableArea",
      "1 = FullScreen",
      "2 = W640xH480",
      "3 = W800xH600",
      "4 = W854xH480",
      "5 = W1024xH576",
      "6 = W1024xH768",
      "7 = W1152xH864",
      "8 = W1280xH720",
      "9 = W1280xH768",
      "10 = W1280xH800",
      "11 = W1280xH960",
      "12 = W1280xH1024",
      "13 = W1360xH768",
      "14 = W1366xH768",
      "15 = W1400xH1050",
      "16 = W1440xH900",
      "17 = W1600xH900",
      "18 = W1600xH1024",
      "19 = W1600xH1200",
      "20 = W1680xH1050",
      "21 = W1920xH1080",
      "22 = W1920xH1200",
      "23 = W1920xH1440",
      "24 = W2048xH1152",
      "25 = Custom"
    ],
    "allowMultiMonitor": [
      "0 = Enabled",
      "1 = Disabled",
      "2 = UseClientSettings"
    ],
    "connectToConsole": true,
    "publishFrom": [
      "0 = All",
      "1 = HostPool",
      "2 = Host"
    ],
    "publishFromHostPoolIds": [
      1
    ],
    "publishFromServerIds": [
      1
    ]
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:49:02.153Z",
  "timeLastMod": "2025-04-06T01:49:02.153Z",
  "maintenanceMessages": {
    "maintenanceMessage_en_US": "text",
    "maintenanceMessage_ja_JP": "text",
    "maintenanceMessage_fr_FR": "text",
    "maintenanceMessage_es_ES": "text",
    "maintenanceMessage_it_IT": "text",
    "maintenanceMessage_pt_BR": "text",
    "maintenanceMessage_nl_NL": "text",
    "maintenanceMessage_zh_TW": "text",
    "maintenanceMessage_zh_CN": "text",
    "maintenanceMessage_ko_KR": "text",
    "maintenanceMessage_de_DE": "text"
  },
  "inheritMaintenance": true,
  "replicateMaintenance": true,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "parentId": 1,
  "previousId": 1,
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": true,
  "publishToSite": [
    1
  ],
  "userFilterEnabled": true,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": true,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": true,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": true,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": true,
  "allowedOSes": {
    "chrome": true,
    "android": true,
    "webClient": true,
    "iOS": true,
    "linux": true,
    "mac": true,
    "wyse": true,
    "windows": true
  },
  "preferredRoutingEnabled": true,
  "preferredRoutes": [
    {
      "id": 1,
      "priority": 1,
      "name": "text",
      "description": "text",
      "enabled": true,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ],
      "referenceId": 1
    }
  ],
  "filter": {
    "rules": [
      {
        "id": 1,
        "priority": 1,
        "enabled": true,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": true,
              "android": true,
              "webClient": true,
              "iOS": true,
              "linux": true,
              "mac": true,
              "wyse": true,
              "windows": true
            }
          },
          "iPs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": true,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": [
              1
            ]
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": true,
  "excludePrelaunch": true,
  "inheritShortcutDefaultSettings": true,
  "createShortcutOnDesktop": true,
  "createShortcutInStartFolder": true,
  "startPath": "text",
  "createShortcutInStartUpFolder": true,
  "replicateShortcutSettings": true,
  "desktopSize": [
    "0 = UseAvailableArea",
    "1 = FullScreen",
    "2 = W640xH480",
    "3 = W800xH600",
    "4 = W854xH480",
    "5 = W1024xH576",
    "6 = W1024xH768",
    "7 = W1152xH864",
    "8 = W1280xH720",
    "9 = W1280xH768",
    "10 = W1280xH800",
    "11 = W1280xH960",
    "12 = W1280xH1024",
    "13 = W1360xH768",
    "14 = W1366xH768",
    "15 = W1400xH1050",
    "16 = W1440xH900",
    "17 = W1600xH900",
    "18 = W1600xH1024",
    "19 = W1600xH1200",
    "20 = W1680xH1050",
    "21 = W1920xH1080",
    "22 = W1920xH1200",
    "23 = W1920xH1440",
    "24 = W2048xH1152",
    "25 = Custom"
  ],
  "width": 1,
  "height": 1,
  "allowMultiMonitor": [
    "0 = Enabled",
    "1 = Disabled",
    "2 = UseClientSettings"
  ],
  "connectToConsole": true,
  "publishFromServer": [
    1
  ],
  "publishFromHostPool": [
    1
  ],
  "publishFrom": [
    "0 = All",
    "1 = HostPool",
    "2 = Host"
  ]
}

Created

Update

put

Modify properties of a specified published desktop.

Path parameters

idinteger · int32required

ID of the published RD Session Host desktop to be updated

Body

Update settings of a desktop published from a RD Session Host

namestring | nullableoptional

A new name to assign to the published resource.

replicateMaintenanceboolean | nullableoptional

Replicate Maintenance

inheritMaintenanceboolean | nullableoptional

Inherit Maintenance

enabledboolean | nullableoptionalDeprecated

Enable or disable a published resource.

enabledModestring · enumoptional

Published resource availability modes.

Available options:

maintenanceMessage_en_USstring | nullableoptional

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPstring | nullableoptional

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRstring | nullableoptional

Maintenance message for the published resource in French.

maintenanceMessage_es_ESstring | nullableoptional

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITstring | nullableoptional

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRstring | nullableoptional

Maintenance message for the published resource in Portuguese.

maintenanceMessage_nl_NLstring | nullableoptional

Maintenance message for the published resource in Dutch.

maintenanceMessage_de_DEstring | nullableoptional

Maintenance message for the published resource in German.

maintenanceMessage_zh_TWstring | nullableoptional

Maintenance message for the published resource in Chinese (Traditional).

maintenanceMessage_zh_CNstring | nullableoptional

Maintenance message for the published resource in Chinese (Simplified).

maintenanceMessage_ko_KRstring | nullableoptional

Maintenance message for the published resource in Korean.

descriptionstring | nullableoptional

Published resource description.

publishToSiteIdsinteger · int32[] | nullableoptional

An array of sites to which to publish a resource.

ipFilterEnabledboolean | nullableoptionalDeprecated

Enable or disable IP filters.

clientFilterEnabledboolean | nullableoptionalDeprecated

Enable or disable client filters.

macFilterEnabledboolean | nullableoptionalDeprecated

Enable or disable mac filters.

userFilterEnabledboolean | nullableoptionalDeprecated

Enable or disable user filters.

gatewayFilterEnabledboolean | nullableoptionalDeprecated

Enable or disable Secure Gateway filters.

osFilterEnabledboolean | nullableoptionalDeprecated

Enable or disable the OS filter.

allowClientChromeboolean | nullableoptionalDeprecated

Allow or not Chrome OS Clients.

allowClientAndroidboolean | nullableoptionalDeprecated

Allow or not Android Clients.

allowClientWebboolean | nullableoptionalDeprecated

Allow or not Web Clients.

allowClientIOSboolean | nullableoptionalDeprecated

Allow or not IOS Clients.

allowClientLinuxboolean | nullableoptionalDeprecated

Allow or not Linux Clients.

allowClientMACboolean | nullableoptionalDeprecated

Allow or not MAC Clients.

allowClientWindowsboolean | nullableoptionalDeprecated

Allow or not Windows Clients.

allowClientWyseboolean | nullableoptionalDeprecated

Allow or not Wyse Clients.

preferredRoutingEnabledboolean | nullableoptional

Enable or disable Preferred Routing.

replicateShortcutSettingsboolean | nullableoptional

Replicate shortcut settings to all sites.

createShortcutOnDesktopboolean | nullableoptional

Create a shortcut on a client's desktop.

createShortcutInStartFolderboolean | nullableoptional

Create a shortcut in the client's Start folder.

createShortcutInStartUpFolderboolean | nullableoptional

Create a shortcut in the client's Auto Start folder.

startPathstring | nullableoptional

Specifies the path in the Start folder where the shortcut will be created.

inheritShortcutDefaultSettingsboolean | nullableoptional

Inherit default shortcut settings.

startOnLogonboolean | nullableoptional

Start a resource automatically when a user logs on.

excludePrelaunchboolean | nullableoptional

Exclude application from prelaunch.

widthinteger · int32 | nullableoptional

Desktop width.

heightinteger · int32 | nullableoptional

Desktop height.

desktopSizestring · enumoptional

Desktop size options for published desktops.

Available options:

allowMultiMonitorstring · enumoptional

Multi-monitor options for published desktops.

Available options:

connectToConsoleboolean | nullableoptional

Enable or disable the 'Connect to console' option.

publishFromstring · enumoptional

Publish From' options for published items.

Available options:

publishFromHostPoolIdsinteger · int32[] | nullableoptional

Specifies one or multiple host pool Ids from which to publish a desktop. The PublishFrom parameter must specify 1 (HostPool).

publishFromServerIdsinteger · int32[] | nullableoptional

Specifies one or multiple RDS Host server Ids from which to publish a desktop. The PublishFrom parameter must specify 2 (Host).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/PubItems/{id}/Desktops/RDS' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "replicateMaintenance": true,
    "inheritMaintenance": true,
    "enabledMode": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = Maintenance"
    ],
    "maintenanceMessage_en_US": "text",
    "maintenanceMessage_ja_JP": "text",
    "maintenanceMessage_fr_FR": "text",
    "maintenanceMessage_es_ES": "text",
    "maintenanceMessage_it_IT": "text",
    "maintenanceMessage_pt_BR": "text",
    "maintenanceMessage_nl_NL": "text",
    "maintenanceMessage_de_DE": "text",
    "maintenanceMessage_zh_TW": "text",
    "maintenanceMessage_zh_CN": "text",
    "maintenanceMessage_ko_KR": "text",
    "description": "text",
    "publishToSiteIds": [
      1
    ],
    "preferredRoutingEnabled": true,
    "replicateShortcutSettings": true,
    "createShortcutOnDesktop": true,
    "createShortcutInStartFolder": true,
    "createShortcutInStartUpFolder": true,
    "startPath": "text",
    "inheritShortcutDefaultSettings": true,
    "startOnLogon": true,
    "excludePrelaunch": true,
    "width": 1,
    "height": 1,
    "desktopSize": [
      "0 = UseAvailableArea",
      "1 = FullScreen",
      "2 = W640xH480",
      "3 = W800xH600",
      "4 = W854xH480",
      "5 = W1024xH576",
      "6 = W1024xH768",
      "7 = W1152xH864",
      "8 = W1280xH720",
      "9 = W1280xH768",
      "10 = W1280xH800",
      "11 = W1280xH960",
      "12 = W1280xH1024",
      "13 = W1360xH768",
      "14 = W1366xH768",
      "15 = W1400xH1050",
      "16 = W1440xH900",
      "17 = W1600xH900",
      "18 = W1600xH1024",
      "19 = W1600xH1200",
      "20 = W1680xH1050",
      "21 = W1920xH1080",
      "22 = W1920xH1200",
      "23 = W1920xH1440",
      "24 = W2048xH1152",
      "25 = Custom"
    ],
    "allowMultiMonitor": [
      "0 = Enabled",
      "1 = Disabled",
      "2 = UseClientSettings"
    ],
    "connectToConsole": true,
    "publishFrom": [
      "0 = All",
      "1 = HostPool",
      "2 = Host"
    ],
    "publishFromHostPoolIds": [
      1
    ],
    "publishFromServerIds": [
      1
    ]
  }'

204

401

404

No Content