AVD

Was this helpful?

List

Retrieve a list of all the published AVD desktops. This is an Experimental feature which is subject to slight changes.

get

/api/PubItems/Desktops/AVD

Query parameters

SiteIdinteger · int32

Site ID for which to retrieve all the published AVD desktops (optional)

Namestring

Filter the result by name (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-16T19:35:49.552Z",
  "timeLastMod": "2025-03-16T19:35:49.552Z",
  "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"
  ],
  "gatewayFilterEnabled": true,
  "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"
  ],
  "avdHostPoolID": 1
}

Success

Create

Add a published AVD desktop to a site. This is an Experimental feature which is subject to slight changes.

post

/api/PubItems/Desktops/AVD

Body

parentIdinteger · int32 | nullable

<para type="description">Parent publishing folder ID.</para>

previousIdinteger · int32 | nullable

<para type="description">Previous published ID.</para>

replicateMaintenanceboolean | nullable

<para type="description">Whether the option 'Replicate Maintenance' is enabled or not.</para>

inheritMaintenanceboolean | nullable

<para type="description">Whether to inherit default Maintenance settings.</para>

enabledboolean | nullableDeprecated

<para type="description">Enable or disable a published resource.</para>

enabledModestring · enum

<para type="synopsis">Published resource availability modes.</para> <para type="description"></para>

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

maintenanceMessage_en_USstring | nullable

<para type="description">Maintenance message for the published resource in English.</para>

maintenanceMessage_ja_JPstring | nullable

<para type="description">Maintenance message for the published resource in Japanese.</para>

maintenanceMessage_fr_FRstring | nullable

<para type="description">Maintenance message for the published resource in French.</para>

maintenanceMessage_es_ESstring | nullable

<para type="description">Maintenance message for the published resource in Spanish.</para>

maintenanceMessage_it_ITstring | nullable

<para type="description">Maintenance message for the published resource in Italian.</para>

maintenanceMessage_pt_BRstring | nullable

<para type="description">Maintenance message for the published resource in Portuguese.</para>

maintenanceMessage_de_DEstring | nullable

<para type="description">Maintenance message for the published resource in German.</para>

maintenanceMessage_nl_NLstring | nullable

<para type="description">Maintenance message for the published resource in Dutch.</para>

maintenanceMessage_zh_TWstring | nullable

<para type="description">Maintenance message for the published resource in Chinese (Traditional).</para>

maintenanceMessage_zh_CNstring | nullable

<para type="description">Maintenance message for the published resource in Chinese (Simplified).</para>

maintenanceMessage_ko_KRstring | nullable

<para type="description">Maintenance message for the published resource in Korean.</para>

descriptionstring | nullable

<para type="description">Published resource description.</para>

publishToSiteIdsinteger · int32[] | nullable

<para type="description">An array of Sites IDs to which to publish a resource.</para>

siteIdinteger · int32

<para type="description">Site ID in which to publish the specified Item.</para> <para type="description">If the parameter is omitted, the site ID of the Licensing Server will be used.</para>

ipFilterEnabledboolean | nullableDeprecated

<para type="description">Enable or disable IP filters.</para>

clientFilterEnabledboolean | nullableDeprecated

<para type="description">Enable or disable client filters.</para>

macFilterEnabledboolean | nullableDeprecated

<para type="description">Enable or disable mac filters.</para>

userFilterEnabledboolean | nullableDeprecated

<para type="description">Enable or disable user filters.</para>

gatewayFilterEnabledboolean | nullableDeprecated

<para type="description">Enable or disable Secure Gateway filters.</para>

startOnLogonboolean · default: false

<para type="description">Enable or disable the 'Start automatically when user logs on' option.</para>

widthinteger · int32

<para type="description">Specifies a custom desktop width.</para>

heightinteger · int32

<para type="description">Specifies a custom desktop height.</para>

desktopSizestring · enum

