ApplicationPoolCreateSpecV4

ApplicationPoolCreateSpecV4
ApplicationPoolCreateSpecV4

Application pool object to be created.

JSON Example 
{
    "anti_affinity_data": {
        "anti_affinity_count": 10,
        "anti_affinity_patterns": [
            "*pad.exe",
            "*notepad.???"
        ]
    },
    "app_launch_limit_enabled": false,
    "avm_shortcut_id": "1",
    "category_folder_name": "dir1\\dir2\\dir3\\dir4",
    "cloud_brokered": false,
    "cs_restriction_tags": [
        "Internal",
        "External"
    ],
    "description": "Application pool description.",
    "desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
    "display_name": "Firefox",
    "enable_client_restrictions": false,
    "enable_pre_launch": false,
    "enabled": true,
    "executable_path": "C:\\ProgramData\\Microsoft\\Windows\\Start Menu\\Programs\\Firefox.lnk",
    "farm_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
    "max_multi_sessions": 5,
    "multi_session_mode": "DISABLED",
    "name": "Firefox",
    "parameters": "-p myprofile",
    "publisher": "Mozilla Corporation",
    "shortcut_locations": [
        "string"
    ],
    "start_folder": "string",
    "supported_file_types_data": {
        "enable_auto_update_file_types": true,
        "enable_auto_update_other_file_types": true,
        "file_types": [
            {
                "description": "Firefox Document",
                "type": ".html"
            }
        ],
        "other_file_types": [
            {
                "description": "Firefox URL",
                "name": "https",
                "type": "URL"
            }
        ]
    },
    "version": "72.0.2"
}
ApplicationAntiAffinityData
anti_affinity_data
Optional

anti_affinity_data

boolean
app_launch_limit_enabled
Optional

Indicates whether application launch limit is enabled for the application pool. Default value is false.

string
avm_shortcut_id
Optional

Shortcut ID of AVM managed application.

string As ^(?i:(?!(?:CON|PRN|AUX|NUL|COM[1-9]|LPT[1-9])$)(?!(?:CON[\\].*|PRN[\\].*|AUX[\\].*|NUL[\\].*|COM[1-9][\\].*|LPT[1-9][\\].*)$)(?!(?:.*[\\]CON|.*[\\]PRN|.*[\\]AUX|.*[\\]NUL|.*[\\]COM[1-9]|.*[\\]LPT[1-9])$)(?!(?:.*[\\]CON[\\].*|.*[\\]PRN[\\].*|.*[\\]AUX[\\].*|.*[\\]NUL[\\].*|.*[\\]COM[1-9][\\].*|.*[\\]LPT[1-9][\\].*)$))([^\"#$%&'()*+,.\\\/:;<=>?@^`{|}~]{1,64}\\){0,3}([^\"#$%&'()*+,.\\\/:;<=>?@^`{|}~]{1,64})$|^/$
category_folder_name
Optional

Name of the category folder in the user's OS containing a shortcut to the application. Unset if the application does not belong to a category.

boolean
cloud_brokered
Optional

Indicates whether the application pool is cloud brokered. Default value is false.

array of string
cs_restriction_tags
Optional

Connection server restrictions. Application pool can be accessed from only those connection server instances that have a matching tag in this list. Null or empty list means that the application pool can be accessed from any connection server.

string
description
Optional

Notes about the application pool.

string
desktop_pool_id
Optional

ID of the desktop pool from which this application pool is to be created. Once an application pool is created from a desktop pool, it is always associated with that desktop pool, and cannot be removed from the desktop pool, or added to another desktop pool. Either this or farm id should be set.

string
display_name
Optional

The display name is the name that users will see in Horizon client. If the display name is left blank, it defaults to name.

boolean
enable_client_restrictions
Optional

Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm. Default value is false.

boolean
enable_pre_launch
Optional

Whether to pre-launch the application. Default value is false.

boolean
enabled
Optional

Indicates whether the application pool is enabled. Default value is true

string
executable_path
Required

Path to application executable.

string
farm_id
Optional

ID of the farm from which this application pool is to be created. Once an application pool is created from a farm, it is always associated with that farm, and cannot be removed from the farm, or added to another farm. Either this or desktop pool id should be set.

integer As int32 As int32
max_multi_sessions
Optional

Maximum number of multi-sessions a user can have in this application pool. This property is required if multi-session mode is set to "ENABLED_DEFAULT_OFF", "ENABLED_DEFAULT_ON", or "ENABLED_ENFORCED"Default value is 1.

string
multi_session_mode
Required

Multi-session mode for the application pool. An application launched in multi-session mode does not support reconnect behavior when user logs in from a different client instance. Multi-session mode should be disabled when pre-launch is enabled.Default value is "DISABLED"

  • DISABLED: Multi-session is not supported for this application.
  • ENABLED_DEFAULT_OFF: Multi-session is supported for this application but is disabled by default. The client would need to explicitly request multi-session launch, if wanted. If a legacy client is used, this will always result in a single-session application launch.
  • ENABLED_DEFAULT_ON: Multi-session mode is supported for this application and is enabled by default. The client can request explicitly for single-session launch, if wanted. If a legacy client is used, this will always result in a multi-session application launch.
  • ENABLED_ENFORCED: Multi-session is supported for this application and it is enforced. The client can not select to launch this application as a single-session application.
Possible values are : DISABLED, ENABLED_DEFAULT_OFF, ENABLED_DEFAULT_ON, ENABLED_ENFORCED,
string As [a-zA-Z0-9_-]{1,64}
name
Required

The application pool name is the unique identifier used to identify this application pool. This property must contain only alphanumerics, underscores, and dashes. The maximum length is 64 characters.

string
parameters
Optional

Parameters to pass to application when launching.

string
publisher
Optional

Application publisher

array of string
shortcut_locations
Optional

Locations of the category folder in the user's OS containing a shortcut to the desktop. The value must be set if category folder name is provided.

Possible values are : START_MENU, DESKTOP,
string
start_folder
Optional

Starting folder for application

ApplicationSupportedFileTypesData
supported_file_types_data
Optional

supported_file_types_data

string
version
Optional

Application version.

Parameter To