RDS

List

Retrieve a list of all the published RD Session Host desktops

GET/api/PubItems/Desktops/RDS

Query parameters

SiteIdinteger (int32)

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

Namestring

Filter the result by name (optional)

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

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

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

connectToConsoleboolean

Connect to console

publishFromServernullable array of integer (int32)

List of servers to publish from.

itemsinteger (int32)

publishFromHostPoolnullable array of integer (int32)

List of groups to publish from.

itemsinteger (int32)

publishFromPublishFrom (enum)

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host

Request

Response

Create

Add a published RD Session Host desktop to a site.

POST/api/PubItems/Desktops/RDS

Body

name*nullable string

Published resource name.

parentIdnullable integer (int32)

Parent publishing folder ID.

previousIdnullable integer (int32)

Previous published ID.

replicateMaintenancenullable boolean

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

inheritMaintenancenullable boolean

Whether to inherit default Maintenance settings.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

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

itemsinteger (int32)

siteIdinteger (int32)

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

startOnLogonboolean

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

widthinteger (int32)

Specifies a custom desktop width.

heightinteger (int32)

Specifies a custom desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

connectToConsoleboolean

Enable or disable the 'Connect to console' option.

publishFromPublishFrom (enum)

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host

publishFromHostPoolIdsnullable array of integer (int32)

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

itemsinteger (int32)

publishFromServerIdsnullable array of integer (int32)

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

itemsinteger (int32)

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

connectToConsoleboolean

Connect to console

publishFromServernullable array of integer (int32)

List of servers to publish from.

itemsinteger (int32)

publishFromHostPoolnullable array of integer (int32)

List of groups to publish from.

itemsinteger (int32)

publishFromPublishFrom (enum)

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host

Request

Response

Get

Retrieve information about a specified published RD Session Host desktop.

GET/api/PubItems/{id}/Desktops/RDS

Path parameters

id*integer (int32)

ID of the published RD Session Host desktop to be retrieved

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

connectToConsoleboolean

Connect to console

publishFromServernullable array of integer (int32)

List of servers to publish from.

itemsinteger (int32)

publishFromHostPoolnullable array of integer (int32)

List of groups to publish from.

itemsinteger (int32)

publishFromPublishFrom (enum)

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host

Request

Response

Update

Modify properties of a specified published desktop.

PUT/api/PubItems/{id}/Desktops/RDS

Path parameters

id*integer (int32)

ID of the published RD Session Host desktop to be updated

Body

Published RD Session Host desktop configuration

namenullable string

A new name to assign to the published resource.

replicateMaintenancenullable boolean

Replicate Maintenance

inheritMaintenancenullable boolean

Inherit Maintenance

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of sites to which to publish a resource.

itemsinteger (int32)

preferredRoutingEnablednullable boolean

Enable or disable Preferred Routing.

replicateShortcutSettingsnullable boolean

Replicate shortcut settings to all sites.

createShortcutOnDesktopnullable boolean

Create a shortcut on a client's desktop.

createShortcutInStartFoldernullable boolean

Create a shortcut in the client's Start folder.

createShortcutInStartUpFoldernullable boolean

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

startPathnullable string

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

inheritShortcutDefaultSettingsnullable boolean

Inherit default shortcut settings.

startOnLogonnullable boolean

Start a resource automatically when a user logs on.

excludePrelaunchnullable boolean

Exclude application from prelaunch.

widthnullable integer (int32)

Desktop width.

heightnullable integer (int32)

Desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

connectToConsolenullable boolean

Enable or disable the 'Connect to console' option.

publishFromPublishFrom (enum)

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host

publishFromHostPoolIdsnullable array of integer (int32)

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

itemsinteger (int32)

publishFromServerIdsnullable array of integer (int32)

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

itemsinteger (int32)

Response

No Content

Request

Response

Delete

Delete a published RD Session Host desktop

DELETE/api/PubItems/{id}/Desktops/RDS

Path parameters

id*integer (int32)

ID of the published RD Session Host desktop to be deleted

Response

No Content

Request

Response

Update

Modify properties of a specified published desktop.

PUT/api/PubItems/{id}/Desktops/RDS

Path parameters

id*integer (int32)

ID of the published RD Session Host desktop to be updated

Body

Published RD Session Host desktop configuration

namenullable string

A new name to assign to the published resource.

replicateMaintenancenullable boolean

Replicate Maintenance

inheritMaintenancenullable boolean

Inherit Maintenance

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of sites to which to publish a resource.

itemsinteger (int32)

preferredRoutingEnablednullable boolean

Enable or disable Preferred Routing.

replicateShortcutSettingsnullable boolean

Replicate shortcut settings to all sites.

createShortcutOnDesktopnullable boolean

Create a shortcut on a client's desktop.

createShortcutInStartFoldernullable boolean

Create a shortcut in the client's Start folder.

createShortcutInStartUpFoldernullable boolean

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

startPathnullable string

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

inheritShortcutDefaultSettingsnullable boolean

Inherit default shortcut settings.

startOnLogonnullable boolean

Start a resource automatically when a user logs on.

