AVD

List

get

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

Query parameters

SiteIdinteger · int32Optional

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

NamestringOptional

Filter the result by name (optional)

Responses

200

Success

application/json; api-version=1.0

Published AVD Application

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

inheritMaintenancebooleanOptional

Inherit Maintenance.

replicateMaintenancebooleanOptional

Replicate Maintenance.

namestring · nullableOptional

Name of the published item.

typestring · enumOptional

RAS Publishing Objects

Possible values:

parentIdinteger · int32Optional

ID of the parent folder of the published item.

previousIdinteger · int32Optional

ID of the previous published item.

descriptionstring · nullableOptional

Description of the published item.

enabledModestring · enumOptional

Published resource availability modes.

Possible values:

enabledbooleanOptional

Whether the published item is enabled or not.

publishToSiteinteger · int32[] · nullableOptional

List of the IDs of all the sites this item is published to.

preferredRoutingEnabledbooleanOptional

Whether Preferred Routing is enabled or not.

startOnLogonbooleanOptional

Whether the 'Start automatically when user logs on' option is enabled or disabled.

excludePrelaunchbooleanOptional

Exclude application from prelaunch.

inheritShortcutDefaultSettingsbooleanOptional

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopbooleanOptional

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderbooleanOptional

Whether to create a shortcut in the start folder or not.

startPathstring · nullableOptional

Starting path of the published item.

createShortcutInStartUpFolderbooleanOptional

Whether to create a shortcut in the startup folder or not.

replicateShortcutSettingsbooleanOptional

Whether to replicate shortcut settings or not.

winTypestring · enumOptional

Published application window type

Possible values:

targetstring · nullableOptional

Application target file.

startInstring · nullableOptional

Application working directory.

parametersstring · nullableOptional

Application parameters.

packagestring · nullableOptional

Application package

packagedAppstring · nullableOptional

Application in the application package

avdHostPoolIDinteger · int32Optional

The AVD Host Pool ID.

enableFileExtensionsbooleanOptional

Whether file extensions option is enabled or not.

replicateFileExtensionSettingsbooleanOptional

Whether to replicate file extension settings or not.

inheritLicenseDefaultSettingsbooleanOptional

Whether to inherit license default settings or not.

disableSessionSharingbooleanOptional

Whether to disable session sharing or not.

oneInstancePerUserbooleanOptional

Whether the option for one instance per user is enabled or not.

conCurrentLicensesinteger · int32Optional

Number of concurrent licenses.

licenseLimitNotifystring · enumOptional

Defines actions to perform when the license limit is exceeded.

Possible values:

replicateLicenseSettingsbooleanOptional

Whether to replicate license settings or not.

inheritDisplayDefaultSettingsbooleanOptional

Whether the 'Inherit default license settings' option is enabled or disabled.

waitForPrintersbooleanOptional

Whether the application will wait for the printers or not.

waitForPrintersTimeoutinteger · int32Optional

Timeout for waiting of the application for the printers.

colorDepthstring · enumOptional

Color Depth

Possible values:

startMaximizedbooleanOptional

Whether the application will start as maximized or not.

startFullscreenbooleanOptional

Whether the application will start as fullscreen for WYSE ThinOS clients or not.

replicateDisplaySettingsbooleanOptional

Whether the 'Replicate Display Settings' is enabled or not.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/PubItems/Apps/AVD

HTTPcURLJavaScriptPython

