ApplicationPoolInfoV6
Information related to Application Pool.
List API returning this information can use search filter query to filter on specific fields supported by filters.
Supported Filters: 'And', 'Or', 'Equals', 'StartsWith', 'Contains' and 'EndsWith'.
See the field description to know the filter types it supports.
{
"access_group_id": "6fd4638a-381f-4518-aed6-042aa3d9f14c",
"allow_users_to_choose_machines": true,
"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"
],
"customized_icon_ids": [
"e8d7bf41-0fcd-477a-b7e0-1338b3868d26",
"b5453336-01c6-4d44-b2f4-7bcdbcf7b82e"
],
"description": "string",
"desktop_pool_id": "0103796c-102b-4ed3-953f-3dfe3d23e0fe",
"desktop_pool_name": "Desktop1",
"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",
"farm_name": "Farm1",
"global_application_entitlement_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
"icon_ids": [
"200fd5fd-26d6-490e-b023-509cbe19c0ac",
"920b7766-87b4-4712-9dac-1e7afcba28a6"
],
"id": "6f85b3a5-e7d0-4ad6-a1e3-37168dd1ed51",
"max_multi_sessions": 5,
"multi_session_mode": "ENABLED_ENFORCED",
"name": "Firefox",
"parameters": "string",
"publisher": "Mozilla Corporation",
"shortcut_locations": [
"string"
],
"start_folder": "string",
"status": "DISABLED",
"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"
}Access groups can organize the entities (like application pools, desktop pools) in the organization. They can also be used for delegated administration. For application pool, this is the same as that of the farm or desktop pool that the application pool belongs to.
Supported Filters: 'Equals'.
Indicates whether the application pool supports session launch from user specified machines.Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether application launch limit is enabled for the application pool.
Supported Filters: 'Equals'. This property can be used for sorting.
Shortcut ID of AVM managed application.
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.
Indicates whether the application pool is cloud brokered.
Supported Filters: 'Equals'. This property can be used for sorting.
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.
List of customized icon IDs associated with the application which the user has configured.
Notes about the application pool.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
ID of the desktop pool from which this application pool is created. Either this or farm id will be set.
Supported Filters: 'Equals'.
Name of the desktop pool from which this application pool is created. Either this or farm name will be set.
Supported Filters: 'Equals'.
The display name is the name that users will see when they connect to view client. If the display name is left blank, it defaults to name.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Indicates whether client restrictions are to be applied to application pool. Currently it is valid for application pool created from farm.
Supported Filters: 'Equals'. This property can be used for sorting.
Whether to pre-launch the application.
Supported Filters: 'Equals'. This property can be used for sorting.
Indicates whether the application pool is enabled.
Supported Filters: 'Equals'. This property can be used for sorting.
Path to application executable.
Supported Filters: 'Equals', 'StartsWith', 'EndsWith' and 'Contains'. This property can be used for sorting.
ID of the farm from which this application pool is created. Either this or desktop pool id will be set.
Supported Filters: 'Equals'.
Name of the farm from which this application pool is created. Either this or desktop pool name will be set.
Supported Filters: 'Equals'.
Global application entitlement for this application pool. Caller should have permission to FEDERATED_LDAP_VIEW privilege for this field to be populated or to use in filter.
Supported Filters: 'Equals'.
List of icon IDs associated with the application which are fetched from the agent.
Unique ID representing application pool.
Supported Filters: 'Equals'.
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"
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.
Supported Filters: 'Equals'. This property can be used for sorting.
- 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.
The application 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.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Parameters to pass to application when launching.
Application publisher.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.
Locations of the category folder in the user's OS containing a shortcut to the application. The value must be set if category folder name is provided.
Starting folder for application.
Health status of the application pool.Supported Filters: 'Equals'. This property can be used for sorting.
- AVAILABLE: The application is available in all machines of the desktop/farm.
- MISSING: The application is missing in one or more machines in the desktop/farm.
- UNAVAILABLE: Could happen in any of following cases:
- The application is missing in all the machines of the desktop/farm.
- Desktop/Farm does not have any provisioned machines.
- DISABLED: The desktop/farm is disabled and the application is disabled.
Application version.
Supported Filters: 'Equals', 'StartsWith' and 'Contains'. This property can be used for sorting.