<para type="synopsis">Desktop size options for published desktops.</para> <para type="description"></para> <para type="description"></para>

Options:

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

allowMultiMonitorstring · enum

<para type="synopsis">Multi-monitor options for published desktops.</para> <para type="description"></para> <para type="description"></para>

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

namestring | nullablerequired

<para type="description">Published desktop name.</para>

avdHostPoolIDinteger · int32required

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/PubItems/Desktops/AVD' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "parentId": 1,
    "previousId": 1,
    "replicateMaintenance": true,
    "inheritMaintenance": true,
    "enabled": 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,
    "ipFilterEnabled": true,
    "clientFilterEnabled": true,
    "macFilterEnabled": true,
    "userFilterEnabled": true,
    "gatewayFilterEnabled": true,
    "startOnLogon": false,
    "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"
    ],
    "name": "text",
    "avdHostPoolID": 1
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-16T19:35:49.552Z",
  "timeLastMod": "2025-03-16T19:35:49.552Z",
  "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"
  ],
  "gatewayFilterEnabled": true,
  "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"
  ],
  "avdHostPoolID": 1
}

Created

Get

Retrieve information about a specified published AVD desktop. This is an Experimental feature which is subject to slight changes.

get

/api/PubItems/{id}/Desktops/AVD

Path parameters

idinteger · int32required

ID of the published AVD desktop to be retrieved

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-16T19:35:49.552Z",
  "timeLastMod": "2025-03-16T19:35:49.552Z",
  "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"
  ],
  "gatewayFilterEnabled": true,
  "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"
  ],
  "avdHostPoolID": 1
}

Success

Update

Modify properties of a specified published desktop. This is an Experimental feature which is subject to slight changes.

put

/api/PubItems/{id}/Desktops/AVD

Path parameters

idinteger · int32required

ID of the published AVD desktop to be updated

Body

namestring | nullable

<para type="description">A new name to assign to the published resource.</para>

replicateMaintenanceboolean | nullable

<para type="description">Replicate Maintenance</para>

inheritMaintenanceboolean | nullable

<para type="description">Inherit Maintenance</para>

enabledboolean | nullableDeprecated

<para type="description">Enable or disable a published resource.</para>

enabledModestring · enum

<para type="synopsis">Published resource availability modes.</para> <para type="description"></para>

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

maintenanceMessage_en_USstring | nullable

<para type="description">Maintenance message for the published resource in English.</para>

maintenanceMessage_ja_JPstring | nullable

<para type="description">Maintenance message for the published resource in Japanese.</para>

maintenanceMessage_fr_FRstring | nullable

<para type="description">Maintenance message for the published resource in French.</para>

maintenanceMessage_es_ESstring | nullable

<para type="description">Maintenance message for the published resource in Spanish.</para>

maintenanceMessage_it_ITstring | nullable

<para type="description">Maintenance message for the published resource in Italian.</para>

maintenanceMessage_pt_BRstring | nullable

<para type="description">Maintenance message for the published resource in Portuguese.</para>

maintenanceMessage_nl_NLstring | nullable

<para type="description">Maintenance message for the published resource in Dutch.</para>

maintenanceMessage_de_DEstring | nullable

<para type="description">Maintenance message for the published resource in German.</para>

maintenanceMessage_zh_TWstring | nullable

<para type="description">Maintenance message for the published resource in Chinese (Traditional).</para>

maintenanceMessage_zh_CNstring | nullable

<para type="description">Maintenance message for the published resource in Chinese (Simplified).</para>

maintenanceMessage_ko_KRstring | nullable

<para type="description">Maintenance message for the published resource in Korean.</para>

descriptionstring | nullable

<para type="description">Published resource description.</para>

publishToSiteIdsinteger · int32[] | nullable

<para type="description">An array of sites to which to publish a resource.</para>

ipFilterEnabledboolean | nullableDeprecated

<para type="description">Enable or disable IP filters.</para>