GET /api/PubItems/Apps/AVD HTTP/1.1
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-16T17:29:47.342Z",
  "timeLastMod": "2026-03-16T17:29:47.342Z",
  "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",
    "10 = LocalApp"
  ],
  "parentId": 1,
  "previousId": 1,
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": true,
  "publishToSite": [
    1
  ],
  "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,
  "winType": [
    "0 = Normal",
    "1 = Maximized",
    "2 = Minimized"
  ],
  "target": "text",
  "startIn": "text",
  "parameters": "text",
  "package": "text",
  "packagedApp": "text",
  "avdHostPoolID": 1,
  "enableFileExtensions": true,
  "fileExtensions": [
    {
      "extension": "text",
      "parameters": "text",
      "enabled": true
    }
  ],
  "replicateFileExtensionSettings": true,
  "inheritLicenseDefaultSettings": true,
  "disableSessionSharing": true,
  "oneInstancePerUser": true,
  "conCurrentLicenses": 1,
  "licenseLimitNotify": [
    "0 = WarnUserAndNoStart",
    "1 = WarnUserAndStart",
    "2 = NotifyAdminAndStart",
    "3 = NotifyUserAdminAndStart",
    "4 = NotifyUserAdminAndNoStart"
  ],
  "replicateLicenseSettings": true,
  "inheritDisplayDefaultSettings": true,
  "waitForPrinters": true,
  "waitForPrintersTimeout": 1,
  "colorDepth": [
    "0 = Colors8Bit",
    "1 = Colors15Bit",
    "2 = Colors16Bit",
    "3 = Colors24Bit",
    "4 = Colors32Bit",
    "5 = ClientSpecified"
  ],
  "startMaximized": true,
  "startFullscreen": true,
  "replicateDisplaySettings": true
}

Create

post

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

Body

application/json; api-version=1.0

Create a new published application from a AVD Desktop

namestring · min: 1 · max: 255 · 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.

enabledModestring · enumOptional

Published resource availability modes.

Possible values:

maintenanceMessage_en_USstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in French.

maintenanceMessage_es_ESstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWstring · min: 1 · max: 255 · nullableOptional

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

maintenanceMessage_zh_CNstring · min: 1 · max: 255 · nullableOptional

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

maintenanceMessage_ko_KRstring · min: 1 · max: 255 · 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.

targetstring · nullableOptional

File name and path of a published application executable.

startInstring · nullableOptional

Folder name in which to start a published application.

parametersstring · nullableOptional

Optional parameters to pass to the published application executable.

packagestring · nullableOptional

The MSIX package.

packagedAppstring · nullableOptional

The Application within the MSIX Package.

startOnLogonbooleanOptional

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

Default: false

winTypestring · enumOptional

Published application window type

Possible values:

avdHostPoolIDinteger · int32Required

The AVD Host Pool ID.

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

/api/PubItems/Apps/AVD

HTTPcURLJavaScriptPython

POST /api/PubItems/Apps/AVD HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 776

{
  "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,
  "target": "text",
  "startIn": "text",
  "parameters": "text",
  "package": "text",
  "packagedApp": "text",
  "startOnLogon": false,
  "winType": [
    "0 = Normal",
    "1 = Maximized",
    "2 = Minimized"
  ],
  "avdHostPoolID": 1
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-16T17:29:47.342Z",
  "timeLastMod": "2026-03-16T17:29:47.342Z",
  "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",
    "10 = LocalApp"
  ],
  "parentId": 1,
  "previousId": 1,
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": true,
  "publishToSite": [
    1
  ],
  "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,
  "winType": [
    "0 = Normal",
    "1 = Maximized",
    "2 = Minimized"
  ],
  "target": "text",
  "startIn": "text",
  "parameters": "text",
  "package": "text",
  "packagedApp": "text",
  "avdHostPoolID": 1,
  "enableFileExtensions": true,
  "fileExtensions": [
    {
      "extension": "text",
      "parameters": "text",
      "enabled": true
    }
  ],
  "replicateFileExtensionSettings": true,
  "inheritLicenseDefaultSettings": true,
  "disableSessionSharing": true,
  "oneInstancePerUser": true,
  "conCurrentLicenses": 1,
  "licenseLimitNotify": [
    "0 = WarnUserAndNoStart",
    "1 = WarnUserAndStart",
    "2 = NotifyAdminAndStart",
    "3 = NotifyUserAdminAndStart",
    "4 = NotifyUserAdminAndNoStart"
  ],
  "replicateLicenseSettings": true,
  "inheritDisplayDefaultSettings": true,
  "waitForPrinters": true,
  "waitForPrintersTimeout": 1,
  "colorDepth": [
    "0 = Colors8Bit",
    "1 = Colors15Bit",
    "2 = Colors16Bit",
    "3 = Colors24Bit",
    "4 = Colors32Bit",
    "5 = ClientSpecified"
  ],
  "startMaximized": true,
  "startFullscreen": true,
  "replicateDisplaySettings": true
}