excludePrelaunchnullable boolean

Exclude application from prelaunch.

widthnullable integer (int32)

Desktop width.

heightnullable integer (int32)

Desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

connectToConsolenullable boolean

Enable or disable the 'Connect to console' option.

publishFromPublishFrom (enum)

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host

publishFromHostPoolIdsnullable array of integer (int32)

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

itemsinteger (int32)

publishFromServerIdsnullable array of integer (int32)

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

itemsinteger (int32)

Response

No Content

Request

Response

List

Retrieve a list of all the published RD Session Host desktops

GET/api/PubItems/Desktops/RDS

Query parameters

SiteIdinteger (int32)

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

Namestring

Filter the result by name (optional)

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

connectToConsoleboolean

Connect to console

publishFromServernullable array of integer (int32)

List of servers to publish from.

itemsinteger (int32)

publishFromHostPoolnullable array of integer (int32)

List of groups to publish from.

itemsinteger (int32)

publishFromPublishFrom (enum)

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host

Request

Response

Create

Add a published RD Session Host desktop to a site.

POST/api/PubItems/Desktops/RDS

Body

name*nullable string

Published resource name.

parentIdnullable integer (int32)

Parent publishing folder ID.

previousIdnullable integer (int32)

Previous published ID.

replicateMaintenancenullable boolean

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

inheritMaintenancenullable boolean

Whether to inherit default Maintenance settings.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

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

itemsinteger (int32)

siteIdinteger (int32)

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

startOnLogonboolean

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

widthinteger (int32)

Specifies a custom desktop width.

heightinteger (int32)

Specifies a custom desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

connectToConsoleboolean

Enable or disable the 'Connect to console' option.

publishFromPublishFrom (enum)

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host

publishFromHostPoolIdsnullable array of integer (int32)

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

itemsinteger (int32)

publishFromServerIdsnullable array of integer (int32)

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

itemsinteger (int32)

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

connectToConsoleboolean

Connect to console

publishFromServernullable array of integer (int32)

List of servers to publish from.

itemsinteger (int32)

publishFromHostPoolnullable array of integer (int32)

List of groups to publish from.

itemsinteger (int32)

publishFromPublishFrom (enum)

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host

Request

Response

Get

Retrieve information about a specified published RD Session Host desktop.

GET/api/PubItems/{id}/Desktops/RDS

Path parameters

id*integer (int32)

ID of the published RD Session Host desktop to be retrieved

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

connectToConsoleboolean

Connect to console

publishFromServernullable array of integer (int32)

List of servers to publish from.

itemsinteger (int32)

publishFromHostPoolnullable array of integer (int32)

List of groups to publish from.

itemsinteger (int32)

publishFromPublishFrom (enum)

Publish From' options for published items.

0 = All,1 = HostPool,2 = Host

Request

Response

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:10:02.122Z",
  "timeLastMod": "2024-11-07T10:10:02.122Z",
  "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": false,
  "replicateMaintenance": false,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": false,
  "publishToSite": [],
  "userFilterEnabled": false,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": false,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": false,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": false,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": false,
  "allowedOSes": {
    "chrome": false,
    "android": false,
    "webClient": false,
    "iOS": false,
    "linux": false,
    "mac": false,
    "wyse": false,
    "windows": false
  },
  "preferredRoutingEnabled": false,
  "preferredRoutes": [
    {
      "name": "text",
      "description": "text",
      "enabled": false,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ]
    }
  ],
  "filter": {
    "rules": [
      {
        "enabled": false,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": false,
              "android": false,
              "webClient": false,
              "iOS": false,
              "linux": false,
              "mac": false,
              "wyse": false,
              "windows": false
            }
          },
          "iPs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": []
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": false,
  "createShortcutOnDesktop": false,
  "createShortcutInStartFolder": false,
  "startPath": "text",
  "createShortcutInStartUpFolder": false,
  "replicateShortcutSettings": false,
  "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": false,
  "publishFromServer": [],
  "publishFromHostPool": [],
  "publishFrom": [
    "0 = All",
    "1 = HostPool",
    "2 = Host"
  ]
}

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:10:02.122Z",
  "timeLastMod": "2024-11-07T10:10:02.122Z",
  "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": false,
  "replicateMaintenance": false,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": false,
  "publishToSite": [],
  "userFilterEnabled": false,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": false,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": false,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": false,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": false,
  "allowedOSes": {
    "chrome": false,
    "android": false,
    "webClient": false,
    "iOS": false,
    "linux": false,
    "mac": false,
    "wyse": false,
    "windows": false
  },
  "preferredRoutingEnabled": false,
  "preferredRoutes": [
    {
      "name": "text",
      "description": "text",
      "enabled": false,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ]
    }
  ],
  "filter": {
    "rules": [
      {
        "enabled": false,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": false,
              "android": false,
              "webClient": false,
              "iOS": false,
              "linux": false,
              "mac": false,
              "wyse": false,
              "windows": false
            }
          },
          "iPs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": []
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": false,
  "createShortcutOnDesktop": false,
  "createShortcutInStartFolder": false,
  "startPath": "text",
  "createShortcutInStartUpFolder": false,
  "replicateShortcutSettings": false,
  "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": false,
  "publishFromServer": [],
  "publishFromHostPool": [],
  "publishFrom": [
    "0 = All",
    "1 = HostPool",
    "2 = Host"
  ]
}

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:10:02.122Z",
  "timeLastMod": "2024-11-07T10:10:02.122Z",
  "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": false,
  "replicateMaintenance": false,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": false,
  "publishToSite": [],
  "userFilterEnabled": false,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": false,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": false,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": false,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": false,
  "allowedOSes": {
    "chrome": false,
    "android": false,
    "webClient": false,
    "iOS": false,
    "linux": false,
    "mac": false,
    "wyse": false,
    "windows": false
  },
  "preferredRoutingEnabled": false,
  "preferredRoutes": [
    {
      "name": "text",
      "description": "text",
      "enabled": false,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ]
    }
  ],
  "filter": {
    "rules": [
      {
        "enabled": false,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": false,
              "android": false,
              "webClient": false,
              "iOS": false,
              "linux": false,
              "mac": false,
              "wyse": false,
              "windows": false
            }
          },
          "iPs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": []
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": false,
  "createShortcutOnDesktop": false,
  "createShortcutInStartFolder": false,
  "startPath": "text",
  "createShortcutInStartUpFolder": false,
  "replicateShortcutSettings": false,
  "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": false,
  "publishFromServer": [],
  "publishFromHostPool": [],
  "publishFrom": [
    "0 = All",
    "1 = HostPool",
    "2 = Host"
  ]
}