clientFilterEnabledboolean | nullableDeprecated

<para type="description">Enable or disable client filters.</para>

macFilterEnabledboolean | nullableDeprecated

<para type="description">Enable or disable mac filters.</para>

userFilterEnabledboolean | nullableDeprecated

<para type="description">Enable or disable user filters.</para>

gatewayFilterEnabledboolean | nullableDeprecated

<para type="description">Enable or disable Secure Gateway filters.</para>

osFilterEnabledboolean | nullableDeprecated

<para type="description">Enable or disable the OS filter.</para>

allowClientChromeboolean | nullableDeprecated

<para type="description">Allow or not Chrome OS Clients.</para>

allowClientAndroidboolean | nullableDeprecated

<para type="description">Allow or not Android Clients.</para>

allowClientWebboolean | nullableDeprecated

<para type="description">Allow or not Web Clients.</para>

allowClientIOSboolean | nullableDeprecated

<para type="description">Allow or not IOS Clients.</para>

allowClientLinuxboolean | nullableDeprecated

<para type="description">Allow or not Linux Clients.</para>

allowClientMACboolean | nullableDeprecated

<para type="description">Allow or not MAC Clients.</para>

allowClientWindowsboolean | nullableDeprecated

<para type="description">Allow or not Windows Clients.</para>

allowClientWyseboolean | nullableDeprecated

<para type="description">Allow or not Wyse Clients.</para>

preferredRoutingEnabledboolean | nullable

<para type="description">Enable or disable Preferred Routing.</para>

replicateShortcutSettingsboolean | nullable

<para type="description">Replicate shortcut settings to all sites.</para>

createShortcutOnDesktopboolean | nullable

<para type="description">Create a shortcut on a client's desktop.</para>

createShortcutInStartFolderboolean | nullable

<para type="description">Create a shortcut in the client's Start folder.</para>

createShortcutInStartUpFolderboolean | nullable

<para type="description">Create a shortcut in the client's Auto Start folder.</para>

startPathstring | nullable

<para type="description">Specifies the path in the Start folder where the shortcut will be created.</para>

inheritShortcutDefaultSettingsboolean | nullable

<para type="description">Inherit default shortcut settings.</para>

startOnLogonboolean | nullable

<para type="description">Start a resource automatically when a user logs on.</para>

excludePrelaunchboolean | nullable

<para type="description">Exclude application from prelaunch.</para>

widthinteger · int32 | nullable

<para type="description">Desktop width.</para>

heightinteger · int32 | nullable

<para type="description">Desktop height.</para>

desktopSizestring · enum

<para type="synopsis">Desktop size options for published desktops.</para> <para type="description"></para> <para type="description"></para>

Options:

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

allowMultiMonitorstring · enum

<para type="synopsis">Multi-monitor options for published desktops.</para> <para type="description"></para> <para type="description"></para>

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

avdHostPoolIDinteger · int32 | nullablerequired

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/PubItems/{id}/Desktops/AVD' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "replicateMaintenance": true,
    "inheritMaintenance": true,
    "enabled": 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
    ],
    "ipFilterEnabled": true,
    "clientFilterEnabled": true,
    "macFilterEnabled": true,
    "userFilterEnabled": true,
    "gatewayFilterEnabled": true,
    "osFilterEnabled": true,
    "allowClientChrome": true,
    "allowClientAndroid": true,
    "allowClientWeb": true,
    "allowClientIOS": true,
    "allowClientLinux": true,
    "allowClientMAC": true,
    "allowClientWindows": true,
    "allowClientWyse": true,
    "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"
    ],
    "avdHostPoolID": 1
  }'

204

401

404

No body

No Content

Delete

Delete a published AVD desktop. This is an Experimental feature which is subject to slight changes.

delete

/api/PubItems/{id}/Desktops/AVD

Path parameters

idinteger · int32required

ID of the published AVD desktop to be deleted

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No body

No Content