Get

get

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

Path parameters

idinteger · int32Required

ID of the published AVD application to be retrieved

Responses

200

Success

application/json; api-version=1.0

Published AVD Application

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

inheritMaintenancebooleanOptional

Inherit Maintenance.

replicateMaintenancebooleanOptional

Replicate Maintenance.

namestring · nullableOptional

Name of the published item.

typestring · enumOptional

RAS Publishing Objects

Possible values:

parentIdinteger · int32Optional

ID of the parent folder of the published item.

previousIdinteger · int32Optional

ID of the previous published item.

descriptionstring · nullableOptional

Description of the published item.

enabledModestring · enumOptional

Published resource availability modes.

Possible values:

enabledbooleanOptional

Whether the published item is enabled or not.

publishToSiteinteger · int32[] · nullableOptional

List of the IDs of all the sites this item is published to.

preferredRoutingEnabledbooleanOptional

Whether Preferred Routing is enabled or not.

startOnLogonbooleanOptional

Whether the 'Start automatically when user logs on' option is enabled or disabled.

excludePrelaunchbooleanOptional

Exclude application from prelaunch.

inheritShortcutDefaultSettingsbooleanOptional

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopbooleanOptional

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderbooleanOptional

Whether to create a shortcut in the start folder or not.

startPathstring · nullableOptional

Starting path of the published item.

createShortcutInStartUpFolderbooleanOptional

Whether to create a shortcut in the startup folder or not.

replicateShortcutSettingsbooleanOptional

Whether to replicate shortcut settings or not.

winTypestring · enumOptional

Published application window type

Possible values:

targetstring · nullableOptional

Application target file.

startInstring · nullableOptional

Application working directory.

parametersstring · nullableOptional

Application parameters.

packagestring · nullableOptional

Application package

packagedAppstring · nullableOptional

Application in the application package

avdHostPoolIDinteger · int32Optional

The AVD Host Pool ID.

enableFileExtensionsbooleanOptional

Whether file extensions option is enabled or not.

replicateFileExtensionSettingsbooleanOptional

Whether to replicate file extension settings or not.

inheritLicenseDefaultSettingsbooleanOptional

Whether to inherit license default settings or not.

disableSessionSharingbooleanOptional

Whether to disable session sharing or not.

oneInstancePerUserbooleanOptional

Whether the option for one instance per user is enabled or not.

conCurrentLicensesinteger · int32Optional

Number of concurrent licenses.

licenseLimitNotifystring · enumOptional

Defines actions to perform when the license limit is exceeded.

Possible values:

replicateLicenseSettingsbooleanOptional

Whether to replicate license settings or not.

inheritDisplayDefaultSettingsbooleanOptional

Whether the 'Inherit default license settings' option is enabled or disabled.

waitForPrintersbooleanOptional

Whether the application will wait for the printers or not.

waitForPrintersTimeoutinteger · int32Optional

Timeout for waiting of the application for the printers.

colorDepthstring · enumOptional

Color Depth

Possible values:

startMaximizedbooleanOptional

Whether the application will start as maximized or not.

startFullscreenbooleanOptional

Whether the application will start as fullscreen for WYSE ThinOS clients or not.

replicateDisplaySettingsbooleanOptional

Whether the 'Replicate Display Settings' is enabled or not.

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/PubItems/{id}/Apps/AVD

HTTPcURLJavaScriptPython