VDI

List

Retrieve a list of all the published VDI desktops

GET/api/PubItems/Desktops/VDI

Query parameters

SiteIdinteger (int32)

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

Namestring

Filter the result by name (optional)

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

vdiHostPoolIdinteger (int32)

ID of the VDI Host Pool

persistentboolean

Specifies whether the connection is persistent or not

connectToVDIMatchingMode (enum)

VDI Matching Mode.

0 = AnyGuest

Request

Response

Create

Add a published VDI desktop to a site.

POST/api/PubItems/Desktops/VDI

Body

name*nullable string

Published resource name.

parentIdnullable integer (int32)

Parent publishing folder ID.

previousIdnullable integer (int32)

Previous published ID.

replicateMaintenancenullable boolean

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

inheritMaintenancenullable boolean

Whether to inherit default Maintenance settings.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

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

itemsinteger (int32)

siteIdinteger (int32)

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

startOnLogonboolean

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

widthinteger (int32)

Specifies a custom desktop width.

heightinteger (int32)

Specifies a custom desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

persistentboolean

Specifies whether the connection is persistent or not.

connectToVDIMatchingMode (enum)

VDI Matching Mode.

0 = AnyGuest

vdiHostPoolIdnullable integer (int32)

Specifies the VDI Host Pool ID from which to publish a desktop.

vdiTemplateIdnullable integer (int32)

Specifies the VDI Template ID from which to publish an application.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

vdiHostPoolIdinteger (int32)

ID of the VDI Host Pool

persistentboolean

Specifies whether the connection is persistent or not

connectToVDIMatchingMode (enum)

VDI Matching Mode.

0 = AnyGuest

Request

Response

Get

Retrieve information about a specified published VDI desktop.

GET/api/PubItems/{id}/Desktops/VDI

Path parameters

id*integer (int32)

ID of the published VDI desktop to be retrieved

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

vdiHostPoolIdinteger (int32)

ID of the VDI Host Pool

persistentboolean

Specifies whether the connection is persistent or not

connectToVDIMatchingMode (enum)

VDI Matching Mode.

0 = AnyGuest

Request

Response

Update

Modify properties of a specified published desktop.

PUT/api/PubItems/{id}/Desktops/VDI

Path parameters

id*integer (int32)

ID of the published VDI desktop to be updated

Body

Published VDI desktop configuration

namenullable string

A new name to assign to the published resource.

replicateMaintenancenullable boolean

Replicate Maintenance

inheritMaintenancenullable boolean

Inherit Maintenance

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of sites to which to publish a resource.

itemsinteger (int32)

preferredRoutingEnablednullable boolean

Enable or disable Preferred Routing.

replicateShortcutSettingsnullable boolean

Replicate shortcut settings to all sites.

createShortcutOnDesktopnullable boolean

Create a shortcut on a client's desktop.

createShortcutInStartFoldernullable boolean

Create a shortcut in the client's Start folder.

createShortcutInStartUpFoldernullable boolean

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

startPathnullable string

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

inheritShortcutDefaultSettingsnullable boolean

Inherit default shortcut settings.

startOnLogonnullable boolean

Start a resource automatically when a user logs on.

excludePrelaunchnullable boolean

Exclude application from prelaunch.

widthnullable integer (int32)

Desktop width.

heightnullable integer (int32)

Desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

persistentnullable boolean

Defines whether the connection is persistent or not.

connectToVDIMatchingMode (enum)

VDI Matching Mode.

0 = AnyGuest

vdiHostPoolIdnullable integer (int32)

Specifies the VDI Host Pool from which to publish a desktop.

Response

No Content

Request

Response

Delete

Delete a published VDI desktop

DELETE/api/PubItems/{id}/Desktops/VDI

Path parameters

id*integer (int32)

ID of the published VDI desktop to be deleted

Response

No Content

Request

Response

AVD

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)

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

avdHostPoolIDinteger (int32)

The AVD Host Pool ID.

Request

Response

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

parentIdnullable integer (int32)

Parent publishing folder ID.

previousIdnullable integer (int32)

Previous published ID.

replicateMaintenancenullable boolean

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

inheritMaintenancenullable boolean

Whether to inherit default Maintenance settings.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

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

itemsinteger (int32)

siteIdinteger (int32)

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

startOnLogonboolean

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

widthinteger (int32)

Specifies a custom desktop width.

heightinteger (int32)

Specifies a custom desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

name*nullable string

Published desktop name.

avdHostPoolID*integer (int32)

The AVD Host Pool ID.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

avdHostPoolIDinteger (int32)

The AVD Host Pool ID.

Request

Response

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

id*integer (int32)

ID of the published AVD desktop to be retrieved

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

avdHostPoolIDinteger (int32)

The AVD Host Pool ID.

Request

Response

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

id*integer (int32)

ID of the published AVD desktop to be updated

Body

Published AVD desktop configuration

namenullable string

A new name to assign to the published resource.

replicateMaintenancenullable boolean

Replicate Maintenance

inheritMaintenancenullable boolean

Inherit Maintenance

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of sites to which to publish a resource.

itemsinteger (int32)

preferredRoutingEnablednullable boolean

Enable or disable Preferred Routing.

replicateShortcutSettingsnullable boolean

Replicate shortcut settings to all sites.

createShortcutOnDesktopnullable boolean

Create a shortcut on a client's desktop.

createShortcutInStartFoldernullable boolean

Create a shortcut in the client's Start folder.

createShortcutInStartUpFoldernullable boolean

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

startPathnullable string

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

inheritShortcutDefaultSettingsnullable boolean

Inherit default shortcut settings.

startOnLogonnullable boolean

Start a resource automatically when a user logs on.

excludePrelaunchnullable boolean

Exclude application from prelaunch.

widthnullable integer (int32)

Desktop width.

heightnullable integer (int32)

Desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

avdHostPoolID*nullable integer (int32)

The AVD Host Pool ID.

Response

No Content

Request

Response

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

id*integer (int32)

ID of the published AVD desktop to be deleted

Response

No Content

Request

Response

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

id*integer (int32)

ID of the published AVD desktop to be updated

Body

Published AVD desktop configuration

namenullable string

A new name to assign to the published resource.

replicateMaintenancenullable boolean

Replicate Maintenance

inheritMaintenancenullable boolean

Inherit Maintenance

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of sites to which to publish a resource.

itemsinteger (int32)

preferredRoutingEnablednullable boolean

Enable or disable Preferred Routing.

replicateShortcutSettingsnullable boolean

Replicate shortcut settings to all sites.

createShortcutOnDesktopnullable boolean

Create a shortcut on a client's desktop.

createShortcutInStartFoldernullable boolean

Create a shortcut in the client's Start folder.

createShortcutInStartUpFoldernullable boolean

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

startPathnullable string

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

inheritShortcutDefaultSettingsnullable boolean

Inherit default shortcut settings.

startOnLogonnullable boolean

Start a resource automatically when a user logs on.

excludePrelaunchnullable boolean

Exclude application from prelaunch.

widthnullable integer (int32)

Desktop width.

heightnullable integer (int32)

Desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

avdHostPoolID*nullable integer (int32)

The AVD Host Pool ID.

Response

No Content

Request

Response

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)

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

avdHostPoolIDinteger (int32)

The AVD Host Pool ID.

Request

Response

Update

Modify properties of a specified published desktop.

PUT/api/PubItems/{id}/Desktops/VDI

Path parameters

id*integer (int32)

ID of the published VDI desktop to be updated

Body

Published VDI desktop configuration

namenullable string

A new name to assign to the published resource.

replicateMaintenancenullable boolean

Replicate Maintenance

inheritMaintenancenullable boolean

Inherit Maintenance

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

An array of sites to which to publish a resource.

itemsinteger (int32)

preferredRoutingEnablednullable boolean

Enable or disable Preferred Routing.

replicateShortcutSettingsnullable boolean

Replicate shortcut settings to all sites.

createShortcutOnDesktopnullable boolean

Create a shortcut on a client's desktop.

createShortcutInStartFoldernullable boolean

Create a shortcut in the client's Start folder.

createShortcutInStartUpFoldernullable boolean

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

startPathnullable string

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

inheritShortcutDefaultSettingsnullable boolean

Inherit default shortcut settings.

startOnLogonnullable boolean

Start a resource automatically when a user logs on.

excludePrelaunchnullable boolean

Exclude application from prelaunch.

widthnullable integer (int32)

Desktop width.

heightnullable integer (int32)

Desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

persistentnullable boolean

Defines whether the connection is persistent or not.