GET /api/PubItems/{id}/Apps/AVD HTTP/1.1
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-16T17:29:47.342Z",
  "timeLastMod": "2026-03-16T17:29:47.342Z",
  "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",
    "10 = LocalApp"
  ],
  "parentId": 1,
  "previousId": 1,
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": true,
  "publishToSite": [
    1
  ],
  "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,
  "winType": [
    "0 = Normal",
    "1 = Maximized",
    "2 = Minimized"
  ],
  "target": "text",
  "startIn": "text",
  "parameters": "text",
  "package": "text",
  "packagedApp": "text",
  "avdHostPoolID": 1,
  "enableFileExtensions": true,
  "fileExtensions": [
    {
      "extension": "text",
      "parameters": "text",
      "enabled": true
    }
  ],
  "replicateFileExtensionSettings": true,
  "inheritLicenseDefaultSettings": true,
  "disableSessionSharing": true,
  "oneInstancePerUser": true,
  "conCurrentLicenses": 1,
  "licenseLimitNotify": [
    "0 = WarnUserAndNoStart",
    "1 = WarnUserAndStart",
    "2 = NotifyAdminAndStart",
    "3 = NotifyUserAdminAndStart",
    "4 = NotifyUserAdminAndNoStart"
  ],
  "replicateLicenseSettings": true,
  "inheritDisplayDefaultSettings": true,
  "waitForPrinters": true,
  "waitForPrintersTimeout": 1,
  "colorDepth": [
    "0 = Colors8Bit",
    "1 = Colors15Bit",
    "2 = Colors16Bit",
    "3 = Colors24Bit",
    "4 = Colors32Bit",
    "5 = ClientSpecified"
  ],
  "startMaximized": true,
  "startFullscreen": true,
  "replicateDisplaySettings": true
}

Update

put

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

Path parameters

idinteger · int32Required

ID of the published AVD application to be updated

Body

application/json; api-version=1.0

Update settings of an application published from AVD Desktop

namestring · min: 1 · max: 255 · nullableOptional

A new name to assign to the published resource.

replicateMaintenanceboolean · nullableOptional

Replicate Maintenance

inheritMaintenanceboolean · nullableOptional

Inherit Maintenance

enabledModestring · enumOptional

Published resource availability modes.

Possible values:

maintenanceMessage_en_USstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in French.

maintenanceMessage_es_ESstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Portuguese.

maintenanceMessage_nl_NLstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in Dutch.

maintenanceMessage_de_DEstring · min: 1 · max: 255 · nullableOptional

Maintenance message for the published resource in German.

maintenanceMessage_zh_TWstring · min: 1 · max: 255 · nullableOptional

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

maintenanceMessage_zh_CNstring · min: 1 · max: 255 · nullableOptional

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

maintenanceMessage_ko_KRstring · min: 1 · max: 255 · 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.

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 · min: 1 · max: 255 · 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.

targetstring · nullableOptional

File name and path of a published application executable.

startInstring · nullableOptional

Folder name in which to start a published application.

parametersstring · nullableOptional

Optional parameters to pass to the published application executable.

packagestring · nullableOptional

The MSIX Package.

packagedAppstring · nullableOptional

The application within the MSIX package.

winTypestring · enumOptional

Published application window type

Possible values:

avdHostPoolIDinteger · int32 · nullableRequired

The AVD Host Pool ID.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/PubItems/{id}/Apps/AVD

HTTPcURLJavaScriptPython

PUT /api/PubItems/{id}/Apps/AVD HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 984

{
  "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,
  "target": "text",
  "startIn": "text",
  "parameters": "text",
  "package": "text",
  "packagedApp": "text",
  "winType": [
    "0 = Normal",
    "1 = Maximized",
    "2 = Minimized"
  ],
  "avdHostPoolID": 1
}

No content

Delete

delete

Delete a published application from a site. This is an Experimental feature which is subject to slight changes.

Path parameters

idinteger · int32Required

ID of the published AVD application to be deleted

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

/api/PubItems/{id}/Apps/AVD

HTTPcURLJavaScriptPython

DELETE /api/PubItems/{id}/Apps/AVD HTTP/1.1
Accept: */*

No content