connectToVDIMatchingMode (enum)

VDI Matching Mode.

0 = AnyGuest

vdiHostPoolIdnullable integer (int32)

Specifies the VDI Host Pool from which to publish a desktop.

Response

No Content

Request

Response

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

id*integer (int32)

ID of the published AVD desktop to be retrieved

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

avdHostPoolIDinteger (int32)

The AVD Host Pool ID.

Request

Response

List

Retrieve a list of all the published VDI desktops

GET/api/PubItems/Desktops/VDI

Query parameters

SiteIdinteger (int32)

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

Namestring

Filter the result by name (optional)

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

vdiHostPoolIdinteger (int32)

ID of the VDI Host Pool

persistentboolean

Specifies whether the connection is persistent or not

connectToVDIMatchingMode (enum)

VDI Matching Mode.

0 = AnyGuest

Request

Response

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

parentIdnullable integer (int32)

Parent publishing folder ID.

previousIdnullable integer (int32)

Previous published ID.

replicateMaintenancenullable boolean

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

inheritMaintenancenullable boolean

Whether to inherit default Maintenance settings.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

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

itemsinteger (int32)

siteIdinteger (int32)

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

startOnLogonboolean

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

widthinteger (int32)

Specifies a custom desktop width.

heightinteger (int32)

Specifies a custom desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

name*nullable string

Published desktop name.

avdHostPoolID*integer (int32)

The AVD Host Pool ID.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

avdHostPoolIDinteger (int32)

The AVD Host Pool ID.

Request

Response

Create

Add a published VDI desktop to a site.

POST/api/PubItems/Desktops/VDI

Body

name*nullable string

Published resource name.

parentIdnullable integer (int32)

Parent publishing folder ID.

previousIdnullable integer (int32)

Previous published ID.

replicateMaintenancenullable boolean

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

inheritMaintenancenullable boolean

Whether to inherit default Maintenance settings.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

maintenanceMessage_en_USnullable string

Maintenance message for the published resource in English.

maintenanceMessage_ja_JPnullable string

Maintenance message for the published resource in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message for the published resource in French.

maintenanceMessage_es_ESnullable string

Maintenance message for the published resource in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message for the published resource in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message for the published resource in Portuguese.

maintenanceMessage_de_DEnullable string

Maintenance message for the published resource in German.

maintenanceMessage_nl_NLnullable string

Maintenance message for the published resource in Dutch.

maintenanceMessage_zh_TWnullable string

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

maintenanceMessage_zh_CNnullable string

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

maintenanceMessage_ko_KRnullable string

Maintenance message for the published resource in Korean.

descriptionnullable string

Published resource description.

publishToSiteIdsnullable array of integer (int32)

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

itemsinteger (int32)

siteIdinteger (int32)

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

startOnLogonboolean

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

widthinteger (int32)

Specifies a custom desktop width.

heightinteger (int32)

Specifies a custom desktop height.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

persistentboolean

Specifies whether the connection is persistent or not.

connectToVDIMatchingMode (enum)

VDI Matching Mode.

0 = AnyGuest

vdiHostPoolIdnullable integer (int32)

Specifies the VDI Host Pool ID from which to publish a desktop.

vdiTemplateIdnullable integer (int32)

Specifies the VDI Template ID from which to publish an application.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

vdiHostPoolIdinteger (int32)

ID of the VDI Host Pool

persistentboolean

Specifies whether the connection is persistent or not

connectToVDIMatchingMode (enum)

VDI Matching Mode.

0 = AnyGuest

Request

Response

Get

Retrieve information about a specified published VDI desktop.

GET/api/PubItems/{id}/Desktops/VDI

Path parameters

id*integer (int32)

ID of the published VDI desktop to be retrieved

Response

Success

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

maintenanceMessagesMaintenanceMessages (object)

Contains a set of maintenance messages in various languages

maintenanceMessage_en_USnullable string

Maintenance message in English.

maintenanceMessage_ja_JPnullable string

Maintenance message in Japanese.

maintenanceMessage_fr_FRnullable string

Maintenance message in French.

maintenanceMessage_es_ESnullable string

Maintenance message in Spanish.

maintenanceMessage_it_ITnullable string

Maintenance message in Italian.

maintenanceMessage_pt_BRnullable string

Maintenance message in Portuguese.

maintenanceMessage_nl_NLnullable string

Maintenance message in Dutch.

maintenanceMessage_zh_TWnullable string

Maintenance message in Chinese (Traditional).

maintenanceMessage_zh_CNnullable string

Maintenance message in Chinese (Simplified).

maintenanceMessage_ko_KRnullable string

Maintenance message in Korean.

maintenanceMessage_de_DEnullable string

Maintenance message in German.

inheritMaintenanceboolean

Inherit Maintenance.

replicateMaintenanceboolean

Replicate Maintenance.

namenullable string

Name of the published item.

typeRASPubObject (enum)

RAS Publishing Objects

0 = Any,1 = Folder,2 = RDSApp,3 = RDSDesktop,4 = VDIDesktop,5 = PCDesktop,6 = PCApp,7 = VDIApp,8 = AVDApp,9 = AVDDesktop

parentIdinteger (int32)

ID of the parent folder of the published item.

previousIdinteger (int32)

ID of the previous published item.

descriptionnullable string

Description of the published item.

enabledModePubResourceEnabledMode (enum)

Published resource availability modes.

0 = Disabled,1 = Enabled,2 = Maintenance

enabledboolean

Whether the published item is enabled or not.

publishToSitenullable array of integer (int32)

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

itemsinteger (int32)

userFilterEnabledboolean

Whether User Filtering is enabled or not (deprecated).

allowedUsersnullable array of UserFilter (object)

Lists the allowed users (deprecated).

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

clientFilterEnabledboolean

Whether Client Filtering is enabled or not (deprecated).

allowedClientsnullable array of string

Lists the allowed clients (deprecated).

itemsstring

ipFilterEnabledboolean

Whether IP Filtering is enabled or not (deprecated).

allowedIP4snullable array of IP4Range (object)

Lists the allowed IPv4 addresses (deprecated).

fromnullable string

tonullable string

allowedIP6snullable array of IP6Range (object)

Lists the allowed IPV6 addresses (deprecated).

fromnullable string

tonullable string

macFilterEnabledboolean

Whether MAC address Filtering is enabled or not (deprecated).

allowedMACsnullable array of string

Lists the allowed MAC addresses (deprecated).

itemsstring

allowedGatewaysnullable array of string

Lists the allowed Gateways (deprecated).

itemsstring

osFilterEnabledboolean

Whether OS Filtering is enabled or not (deprecated).

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

preferredRoutingEnabledboolean

Whether Preferred Routing is enabled or not.

preferredRoutesnullable array of PubPreferredRoute (object)

The list of Preferred Routes.

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

namenullable string

The Name of the Publishing Route

descriptionnullable string

Description of the Publishing Route

enabledboolean

Whether the Publishing Route is enabled or not

referenceTypeRoutingType (enum)

RAS Publishing Routing Type

3 = Gateway,51 = HALB,83 = Custom

referenceIdinteger (int32)

Reference ID of the Publishing Route

filterPubItemFilter (object)

The PubItem Filter object.

rulesnullable array of PubItemRule (object)

idinteger (int32)

ID of the object.

priorityinteger (int32)

Priority of the object.

enabledboolean

Whether the Rule is enabled or not

namenullable string

Name of the Rule

descriptionnullable string

Description of the Rule

criteriaPubItemCriteria (object)

PubItem Criteria

securityPrincipalsSecurityPrincipalsCriteria (object)

Security Principals Criteria

enabledboolean

Whether the Security Principals Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of SecurityPrincipalCriteriaEntry (object)

User criteria list

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

gatewaysGatewaysCriteria (object)

Gateways Criteria

enabledboolean

Whether the Gateways Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of GatewayCriteriaEntry (object)

Gateway criteria list

gatewayIPnullable string

The gateway IP.

oSsOSsCriteria (object)

OS Criteria Settings

enabledboolean

Whether the OSs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedOSesAllowedOperatingSystems (object)

Allowed Operating Systems

chromeboolean

Whether Chrome is allowed or not.

androidboolean

Whether Android is allowed or not.

webClientboolean

Whether Web Client is allowed or not.

iOSboolean

Whether iOS is allowed or not.

linuxboolean

Whether Linux is allowed or not.

macboolean

Whether MAC OS is allowed or not.

wyseboolean

Whether Wyse is allowed or not.

windowsboolean

Whether Windows is allowed or not.

iPsIPsCriteria (object)

IPs Criteria

enabledboolean

Whether the IPs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

allowedIPsAllowedIPsCriteria (object)

Allowed IPs Criteria

iPv4snullable array of IPv4CriteriaEntry (object)

IPv4 criteria list

fromnullable string

tonullable string

iPv6snullable array of IPv6CriteriaEntry (object)

IPv6 criteria list

fromnullable string

tonullable string

hardwareIDsHardwareIDsCriteria (object)

Hardware IDs Criteria

enabledboolean

Whether the Hardware IDs Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of HardwareIDCriteriaEntry (object)

Hardware IDs criteria list

hardwareIDnullable string

The hardware ID.

accessAccessType (enum)

Access type options

0 = DenyCriteriaWhen,1 = AllowCriteriaWhen

devicesDevicesCriteria (object)

Devices Criteria

enabledboolean

Whether the Devices Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

membersnullable array of ClientDeviceCriteriaEntry (object)

Client criteria list

clientnullable string

The name of the client device.

themesThemesCriteria (object)

Themes Criteria

enabledboolean

Whether the Themes Criteria is enabled or not

matchingModeMatchingModeType (enum)

Matching mode type options

0 = IsNotOneOfTheFollowing,1 = IsOneOfTheFollowing

idsnullable array of integer (int32)

Theme criteria list

itemsinteger (int32)

defaultDefaultAssignmentType (enum)

Default assignment type options

0 = Deny,1 = Allow

startOnLogonboolean

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

excludePrelaunchboolean

Exclude application from prelaunch.

inheritShortcutDefaultSettingsboolean

Whether to inherit default shortcut settings or not.

createShortcutOnDesktopboolean

Whether to create a shortcut on the desktop or not.

createShortcutInStartFolderboolean

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

startPathnullable string

Starting path of the published item.

createShortcutInStartUpFolderboolean

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

replicateShortcutSettingsboolean

Whether to replicate shortcut settings or not.

desktopSizeDesktopSize (enum)

Desktop size options for published desktops.

widthinteger (int32)

Desktop width.

heightinteger (int32)

Desktop height.

allowMultiMonitorAllowMultiMonitor (enum)

Multi-monitor options for published desktops.

0 = Enabled,1 = Disabled,2 = UseClientSettings

vdiHostPoolIdinteger (int32)

ID of the VDI Host Pool

persistentboolean

Specifies whether the connection is persistent or not

connectToVDIMatchingMode (enum)

VDI Matching Mode.

0 = AnyGuest

Request

Response

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:10:02.369Z",
  "timeLastMod": "2024-11-07T10:10:02.369Z",
  "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": false,
  "replicateMaintenance": false,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": false,
  "publishToSite": [],
  "userFilterEnabled": false,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": false,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": false,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": false,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": false,
  "allowedOSes": {
    "chrome": false,
    "android": false,
    "webClient": false,
    "iOS": false,
    "linux": false,
    "mac": false,
    "wyse": false,
    "windows": false
  },
  "preferredRoutingEnabled": false,
  "preferredRoutes": [
    {
      "name": "text",
      "description": "text",
      "enabled": false,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ]
    }
  ],
  "filter": {
    "rules": [
      {
        "enabled": false,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": false,
              "android": false,
              "webClient": false,
              "iOS": false,
              "linux": false,
              "mac": false,
              "wyse": false,
              "windows": false
            }
          },
          "iPs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": []
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": false,
  "createShortcutOnDesktop": false,
  "createShortcutInStartFolder": false,
  "startPath": "text",
  "createShortcutInStartUpFolder": false,
  "replicateShortcutSettings": false,
  "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"
  ]
}

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:10:02.369Z",
  "timeLastMod": "2024-11-07T10:10:02.369Z",
  "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": false,
  "replicateMaintenance": false,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": false,
  "publishToSite": [],
  "userFilterEnabled": false,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": false,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": false,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": false,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": false,
  "allowedOSes": {
    "chrome": false,
    "android": false,
    "webClient": false,
    "iOS": false,
    "linux": false,
    "mac": false,
    "wyse": false,
    "windows": false
  },
  "preferredRoutingEnabled": false,
  "preferredRoutes": [
    {
      "name": "text",
      "description": "text",
      "enabled": false,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ]
    }
  ],
  "filter": {
    "rules": [
      {
        "enabled": false,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": false,
              "android": false,
              "webClient": false,
              "iOS": false,
              "linux": false,
              "mac": false,
              "wyse": false,
              "windows": false
            }
          },
          "iPs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": []
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": false,
  "createShortcutOnDesktop": false,
  "createShortcutInStartFolder": false,
  "startPath": "text",
  "createShortcutInStartUpFolder": false,
  "replicateShortcutSettings": false,
  "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"
  ]
}

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:10:02.369Z",
  "timeLastMod": "2024-11-07T10:10:02.369Z",
  "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": false,
  "replicateMaintenance": false,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": false,
  "publishToSite": [],
  "userFilterEnabled": false,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": false,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": false,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": false,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": false,
  "allowedOSes": {
    "chrome": false,
    "android": false,
    "webClient": false,
    "iOS": false,
    "linux": false,
    "mac": false,
    "wyse": false,
    "windows": false
  },
  "preferredRoutingEnabled": false,
  "preferredRoutes": [
    {
      "name": "text",
      "description": "text",
      "enabled": false,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ]
    }
  ],
  "filter": {
    "rules": [
      {
        "enabled": false,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": false,
              "android": false,
              "webClient": false,
              "iOS": false,
              "linux": false,
              "mac": false,
              "wyse": false,
              "windows": false
            }
          },
          "iPs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": []
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": false,
  "createShortcutOnDesktop": false,
  "createShortcutInStartFolder": false,
  "startPath": "text",
  "createShortcutInStartUpFolder": false,
  "replicateShortcutSettings": false,
  "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"
  ],
  "persistent": false,
  "connectTo": [
    "0 = AnyGuest"
  ]
}

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:10:02.369Z",
  "timeLastMod": "2024-11-07T10:10:02.369Z",
  "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": false,
  "replicateMaintenance": false,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": false,
  "publishToSite": [],
  "userFilterEnabled": false,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": false,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": false,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": false,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": false,
  "allowedOSes": {
    "chrome": false,
    "android": false,
    "webClient": false,
    "iOS": false,
    "linux": false,
    "mac": false,
    "wyse": false,
    "windows": false
  },
  "preferredRoutingEnabled": false,
  "preferredRoutes": [
    {
      "name": "text",
      "description": "text",
      "enabled": false,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ]
    }
  ],
  "filter": {
    "rules": [
      {
        "enabled": false,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": false,
              "android": false,
              "webClient": false,
              "iOS": false,
              "linux": false,
              "mac": false,
              "wyse": false,
              "windows": false
            }
          },
          "iPs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": []
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": false,
  "createShortcutOnDesktop": false,
  "createShortcutInStartFolder": false,
  "startPath": "text",
  "createShortcutInStartUpFolder": false,
  "replicateShortcutSettings": false,
  "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"
  ]
}

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:10:02.369Z",
  "timeLastMod": "2024-11-07T10:10:02.369Z",
  "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": false,
  "replicateMaintenance": false,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": false,
  "publishToSite": [],
  "userFilterEnabled": false,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": false,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": false,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": false,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": false,
  "allowedOSes": {
    "chrome": false,
    "android": false,
    "webClient": false,
    "iOS": false,
    "linux": false,
    "mac": false,
    "wyse": false,
    "windows": false
  },
  "preferredRoutingEnabled": false,
  "preferredRoutes": [
    {
      "name": "text",
      "description": "text",
      "enabled": false,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ]
    }
  ],
  "filter": {
    "rules": [
      {
        "enabled": false,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": false,
              "android": false,
              "webClient": false,
              "iOS": false,
              "linux": false,
              "mac": false,
              "wyse": false,
              "windows": false
            }
          },
          "iPs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": []
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": false,
  "createShortcutOnDesktop": false,
  "createShortcutInStartFolder": false,
  "startPath": "text",
  "createShortcutInStartUpFolder": false,
  "replicateShortcutSettings": false,
  "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"
  ],
  "persistent": false,
  "connectTo": [
    "0 = AnyGuest"
  ]
}

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:10:02.369Z",
  "timeLastMod": "2024-11-07T10:10:02.369Z",
  "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": false,
  "replicateMaintenance": false,
  "name": "text",
  "type": [
    "0 = Any",
    "1 = Folder",
    "2 = RDSApp",
    "3 = RDSDesktop",
    "4 = VDIDesktop",
    "5 = PCDesktop",
    "6 = PCApp",
    "7 = VDIApp",
    "8 = AVDApp",
    "9 = AVDDesktop"
  ],
  "description": "text",
  "enabledMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Maintenance"
  ],
  "enabled": false,
  "publishToSite": [],
  "userFilterEnabled": false,
  "allowedUsers": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "clientFilterEnabled": false,
  "allowedClients": [
    "text"
  ],
  "ipFilterEnabled": false,
  "allowedIP4s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "allowedIP6s": [
    {
      "from": "text",
      "to": "text"
    }
  ],
  "macFilterEnabled": false,
  "allowedMACs": [
    "text"
  ],
  "allowedGateways": [
    "text"
  ],
  "osFilterEnabled": false,
  "allowedOSes": {
    "chrome": false,
    "android": false,
    "webClient": false,
    "iOS": false,
    "linux": false,
    "mac": false,
    "wyse": false,
    "windows": false
  },
  "preferredRoutingEnabled": false,
  "preferredRoutes": [
    {
      "name": "text",
      "description": "text",
      "enabled": false,
      "referenceType": [
        "3 = Gateway",
        "51 = HALB",
        "83 = Custom"
      ]
    }
  ],
  "filter": {
    "rules": [
      {
        "enabled": false,
        "name": "text",
        "description": "text",
        "criteria": {
          "securityPrincipals": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "account": "text",
                "type": [
                  "1 = User",
                  "2 = Group",
                  "3 = ForeignSecurityPrincipal",
                  "4 = Computer"
                ],
                "sid": "text"
              }
            ]
          },
          "gateways": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "gatewayIP": "text"
              }
            ]
          },
          "oSs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedOSes": {
              "chrome": false,
              "android": false,
              "webClient": false,
              "iOS": false,
              "linux": false,
              "mac": false,
              "wyse": false,
              "windows": false
            }
          },
          "iPs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "allowedIPs": {
              "iPv4s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ],
              "iPv6s": [
                {
                  "from": "text",
                  "to": "text"
                }
              ]
            }
          },
          "hardwareIDs": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "hardwareID": "text"
              }
            ]
          },
          "access": [
            "0 = DenyCriteriaWhen",
            "1 = AllowCriteriaWhen"
          ],
          "devices": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "members": [
              {
                "client": "text"
              }
            ]
          },
          "themes": {
            "enabled": false,
            "matchingMode": [
              "0 = IsNotOneOfTheFollowing",
              "1 = IsOneOfTheFollowing"
            ],
            "ids": []
          }
        }
      }
    ],
    "default": [
      "0 = Deny",
      "1 = Allow"
    ]
  },
  "startOnLogon": false,
  "excludePrelaunch": false,
  "inheritShortcutDefaultSettings": false,
  "createShortcutOnDesktop": false,
  "createShortcutInStartFolder": false,
  "startPath": "text",
  "createShortcutInStartUpFolder": false,
  "replicateShortcutSettings": false,
  "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"
  ],
  "persistent": false,
  "connectTo": [
    "0 = AnyGuest"
  ]
}