# VDI

## List

> Retrieve a list of all the published VDI applications

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/PubItems/Apps/VDI":{"get":{"tags":["3-Publishing/Applications//VDI"],"summary":"List","description":"Retrieve a list of all the published VDI applications","operationId":"9dce7043-6ca8-4de2-8f7d-5ae18dd17db2","parameters":[{"name":"SiteId","in":"query","description":"Site ID for which to retrieve all the published VDI applications (optional)","schema":{"type":"integer","format":"int32"}},{"name":"Name","in":"query","description":"Filter the result by name (optional)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/PubVDIApp"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"PubVDIApp":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"maintenanceMessages":{"$ref":"#/components/schemas/MaintenanceMessages"},"inheritMaintenance":{"type":"boolean","description":"<para type=\"description\">Inherit Maintenance.</para>"},"replicateMaintenance":{"type":"boolean","description":"<para type=\"description\">Replicate Maintenance.</para>"},"name":{"type":"string","description":"<para type=\"description\">Name of the published item.</para>","nullable":true},"type":{"$ref":"#/components/schemas/RASPubObject"},"parentId":{"type":"integer","description":"<para type=\"description\">ID of the parent folder of the published item.</para>","format":"int32"},"previousId":{"type":"integer","description":"<para type=\"description\">ID of the previous published item.</para>","format":"int32"},"description":{"type":"string","description":"<para type=\"description\">Description of the published item.</para>","nullable":true},"enabledMode":{"$ref":"#/components/schemas/PubResourceEnabledMode"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the published item is enabled or not.</para>"},"publishToSite":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">List of the IDs of all the sites this item is published to.</para>","nullable":true},"preferredRoutingEnabled":{"type":"boolean","description":"<para type=\"description\">Whether Preferred Routing is enabled or not.</para>"},"preferredRoutes":{"type":"array","items":{"$ref":"#/components/schemas/PubPreferredRoute"},"description":"<para type=\"description\">The list of Preferred Routes.</para>","nullable":true},"filter":{"$ref":"#/components/schemas/PubItemFilter"},"startOnLogon":{"type":"boolean","description":"<para type=\"description\">Whether the 'Start automatically when user logs on' option is enabled or disabled.</para>"},"excludePrelaunch":{"type":"boolean","description":"<para type=\"description\">Exclude application from prelaunch.</para>"},"inheritShortcutDefaultSettings":{"type":"boolean","description":"<para type=\"description\">Whether to inherit default shortcut settings or not.</para>"},"createShortcutOnDesktop":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut on the desktop or not.</para>"},"createShortcutInStartFolder":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut in the start folder or not.</para>"},"startPath":{"type":"string","description":"<para type=\"description\">Starting path of the published item.</para>","nullable":true},"createShortcutInStartUpFolder":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut in the startup folder or not.</para>"},"replicateShortcutSettings":{"type":"boolean","description":"<para type=\"description\">Whether to replicate shortcut settings or not.</para>"},"winType":{"$ref":"#/components/schemas/WindowType"},"target":{"type":"string","description":"<para type=\"description\">Application target file.</para>","nullable":true},"startIn":{"type":"string","description":"<para type=\"description\">Application working directory.</para>","nullable":true},"parameters":{"type":"string","description":"<para type=\"description\">Application parameters.</para>","nullable":true},"package":{"type":"string","description":"<para type=\"description\">Application package</para>","nullable":true},"packagedApp":{"type":"string","description":"<para type=\"description\">Application in the application package</para>","nullable":true},"vdiHostPoolId":{"type":"integer","description":"<para type=\"description\">ID of the VDI Host Pool</para>","format":"int32"},"persistent":{"type":"boolean","description":"<para type=\"description\">Specifies whether the connection is persistent or not</para>"},"connectTo":{"$ref":"#/components/schemas/VDIMatchingMode"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Published VDI Application</para>\r\n<para type=\"description\"></para>"},"MaintenanceMessages":{"type":"object","properties":{"maintenanceMessage_en_US":{"type":"string","description":"<para type=\"description\">Maintenance message in English.</para>","nullable":true},"maintenanceMessage_ja_JP":{"type":"string","description":"<para type=\"description\">Maintenance message in Japanese.</para>","nullable":true},"maintenanceMessage_fr_FR":{"type":"string","description":"<para type=\"description\">Maintenance message in French.</para>","nullable":true},"maintenanceMessage_es_ES":{"type":"string","description":"<para type=\"description\">Maintenance message in Spanish.</para>","nullable":true},"maintenanceMessage_it_IT":{"type":"string","description":"<para type=\"description\">Maintenance message in Italian.</para>","nullable":true},"maintenanceMessage_pt_BR":{"type":"string","description":"<para type=\"description\">Maintenance message in Portuguese.</para>","nullable":true},"maintenanceMessage_nl_NL":{"type":"string","description":"<para type=\"description\">Maintenance message in Dutch.</para>","nullable":true},"maintenanceMessage_zh_TW":{"type":"string","description":"<para type=\"description\">Maintenance message in Chinese (Traditional).</para>","nullable":true},"maintenanceMessage_zh_CN":{"type":"string","description":"<para type=\"description\">Maintenance message in Chinese (Simplified).</para>","nullable":true},"maintenanceMessage_ko_KR":{"type":"string","description":"<para type=\"description\">Maintenance message in Korean.</para>","nullable":true},"maintenanceMessage_de_DE":{"type":"string","description":"<para type=\"description\">Maintenance message in German.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Contains a set of maintenance messages in various languages</para>\r\n<para type=\"description\"></para>"},"RASPubObject":{"enum":[["0 = Any","1 = Folder","2 = RDSApp","3 = RDSDesktop","4 = VDIDesktop","5 = PCDesktop","6 = PCApp","7 = VDIApp","8 = AVDApp","9 = AVDDesktop","10 = LocalApp"]],"type":"string","description":"<para type=\"synopsis\">RAS Publishing Objects</para>\r\n<para type=\"description\"></para>","format":"int32"},"PubResourceEnabledMode":{"enum":[["0 = Disabled","1 = Enabled","2 = Maintenance"]],"type":"string","description":"<para type=\"synopsis\">Published resource availability modes.</para>\r\n<para type=\"description\"></para>","format":"int32"},"PubPreferredRoute":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"priority":{"type":"integer","description":"<para type=\"description\">Priority of the object.</para>","format":"int32"},"name":{"type":"string","description":"<para type=\"description\">The Name of the Publishing Route</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Description of the Publishing Route</para>","nullable":true},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Publishing Route is enabled or not</para>"},"referenceType":{"$ref":"#/components/schemas/RoutingType"},"referenceId":{"type":"integer","description":"<para type=\"description\">Reference ID of the Publishing Route</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Preferred Route</para>\r\n<para type=\"description\"></para>"},"RoutingType":{"enum":[["3 = Gateway","51 = HALB","83 = Custom"]],"type":"string","description":"<para type=\"synopsis\">RAS Publishing Routing Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"PubItemFilter":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/PubItemRule"},"nullable":true},"default":{"$ref":"#/components/schemas/DefaultAssignmentType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">The PubItem Filter object.</para>\r\n<para type=\"description\"></para>"},"PubItemRule":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"priority":{"type":"integer","description":"<para type=\"description\">Priority of the object.</para>","format":"int32"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Rule is enabled or not</para>"},"name":{"type":"string","description":"<para type=\"description\">Name of the Rule</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Description of the Rule</para>","nullable":true},"criteria":{"$ref":"#/components/schemas/PubItemCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">PubItem Rule</para>\r\n<para type=\"description\"></para>"},"PubItemCriteria":{"type":"object","properties":{"securityPrincipals":{"$ref":"#/components/schemas/SecurityPrincipalsCriteria"},"gateways":{"$ref":"#/components/schemas/GatewaysCriteria"},"oSs":{"$ref":"#/components/schemas/OSsCriteria"},"iPs":{"$ref":"#/components/schemas/IPsCriteria"},"hardwareIDs":{"$ref":"#/components/schemas/HardwareIDsCriteria"},"access":{"$ref":"#/components/schemas/AccessType"},"devices":{"$ref":"#/components/schemas/DevicesCriteria"},"themes":{"$ref":"#/components/schemas/ThemesCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">PubItem Criteria</para>\r\n<para type=\"description\"></para>"},"SecurityPrincipalsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Security Principals Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/SecurityPrincipalCriteriaEntry"},"description":"<para type=\"description\">User criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Security Principals Criteria</para>\r\n<para type=\"description\"></para>"},"MatchingModeType":{"enum":[["0 = IsNotOneOfTheFollowing","1 = IsOneOfTheFollowing"]],"type":"string","description":"<para type=\"synopsis\">Matching mode type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"SecurityPrincipalCriteriaEntry":{"type":"object","properties":{"account":{"type":"string","description":"<para type=\"description\">The name of the user/group account the filter is added to.</para>","nullable":true},"type":{"$ref":"#/components/schemas/UserType"},"sid":{"type":"string","description":"<para type=\"description\">The SID of the user/group account the filter is added to.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Security Principal Criteria Entry</para>\r\n<para type=\"description\"></para>"},"UserType":{"enum":[["1 = User","2 = Group","3 = ForeignSecurityPrincipal","4 = Computer"]],"type":"string","description":"<para type=\"synopsis\">User Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"GatewaysCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Gateways Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/GatewayCriteriaEntry"},"description":"<para type=\"description\">Gateway criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Gateways Criteria</para>\r\n<para type=\"description\"></para>"},"GatewayCriteriaEntry":{"type":"object","properties":{"gatewayIP":{"type":"string","description":"<para type=\"description\">The gateway IP.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Gateway criteria entry</para>\r\n<para type=\"description\"></para>"},"OSsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the OSs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"allowedOSes":{"$ref":"#/components/schemas/AllowedOperatingSystems"}},"additionalProperties":false,"description":"<para type=\"synopsis\">OS Criteria Settings</para>\r\n<para type=\"description\"></para>"},"AllowedOperatingSystems":{"type":"object","properties":{"chrome":{"type":"boolean","description":"<para type=\"description\">Whether Chrome is allowed or not.</para>"},"android":{"type":"boolean","description":"<para type=\"description\">Whether Android is allowed or not.</para>"},"webClient":{"type":"boolean","description":"<para type=\"description\">Whether Web Client is allowed or not.</para>"},"iOS":{"type":"boolean","description":"<para type=\"description\">Whether iOS is allowed or not.</para>"},"linux":{"type":"boolean","description":"<para type=\"description\">Whether Linux is allowed or not.</para>"},"mac":{"type":"boolean","description":"<para type=\"description\">Whether MAC OS is allowed or not.</para>"},"wyse":{"type":"boolean","description":"<para type=\"description\">Whether Wyse is allowed or not.</para>"},"windows":{"type":"boolean","description":"<para type=\"description\">Whether Windows is allowed or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Allowed Operating Systems</para>\r\n<para type=\"description\"></para>"},"IPsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the IPs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"allowedIPs":{"$ref":"#/components/schemas/AllowedIPsCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPs Criteria</para>\r\n<para type=\"description\"></para>"},"AllowedIPsCriteria":{"type":"object","properties":{"iPv4s":{"type":"array","items":{"$ref":"#/components/schemas/IPv4CriteriaEntry"},"description":"<para type=\"description\">IPv4 criteria list</para>","nullable":true},"iPv6s":{"type":"array","items":{"$ref":"#/components/schemas/IPv6CriteriaEntry"},"description":"<para type=\"description\">IPv6 criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Allowed IPs Criteria</para>\r\n<para type=\"description\"></para>"},"IPv4CriteriaEntry":{"type":"object","properties":{"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPv4 Criteria Entry</para>\r\n<para type=\"description\"></para>"},"IPv6CriteriaEntry":{"type":"object","properties":{"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPv6 Criteria Entry</para>\r\n<para type=\"description\"></para>"},"HardwareIDsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Hardware IDs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/HardwareIDCriteriaEntry"},"description":"<para type=\"description\">Hardware IDs criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Hardware IDs Criteria</para>\r\n<para type=\"description\"></para>"},"HardwareIDCriteriaEntry":{"type":"object","properties":{"hardwareID":{"type":"string","description":"<para type=\"description\">The hardware ID.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Hardware ID criteria entry</para>\r\n<para type=\"description\"></para>"},"AccessType":{"enum":[["0 = DenyCriteriaWhen","1 = AllowCriteriaWhen"]],"type":"string","description":"<para type=\"synopsis\">Access type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"DevicesCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Devices Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/ClientDeviceCriteriaEntry"},"description":"<para type=\"description\">Client criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Devices Criteria</para>\r\n<para type=\"description\"></para>"},"ClientDeviceCriteriaEntry":{"type":"object","properties":{"client":{"type":"string","description":"<para type=\"description\">The name of the client device.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Client device criteria entry</para>\r\n<para type=\"description\"></para>"},"ThemesCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Themes Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">Theme criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Themes Criteria</para>\r\n<para type=\"description\"></para>"},"DefaultAssignmentType":{"enum":[["0 = Deny","1 = Allow"]],"type":"string","description":"<para type=\"synopsis\">Default assignment type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowType":{"enum":[["0 = Normal","1 = Maximized","2 = Minimized"]],"type":"string","description":"<para type=\"synopsis\">Published application window type</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"VDIMatchingMode":{"enum":[["0 = AnyGuest"]],"type":"string","description":"<para type=\"synopsis\">VDI Matching Mode.</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Create

> Add a published VDI application to a site.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/PubItems/Apps/VDI":{"post":{"tags":["3-Publishing/Applications//VDI"],"summary":"Create","description":"Add a published VDI application to a site.","operationId":"bc1a593c-a9f3-40ab-906f-b8919a4a4dc3","requestBody":{"content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/NewPubVDIApp"}}}},"responses":{"201":{"description":"Created","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/PubVDIApp"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"Conflict","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"NewPubVDIApp":{"required":["name"],"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Published resource name.</para>","nullable":true},"parentId":{"type":"integer","description":"<para type=\"description\">Parent publishing folder ID.</para>","format":"int32","nullable":true},"previousId":{"type":"integer","description":"<para type=\"description\">Previous published ID.</para>","format":"int32","nullable":true},"replicateMaintenance":{"type":"boolean","description":"<para type=\"description\">Whether the option 'Replicate Maintenance' is enabled or not.</para>","nullable":true},"inheritMaintenance":{"type":"boolean","description":"<para type=\"description\">Whether to inherit default Maintenance settings.</para>","nullable":true},"enabledMode":{"$ref":"#/components/schemas/PubResourceEnabledMode"},"maintenanceMessage_en_US":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in English.</para>","nullable":true},"maintenanceMessage_ja_JP":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Japanese.</para>","nullable":true},"maintenanceMessage_fr_FR":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in French.</para>","nullable":true},"maintenanceMessage_es_ES":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Spanish.</para>","nullable":true},"maintenanceMessage_it_IT":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Italian.</para>","nullable":true},"maintenanceMessage_pt_BR":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Portuguese.</para>","nullable":true},"maintenanceMessage_de_DE":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in German.</para>","nullable":true},"maintenanceMessage_nl_NL":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Dutch.</para>","nullable":true},"maintenanceMessage_zh_TW":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Chinese (Traditional).</para>","nullable":true},"maintenanceMessage_zh_CN":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Chinese (Simplified).</para>","nullable":true},"maintenanceMessage_ko_KR":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Korean.</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Published resource description.</para>","nullable":true},"publishToSiteIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">An array of Sites IDs to which to publish a resource.</para>","nullable":true},"siteId":{"type":"integer","description":"<para type=\"description\">Site ID in which to publish the specified Item.</para>\r\n<para type=\"description\">If the parameter is omitted, the site ID of the Licensing Server will be used.</para>","format":"int32"},"target":{"type":"string","description":"<para type=\"description\">File name and path of a published application executable.</para>","nullable":true},"startIn":{"type":"string","description":"<para type=\"description\">Folder name in which to start a published application.</para>","nullable":true},"parameters":{"type":"string","description":"<para type=\"description\">Optional parameters to pass to the published application executable.</para>","nullable":true},"package":{"type":"string","description":"<para type=\"description\">The MSIX package.</para>","nullable":true},"packagedApp":{"type":"string","description":"<para type=\"description\">The Application within the MSIX Package.</para>","nullable":true},"startOnLogon":{"type":"boolean","description":"<para type=\"description\">Enable or disable the 'Start automatically when user logs on' option.</para>","default":false},"winType":{"$ref":"#/components/schemas/WindowType"},"persistent":{"type":"boolean","description":"<para type=\"description\">Specifies whether the connection is persistent or not.</para>"},"connectTo":{"$ref":"#/components/schemas/VDIMatchingMode"},"vdiHostPoolId":{"type":"integer","description":"<para type=\"description\">Specifies the VDI Host Pool ID from which to publish an application.</para>","format":"int32","nullable":true},"vdiTemplateId":{"type":"integer","description":"<para type=\"description\">Specifies the VDI Template ID from which to publish an application.</para>","format":"int32","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Create a new published application from a VDI Desktop</para>\r\n<para type=\"description\"></para>"},"PubResourceEnabledMode":{"enum":[["0 = Disabled","1 = Enabled","2 = Maintenance"]],"type":"string","description":"<para type=\"synopsis\">Published resource availability modes.</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowType":{"enum":[["0 = Normal","1 = Maximized","2 = Minimized"]],"type":"string","description":"<para type=\"synopsis\">Published application window type</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"VDIMatchingMode":{"enum":[["0 = AnyGuest"]],"type":"string","description":"<para type=\"synopsis\">VDI Matching Mode.</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"PubVDIApp":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"maintenanceMessages":{"$ref":"#/components/schemas/MaintenanceMessages"},"inheritMaintenance":{"type":"boolean","description":"<para type=\"description\">Inherit Maintenance.</para>"},"replicateMaintenance":{"type":"boolean","description":"<para type=\"description\">Replicate Maintenance.</para>"},"name":{"type":"string","description":"<para type=\"description\">Name of the published item.</para>","nullable":true},"type":{"$ref":"#/components/schemas/RASPubObject"},"parentId":{"type":"integer","description":"<para type=\"description\">ID of the parent folder of the published item.</para>","format":"int32"},"previousId":{"type":"integer","description":"<para type=\"description\">ID of the previous published item.</para>","format":"int32"},"description":{"type":"string","description":"<para type=\"description\">Description of the published item.</para>","nullable":true},"enabledMode":{"$ref":"#/components/schemas/PubResourceEnabledMode"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the published item is enabled or not.</para>"},"publishToSite":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">List of the IDs of all the sites this item is published to.</para>","nullable":true},"preferredRoutingEnabled":{"type":"boolean","description":"<para type=\"description\">Whether Preferred Routing is enabled or not.</para>"},"preferredRoutes":{"type":"array","items":{"$ref":"#/components/schemas/PubPreferredRoute"},"description":"<para type=\"description\">The list of Preferred Routes.</para>","nullable":true},"filter":{"$ref":"#/components/schemas/PubItemFilter"},"startOnLogon":{"type":"boolean","description":"<para type=\"description\">Whether the 'Start automatically when user logs on' option is enabled or disabled.</para>"},"excludePrelaunch":{"type":"boolean","description":"<para type=\"description\">Exclude application from prelaunch.</para>"},"inheritShortcutDefaultSettings":{"type":"boolean","description":"<para type=\"description\">Whether to inherit default shortcut settings or not.</para>"},"createShortcutOnDesktop":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut on the desktop or not.</para>"},"createShortcutInStartFolder":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut in the start folder or not.</para>"},"startPath":{"type":"string","description":"<para type=\"description\">Starting path of the published item.</para>","nullable":true},"createShortcutInStartUpFolder":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut in the startup folder or not.</para>"},"replicateShortcutSettings":{"type":"boolean","description":"<para type=\"description\">Whether to replicate shortcut settings or not.</para>"},"winType":{"$ref":"#/components/schemas/WindowType"},"target":{"type":"string","description":"<para type=\"description\">Application target file.</para>","nullable":true},"startIn":{"type":"string","description":"<para type=\"description\">Application working directory.</para>","nullable":true},"parameters":{"type":"string","description":"<para type=\"description\">Application parameters.</para>","nullable":true},"package":{"type":"string","description":"<para type=\"description\">Application package</para>","nullable":true},"packagedApp":{"type":"string","description":"<para type=\"description\">Application in the application package</para>","nullable":true},"vdiHostPoolId":{"type":"integer","description":"<para type=\"description\">ID of the VDI Host Pool</para>","format":"int32"},"persistent":{"type":"boolean","description":"<para type=\"description\">Specifies whether the connection is persistent or not</para>"},"connectTo":{"$ref":"#/components/schemas/VDIMatchingMode"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Published VDI Application</para>\r\n<para type=\"description\"></para>"},"MaintenanceMessages":{"type":"object","properties":{"maintenanceMessage_en_US":{"type":"string","description":"<para type=\"description\">Maintenance message in English.</para>","nullable":true},"maintenanceMessage_ja_JP":{"type":"string","description":"<para type=\"description\">Maintenance message in Japanese.</para>","nullable":true},"maintenanceMessage_fr_FR":{"type":"string","description":"<para type=\"description\">Maintenance message in French.</para>","nullable":true},"maintenanceMessage_es_ES":{"type":"string","description":"<para type=\"description\">Maintenance message in Spanish.</para>","nullable":true},"maintenanceMessage_it_IT":{"type":"string","description":"<para type=\"description\">Maintenance message in Italian.</para>","nullable":true},"maintenanceMessage_pt_BR":{"type":"string","description":"<para type=\"description\">Maintenance message in Portuguese.</para>","nullable":true},"maintenanceMessage_nl_NL":{"type":"string","description":"<para type=\"description\">Maintenance message in Dutch.</para>","nullable":true},"maintenanceMessage_zh_TW":{"type":"string","description":"<para type=\"description\">Maintenance message in Chinese (Traditional).</para>","nullable":true},"maintenanceMessage_zh_CN":{"type":"string","description":"<para type=\"description\">Maintenance message in Chinese (Simplified).</para>","nullable":true},"maintenanceMessage_ko_KR":{"type":"string","description":"<para type=\"description\">Maintenance message in Korean.</para>","nullable":true},"maintenanceMessage_de_DE":{"type":"string","description":"<para type=\"description\">Maintenance message in German.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Contains a set of maintenance messages in various languages</para>\r\n<para type=\"description\"></para>"},"RASPubObject":{"enum":[["0 = Any","1 = Folder","2 = RDSApp","3 = RDSDesktop","4 = VDIDesktop","5 = PCDesktop","6 = PCApp","7 = VDIApp","8 = AVDApp","9 = AVDDesktop","10 = LocalApp"]],"type":"string","description":"<para type=\"synopsis\">RAS Publishing Objects</para>\r\n<para type=\"description\"></para>","format":"int32"},"PubPreferredRoute":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"priority":{"type":"integer","description":"<para type=\"description\">Priority of the object.</para>","format":"int32"},"name":{"type":"string","description":"<para type=\"description\">The Name of the Publishing Route</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Description of the Publishing Route</para>","nullable":true},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Publishing Route is enabled or not</para>"},"referenceType":{"$ref":"#/components/schemas/RoutingType"},"referenceId":{"type":"integer","description":"<para type=\"description\">Reference ID of the Publishing Route</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Preferred Route</para>\r\n<para type=\"description\"></para>"},"RoutingType":{"enum":[["3 = Gateway","51 = HALB","83 = Custom"]],"type":"string","description":"<para type=\"synopsis\">RAS Publishing Routing Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"PubItemFilter":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/PubItemRule"},"nullable":true},"default":{"$ref":"#/components/schemas/DefaultAssignmentType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">The PubItem Filter object.</para>\r\n<para type=\"description\"></para>"},"PubItemRule":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"priority":{"type":"integer","description":"<para type=\"description\">Priority of the object.</para>","format":"int32"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Rule is enabled or not</para>"},"name":{"type":"string","description":"<para type=\"description\">Name of the Rule</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Description of the Rule</para>","nullable":true},"criteria":{"$ref":"#/components/schemas/PubItemCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">PubItem Rule</para>\r\n<para type=\"description\"></para>"},"PubItemCriteria":{"type":"object","properties":{"securityPrincipals":{"$ref":"#/components/schemas/SecurityPrincipalsCriteria"},"gateways":{"$ref":"#/components/schemas/GatewaysCriteria"},"oSs":{"$ref":"#/components/schemas/OSsCriteria"},"iPs":{"$ref":"#/components/schemas/IPsCriteria"},"hardwareIDs":{"$ref":"#/components/schemas/HardwareIDsCriteria"},"access":{"$ref":"#/components/schemas/AccessType"},"devices":{"$ref":"#/components/schemas/DevicesCriteria"},"themes":{"$ref":"#/components/schemas/ThemesCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">PubItem Criteria</para>\r\n<para type=\"description\"></para>"},"SecurityPrincipalsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Security Principals Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/SecurityPrincipalCriteriaEntry"},"description":"<para type=\"description\">User criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Security Principals Criteria</para>\r\n<para type=\"description\"></para>"},"MatchingModeType":{"enum":[["0 = IsNotOneOfTheFollowing","1 = IsOneOfTheFollowing"]],"type":"string","description":"<para type=\"synopsis\">Matching mode type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"SecurityPrincipalCriteriaEntry":{"type":"object","properties":{"account":{"type":"string","description":"<para type=\"description\">The name of the user/group account the filter is added to.</para>","nullable":true},"type":{"$ref":"#/components/schemas/UserType"},"sid":{"type":"string","description":"<para type=\"description\">The SID of the user/group account the filter is added to.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Security Principal Criteria Entry</para>\r\n<para type=\"description\"></para>"},"UserType":{"enum":[["1 = User","2 = Group","3 = ForeignSecurityPrincipal","4 = Computer"]],"type":"string","description":"<para type=\"synopsis\">User Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"GatewaysCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Gateways Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/GatewayCriteriaEntry"},"description":"<para type=\"description\">Gateway criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Gateways Criteria</para>\r\n<para type=\"description\"></para>"},"GatewayCriteriaEntry":{"type":"object","properties":{"gatewayIP":{"type":"string","description":"<para type=\"description\">The gateway IP.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Gateway criteria entry</para>\r\n<para type=\"description\"></para>"},"OSsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the OSs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"allowedOSes":{"$ref":"#/components/schemas/AllowedOperatingSystems"}},"additionalProperties":false,"description":"<para type=\"synopsis\">OS Criteria Settings</para>\r\n<para type=\"description\"></para>"},"AllowedOperatingSystems":{"type":"object","properties":{"chrome":{"type":"boolean","description":"<para type=\"description\">Whether Chrome is allowed or not.</para>"},"android":{"type":"boolean","description":"<para type=\"description\">Whether Android is allowed or not.</para>"},"webClient":{"type":"boolean","description":"<para type=\"description\">Whether Web Client is allowed or not.</para>"},"iOS":{"type":"boolean","description":"<para type=\"description\">Whether iOS is allowed or not.</para>"},"linux":{"type":"boolean","description":"<para type=\"description\">Whether Linux is allowed or not.</para>"},"mac":{"type":"boolean","description":"<para type=\"description\">Whether MAC OS is allowed or not.</para>"},"wyse":{"type":"boolean","description":"<para type=\"description\">Whether Wyse is allowed or not.</para>"},"windows":{"type":"boolean","description":"<para type=\"description\">Whether Windows is allowed or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Allowed Operating Systems</para>\r\n<para type=\"description\"></para>"},"IPsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the IPs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"allowedIPs":{"$ref":"#/components/schemas/AllowedIPsCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPs Criteria</para>\r\n<para type=\"description\"></para>"},"AllowedIPsCriteria":{"type":"object","properties":{"iPv4s":{"type":"array","items":{"$ref":"#/components/schemas/IPv4CriteriaEntry"},"description":"<para type=\"description\">IPv4 criteria list</para>","nullable":true},"iPv6s":{"type":"array","items":{"$ref":"#/components/schemas/IPv6CriteriaEntry"},"description":"<para type=\"description\">IPv6 criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Allowed IPs Criteria</para>\r\n<para type=\"description\"></para>"},"IPv4CriteriaEntry":{"type":"object","properties":{"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPv4 Criteria Entry</para>\r\n<para type=\"description\"></para>"},"IPv6CriteriaEntry":{"type":"object","properties":{"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPv6 Criteria Entry</para>\r\n<para type=\"description\"></para>"},"HardwareIDsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Hardware IDs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/HardwareIDCriteriaEntry"},"description":"<para type=\"description\">Hardware IDs criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Hardware IDs Criteria</para>\r\n<para type=\"description\"></para>"},"HardwareIDCriteriaEntry":{"type":"object","properties":{"hardwareID":{"type":"string","description":"<para type=\"description\">The hardware ID.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Hardware ID criteria entry</para>\r\n<para type=\"description\"></para>"},"AccessType":{"enum":[["0 = DenyCriteriaWhen","1 = AllowCriteriaWhen"]],"type":"string","description":"<para type=\"synopsis\">Access type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"DevicesCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Devices Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/ClientDeviceCriteriaEntry"},"description":"<para type=\"description\">Client criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Devices Criteria</para>\r\n<para type=\"description\"></para>"},"ClientDeviceCriteriaEntry":{"type":"object","properties":{"client":{"type":"string","description":"<para type=\"description\">The name of the client device.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Client device criteria entry</para>\r\n<para type=\"description\"></para>"},"ThemesCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Themes Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">Theme criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Themes Criteria</para>\r\n<para type=\"description\"></para>"},"DefaultAssignmentType":{"enum":[["0 = Deny","1 = Allow"]],"type":"string","description":"<para type=\"synopsis\">Default assignment type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Get

> Retrieve a specified published VDI application

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/PubItems/{id}/Apps/VDI":{"get":{"tags":["3-Publishing/Applications//VDI"],"summary":"Get","description":"Retrieve a specified published VDI application","operationId":"c2c64d4b-5482-4055-b937-0b6fbfb8bb00","parameters":[{"name":"id","in":"path","description":"ID of the published VDI application to be retrieved","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/PubVDIApp"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"PubVDIApp":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"maintenanceMessages":{"$ref":"#/components/schemas/MaintenanceMessages"},"inheritMaintenance":{"type":"boolean","description":"<para type=\"description\">Inherit Maintenance.</para>"},"replicateMaintenance":{"type":"boolean","description":"<para type=\"description\">Replicate Maintenance.</para>"},"name":{"type":"string","description":"<para type=\"description\">Name of the published item.</para>","nullable":true},"type":{"$ref":"#/components/schemas/RASPubObject"},"parentId":{"type":"integer","description":"<para type=\"description\">ID of the parent folder of the published item.</para>","format":"int32"},"previousId":{"type":"integer","description":"<para type=\"description\">ID of the previous published item.</para>","format":"int32"},"description":{"type":"string","description":"<para type=\"description\">Description of the published item.</para>","nullable":true},"enabledMode":{"$ref":"#/components/schemas/PubResourceEnabledMode"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the published item is enabled or not.</para>"},"publishToSite":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">List of the IDs of all the sites this item is published to.</para>","nullable":true},"preferredRoutingEnabled":{"type":"boolean","description":"<para type=\"description\">Whether Preferred Routing is enabled or not.</para>"},"preferredRoutes":{"type":"array","items":{"$ref":"#/components/schemas/PubPreferredRoute"},"description":"<para type=\"description\">The list of Preferred Routes.</para>","nullable":true},"filter":{"$ref":"#/components/schemas/PubItemFilter"},"startOnLogon":{"type":"boolean","description":"<para type=\"description\">Whether the 'Start automatically when user logs on' option is enabled or disabled.</para>"},"excludePrelaunch":{"type":"boolean","description":"<para type=\"description\">Exclude application from prelaunch.</para>"},"inheritShortcutDefaultSettings":{"type":"boolean","description":"<para type=\"description\">Whether to inherit default shortcut settings or not.</para>"},"createShortcutOnDesktop":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut on the desktop or not.</para>"},"createShortcutInStartFolder":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut in the start folder or not.</para>"},"startPath":{"type":"string","description":"<para type=\"description\">Starting path of the published item.</para>","nullable":true},"createShortcutInStartUpFolder":{"type":"boolean","description":"<para type=\"description\">Whether to create a shortcut in the startup folder or not.</para>"},"replicateShortcutSettings":{"type":"boolean","description":"<para type=\"description\">Whether to replicate shortcut settings or not.</para>"},"winType":{"$ref":"#/components/schemas/WindowType"},"target":{"type":"string","description":"<para type=\"description\">Application target file.</para>","nullable":true},"startIn":{"type":"string","description":"<para type=\"description\">Application working directory.</para>","nullable":true},"parameters":{"type":"string","description":"<para type=\"description\">Application parameters.</para>","nullable":true},"package":{"type":"string","description":"<para type=\"description\">Application package</para>","nullable":true},"packagedApp":{"type":"string","description":"<para type=\"description\">Application in the application package</para>","nullable":true},"vdiHostPoolId":{"type":"integer","description":"<para type=\"description\">ID of the VDI Host Pool</para>","format":"int32"},"persistent":{"type":"boolean","description":"<para type=\"description\">Specifies whether the connection is persistent or not</para>"},"connectTo":{"$ref":"#/components/schemas/VDIMatchingMode"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Published VDI Application</para>\r\n<para type=\"description\"></para>"},"MaintenanceMessages":{"type":"object","properties":{"maintenanceMessage_en_US":{"type":"string","description":"<para type=\"description\">Maintenance message in English.</para>","nullable":true},"maintenanceMessage_ja_JP":{"type":"string","description":"<para type=\"description\">Maintenance message in Japanese.</para>","nullable":true},"maintenanceMessage_fr_FR":{"type":"string","description":"<para type=\"description\">Maintenance message in French.</para>","nullable":true},"maintenanceMessage_es_ES":{"type":"string","description":"<para type=\"description\">Maintenance message in Spanish.</para>","nullable":true},"maintenanceMessage_it_IT":{"type":"string","description":"<para type=\"description\">Maintenance message in Italian.</para>","nullable":true},"maintenanceMessage_pt_BR":{"type":"string","description":"<para type=\"description\">Maintenance message in Portuguese.</para>","nullable":true},"maintenanceMessage_nl_NL":{"type":"string","description":"<para type=\"description\">Maintenance message in Dutch.</para>","nullable":true},"maintenanceMessage_zh_TW":{"type":"string","description":"<para type=\"description\">Maintenance message in Chinese (Traditional).</para>","nullable":true},"maintenanceMessage_zh_CN":{"type":"string","description":"<para type=\"description\">Maintenance message in Chinese (Simplified).</para>","nullable":true},"maintenanceMessage_ko_KR":{"type":"string","description":"<para type=\"description\">Maintenance message in Korean.</para>","nullable":true},"maintenanceMessage_de_DE":{"type":"string","description":"<para type=\"description\">Maintenance message in German.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Contains a set of maintenance messages in various languages</para>\r\n<para type=\"description\"></para>"},"RASPubObject":{"enum":[["0 = Any","1 = Folder","2 = RDSApp","3 = RDSDesktop","4 = VDIDesktop","5 = PCDesktop","6 = PCApp","7 = VDIApp","8 = AVDApp","9 = AVDDesktop","10 = LocalApp"]],"type":"string","description":"<para type=\"synopsis\">RAS Publishing Objects</para>\r\n<para type=\"description\"></para>","format":"int32"},"PubResourceEnabledMode":{"enum":[["0 = Disabled","1 = Enabled","2 = Maintenance"]],"type":"string","description":"<para type=\"synopsis\">Published resource availability modes.</para>\r\n<para type=\"description\"></para>","format":"int32"},"PubPreferredRoute":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"priority":{"type":"integer","description":"<para type=\"description\">Priority of the object.</para>","format":"int32"},"name":{"type":"string","description":"<para type=\"description\">The Name of the Publishing Route</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Description of the Publishing Route</para>","nullable":true},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Publishing Route is enabled or not</para>"},"referenceType":{"$ref":"#/components/schemas/RoutingType"},"referenceId":{"type":"integer","description":"<para type=\"description\">Reference ID of the Publishing Route</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Publishing Preferred Route</para>\r\n<para type=\"description\"></para>"},"RoutingType":{"enum":[["3 = Gateway","51 = HALB","83 = Custom"]],"type":"string","description":"<para type=\"synopsis\">RAS Publishing Routing Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"PubItemFilter":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/PubItemRule"},"nullable":true},"default":{"$ref":"#/components/schemas/DefaultAssignmentType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">The PubItem Filter object.</para>\r\n<para type=\"description\"></para>"},"PubItemRule":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"priority":{"type":"integer","description":"<para type=\"description\">Priority of the object.</para>","format":"int32"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Rule is enabled or not</para>"},"name":{"type":"string","description":"<para type=\"description\">Name of the Rule</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Description of the Rule</para>","nullable":true},"criteria":{"$ref":"#/components/schemas/PubItemCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">PubItem Rule</para>\r\n<para type=\"description\"></para>"},"PubItemCriteria":{"type":"object","properties":{"securityPrincipals":{"$ref":"#/components/schemas/SecurityPrincipalsCriteria"},"gateways":{"$ref":"#/components/schemas/GatewaysCriteria"},"oSs":{"$ref":"#/components/schemas/OSsCriteria"},"iPs":{"$ref":"#/components/schemas/IPsCriteria"},"hardwareIDs":{"$ref":"#/components/schemas/HardwareIDsCriteria"},"access":{"$ref":"#/components/schemas/AccessType"},"devices":{"$ref":"#/components/schemas/DevicesCriteria"},"themes":{"$ref":"#/components/schemas/ThemesCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">PubItem Criteria</para>\r\n<para type=\"description\"></para>"},"SecurityPrincipalsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Security Principals Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/SecurityPrincipalCriteriaEntry"},"description":"<para type=\"description\">User criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Security Principals Criteria</para>\r\n<para type=\"description\"></para>"},"MatchingModeType":{"enum":[["0 = IsNotOneOfTheFollowing","1 = IsOneOfTheFollowing"]],"type":"string","description":"<para type=\"synopsis\">Matching mode type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"SecurityPrincipalCriteriaEntry":{"type":"object","properties":{"account":{"type":"string","description":"<para type=\"description\">The name of the user/group account the filter is added to.</para>","nullable":true},"type":{"$ref":"#/components/schemas/UserType"},"sid":{"type":"string","description":"<para type=\"description\">The SID of the user/group account the filter is added to.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Security Principal Criteria Entry</para>\r\n<para type=\"description\"></para>"},"UserType":{"enum":[["1 = User","2 = Group","3 = ForeignSecurityPrincipal","4 = Computer"]],"type":"string","description":"<para type=\"synopsis\">User Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"GatewaysCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Gateways Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/GatewayCriteriaEntry"},"description":"<para type=\"description\">Gateway criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Gateways Criteria</para>\r\n<para type=\"description\"></para>"},"GatewayCriteriaEntry":{"type":"object","properties":{"gatewayIP":{"type":"string","description":"<para type=\"description\">The gateway IP.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Gateway criteria entry</para>\r\n<para type=\"description\"></para>"},"OSsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the OSs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"allowedOSes":{"$ref":"#/components/schemas/AllowedOperatingSystems"}},"additionalProperties":false,"description":"<para type=\"synopsis\">OS Criteria Settings</para>\r\n<para type=\"description\"></para>"},"AllowedOperatingSystems":{"type":"object","properties":{"chrome":{"type":"boolean","description":"<para type=\"description\">Whether Chrome is allowed or not.</para>"},"android":{"type":"boolean","description":"<para type=\"description\">Whether Android is allowed or not.</para>"},"webClient":{"type":"boolean","description":"<para type=\"description\">Whether Web Client is allowed or not.</para>"},"iOS":{"type":"boolean","description":"<para type=\"description\">Whether iOS is allowed or not.</para>"},"linux":{"type":"boolean","description":"<para type=\"description\">Whether Linux is allowed or not.</para>"},"mac":{"type":"boolean","description":"<para type=\"description\">Whether MAC OS is allowed or not.</para>"},"wyse":{"type":"boolean","description":"<para type=\"description\">Whether Wyse is allowed or not.</para>"},"windows":{"type":"boolean","description":"<para type=\"description\">Whether Windows is allowed or not.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Allowed Operating Systems</para>\r\n<para type=\"description\"></para>"},"IPsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the IPs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"allowedIPs":{"$ref":"#/components/schemas/AllowedIPsCriteria"}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPs Criteria</para>\r\n<para type=\"description\"></para>"},"AllowedIPsCriteria":{"type":"object","properties":{"iPv4s":{"type":"array","items":{"$ref":"#/components/schemas/IPv4CriteriaEntry"},"description":"<para type=\"description\">IPv4 criteria list</para>","nullable":true},"iPv6s":{"type":"array","items":{"$ref":"#/components/schemas/IPv6CriteriaEntry"},"description":"<para type=\"description\">IPv6 criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Allowed IPs Criteria</para>\r\n<para type=\"description\"></para>"},"IPv4CriteriaEntry":{"type":"object","properties":{"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPv4 Criteria Entry</para>\r\n<para type=\"description\"></para>"},"IPv6CriteriaEntry":{"type":"object","properties":{"from":{"type":"string","nullable":true},"to":{"type":"string","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">IPv6 Criteria Entry</para>\r\n<para type=\"description\"></para>"},"HardwareIDsCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Hardware IDs Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/HardwareIDCriteriaEntry"},"description":"<para type=\"description\">Hardware IDs criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Hardware IDs Criteria</para>\r\n<para type=\"description\"></para>"},"HardwareIDCriteriaEntry":{"type":"object","properties":{"hardwareID":{"type":"string","description":"<para type=\"description\">The hardware ID.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Hardware ID criteria entry</para>\r\n<para type=\"description\"></para>"},"AccessType":{"enum":[["0 = DenyCriteriaWhen","1 = AllowCriteriaWhen"]],"type":"string","description":"<para type=\"synopsis\">Access type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"DevicesCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Devices Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"members":{"type":"array","items":{"$ref":"#/components/schemas/ClientDeviceCriteriaEntry"},"description":"<para type=\"description\">Client criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Devices Criteria</para>\r\n<para type=\"description\"></para>"},"ClientDeviceCriteriaEntry":{"type":"object","properties":{"client":{"type":"string","description":"<para type=\"description\">The name of the client device.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Client device criteria entry</para>\r\n<para type=\"description\"></para>"},"ThemesCriteria":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the Themes Criteria is enabled or not</para>"},"matchingMode":{"$ref":"#/components/schemas/MatchingModeType"},"ids":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">Theme criteria list</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Themes Criteria</para>\r\n<para type=\"description\"></para>"},"DefaultAssignmentType":{"enum":[["0 = Deny","1 = Allow"]],"type":"string","description":"<para type=\"synopsis\">Default assignment type options</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowType":{"enum":[["0 = Normal","1 = Maximized","2 = Minimized"]],"type":"string","description":"<para type=\"synopsis\">Published application window type</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"VDIMatchingMode":{"enum":[["0 = AnyGuest"]],"type":"string","description":"<para type=\"synopsis\">VDI Matching Mode.</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Update

> Modify properties of a published VDI application.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/PubItems/{id}/Apps/VDI":{"put":{"tags":["3-Publishing/Applications//VDI"],"summary":"Update","description":"Modify properties of a published VDI application.","operationId":"fcf8de63-a4bf-4d7c-97da-5147f0592e82","parameters":[{"name":"id","in":"path","description":"ID of the published VDI application to be updated","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Published VDI application configuration","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/SetPubVDIApp"}}}},"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"SetPubVDIApp":{"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">A new name to assign to the published resource.</para>","nullable":true},"replicateMaintenance":{"type":"boolean","description":"<para type=\"description\">Replicate Maintenance</para>","nullable":true},"inheritMaintenance":{"type":"boolean","description":"<para type=\"description\">Inherit Maintenance</para>","nullable":true},"enabledMode":{"$ref":"#/components/schemas/PubResourceEnabledMode"},"maintenanceMessage_en_US":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in English.</para>","nullable":true},"maintenanceMessage_ja_JP":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Japanese.</para>","nullable":true},"maintenanceMessage_fr_FR":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in French.</para>","nullable":true},"maintenanceMessage_es_ES":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Spanish.</para>","nullable":true},"maintenanceMessage_it_IT":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Italian.</para>","nullable":true},"maintenanceMessage_pt_BR":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Portuguese.</para>","nullable":true},"maintenanceMessage_nl_NL":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Dutch.</para>","nullable":true},"maintenanceMessage_de_DE":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in German.</para>","nullable":true},"maintenanceMessage_zh_TW":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Chinese (Traditional).</para>","nullable":true},"maintenanceMessage_zh_CN":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Chinese (Simplified).</para>","nullable":true},"maintenanceMessage_ko_KR":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Maintenance message for the published resource in Korean.</para>","nullable":true},"description":{"type":"string","description":"<para type=\"description\">Published resource description.</para>","nullable":true},"publishToSiteIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"<para type=\"description\">An array of sites to which to publish a resource.</para>","nullable":true},"preferredRoutingEnabled":{"type":"boolean","description":"<para type=\"description\">Enable or disable Preferred Routing.</para>","nullable":true},"replicateShortcutSettings":{"type":"boolean","description":"<para type=\"description\">Replicate shortcut settings to all sites.</para>","nullable":true},"createShortcutOnDesktop":{"type":"boolean","description":"<para type=\"description\">Create a shortcut on a client's desktop.</para>","nullable":true},"createShortcutInStartFolder":{"type":"boolean","description":"<para type=\"description\">Create a shortcut in the client's Start folder.</para>","nullable":true},"createShortcutInStartUpFolder":{"type":"boolean","description":"<para type=\"description\">Create a shortcut in the client's Auto Start folder.</para>","nullable":true},"startPath":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">Specifies the path in the Start folder where the shortcut will be created.</para>","nullable":true},"inheritShortcutDefaultSettings":{"type":"boolean","description":"<para type=\"description\">Inherit default shortcut settings.</para>","nullable":true},"startOnLogon":{"type":"boolean","description":"<para type=\"description\">Start a resource automatically when a user logs on.</para>","nullable":true},"excludePrelaunch":{"type":"boolean","description":"<para type=\"description\">Exclude application from prelaunch.</para>","nullable":true},"target":{"type":"string","description":"<para type=\"description\">File name and path of a published application executable.</para>","nullable":true},"startIn":{"type":"string","description":"<para type=\"description\">Folder name in which to start a published application.</para>","nullable":true},"parameters":{"type":"string","description":"<para type=\"description\">Optional parameters to pass to the published application executable.</para>","nullable":true},"package":{"type":"string","description":"<para type=\"description\">The MSIX Package.</para>","nullable":true},"packagedApp":{"type":"string","description":"<para type=\"description\">The application within the MSIX package.</para>","nullable":true},"winType":{"$ref":"#/components/schemas/WindowType"},"persistent":{"type":"boolean","description":"<para type=\"description\">Specifies whether the connection is persistent or not.</para>","nullable":true},"connectTo":{"$ref":"#/components/schemas/VDIMatchingMode"},"vdiHostPoolId":{"type":"integer","description":"<para type=\"description\">Specifies the VDI Host Pool from which to publish an application.</para>","format":"int32","nullable":true},"vdiHostPool":{"$ref":"#/components/schemas/VDIHostPool"},"vdiTemplate":{"$ref":"#/components/schemas/Template"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Update settings of an application published from VDI Desktop</para>\r\n<para type=\"description\"></para>"},"PubResourceEnabledMode":{"enum":[["0 = Disabled","1 = Enabled","2 = Maintenance"]],"type":"string","description":"<para type=\"synopsis\">Published resource availability modes.</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowType":{"enum":[["0 = Normal","1 = Maximized","2 = Minimized"]],"type":"string","description":"<para type=\"synopsis\">Published application window type</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"VDIMatchingMode":{"enum":[["0 = AnyGuest"]],"type":"string","description":"<para type=\"synopsis\">VDI Matching Mode.</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"VDIHostPool":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"name":{"type":"string","description":"<para type=\"description\">Name of the VDI Host Pool</para>","nullable":true},"siteId":{"type":"integer","description":"<para type=\"description\">Site ID</para>","format":"int32"},"description":{"type":"string","description":"<para type=\"description\">Description of the VDI Host Pool</para>","nullable":true},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether the VDI Host Pool is enabled or not></para>"},"provisioning":{"$ref":"#/components/schemas/VDIProvisioningSettings"},"provisioningType":{"$ref":"#/components/schemas/ProvisioningType"},"members":{"$ref":"#/components/schemas/MembersSettings"},"template":{"$ref":"#/components/schemas/TemplateSettings"},"providerSettings":{"$ref":"#/components/schemas/HostPoolProviderSettings"},"inheritDefaultVDIActionSettings":{"type":"boolean","description":"<para type=\"description\">If true, default Action settings will be inherited.</para>"},"action":{"$ref":"#/components/schemas/ActionSettings"},"inheritDefaultUserProfileSettings":{"type":"boolean","description":"<para type=\"description\">If true, default User Profile settings will be inherited.</para>"},"userProfile":{"$ref":"#/components/schemas/UserProfileSettings"},"inheritDefaultAppPackageSettings":{"type":"boolean","description":"<para type=\"description\">If true, default app package settings will be inherited.</para>"},"appPackagesAssigned":{"$ref":"#/components/schemas/AppPackagesAssigned"},"inheritDefaultOptimizationSettings":{"type":"boolean","description":"<para type=\"description\">If true, default optimization settings will be inherited.</para>","nullable":true},"optimization":{"$ref":"#/components/schemas/ImageOptimization"},"inheritDefaultAgentSettings":{"type":"boolean","description":"<para type=\"description\">If true, default Agent settings will be inherited.</para>"},"agent":{"$ref":"#/components/schemas/AgentSettings"},"inheritDefaultRDPPrinterSettings":{"type":"boolean","description":"<para type=\"description\">If true, default RDP Printer settings will be inherited.</para>"},"rdpPrinter":{"$ref":"#/components/schemas/RDPPrinterSettings"},"inheritDefaultVDISecuritySettings":{"type":"boolean","description":"<para type=\"description\">If true, default Security settings will be inherited.</para>"},"security":{"$ref":"#/components/schemas/VDISecuritySettings"},"inheritDefaultAutoUpgradeSettings":{"type":"boolean","description":"<para type=\"description\">If true, default Auto-upgrade settings will be inherited.</para>"},"autoUpgrade":{"$ref":"#/components/schemas/AutoUpgradeSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">VDI Host Pool</para>\r\n<para type=\"description\"></para>"},"VDIProvisioningSettings":{"type":"object","properties":{"hostName":{"type":"string","description":"<para type=\"description\">The Host name format. All Host created from the template will have this name with %ID:N:S% replaced.</para>","nullable":true},"defaultPowerState":{"$ref":"#/components/schemas/DefaultPowerState"},"maxHosts":{"type":"integer","description":"<para type=\"description\">The maximum number of hosts that can be created from the template.</para>","format":"int32"},"preCreatedHosts":{"type":"integer","description":"<para type=\"description\">The maximum number of pre-created hosts.</para>","format":"int32"},"duration":{"type":"integer","description":"<para type=\"description\">The Duration</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">VDI Host Pool Provisioning Settings</para>\r\n<para type=\"description\"></para>"},"DefaultPowerState":{"enum":[["0 = PoweredOn","1 = PoweredOff","2 = Suspended"]],"type":"string","description":"<para type=\"synopsis\">Session Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProvisioningType":{"enum":[["0 = Template","1 = Standalone"]],"type":"string","description":"<para type=\"synopsis\">Provisioning Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"MembersSettings":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/VDIHostPoolMember"},"description":"<para type=\"description\">List of VDI Host Pool members</para>","nullable":true},"wildCard":{"type":"string","description":"<para type=\"description\">A user-defined VDI Host Pool wildcard</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Host Pool Members Settings</para>\r\n<para type=\"description\"></para>"},"VDIHostPoolMember":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the VDI Host Pool member</para>","format":"int32"},"name":{"type":"string","description":"<para type=\"description\">Name of the VDI Host Pool member</para>","nullable":true},"type":{"$ref":"#/components/schemas/VDIHostPoolMemberType"},"providerId":{"type":"integer","description":"<para type=\"description\">ID of the Provider</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">VDI Host Pool Member</para>\r\n<para type=\"description\"></para>"},"VDIHostPoolMemberType":{"enum":[["0 = AllHostsInProvider","2 = Host","3 = NativePool"]],"type":"string","description":"<para type=\"synopsis\">VDI Host Pool Member Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"TemplateSettings":{"type":"object","properties":{"templateId":{"type":"integer","description":"<para type=\"description\">Template ID</para>","format":"int32"},"templateVersionId":{"type":"integer","description":"<para type=\"description\">Template Version ID</para>","format":"int32"},"templateTagId":{"type":"integer","description":"<para type=\"description\">Template Tag ID</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Host Pool Template Settings</para>\r\n<para type=\"description\"></para>"},"HostPoolProviderSettings":{"type":"object","properties":{"aws":{"$ref":"#/components/schemas/AWSProviderSettings"},"vCenter":{"$ref":"#/components/schemas/VCenterProviderSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Host Pool Provider Settings</para>\r\n<para type=\"description\"></para>"},"AWSProviderSettings":{"type":"object","properties":{"subnetIDs":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Subnet IDs.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Amazon Web Service Provider Settings</para>\r\n<para type=\"description\"></para>"},"VCenterProviderSettings":{"type":"object","properties":{"datastoreSource":{"$ref":"#/components/schemas/DatastoreSourceType"},"datastoreIDs":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Datastore IDs.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">VMware VCenter Provider Settings</para>\r\n<para type=\"description\"></para>"},"DatastoreSourceType":{"enum":[["0 = Template","1 = Selection"]],"type":"string","description":"<para type=\"synopsis\">Datastore Source Type.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ActionSettings":{"type":"object","properties":{"sessionAction":{"$ref":"#/components/schemas/SessionAction"},"performAction":{"$ref":"#/components/schemas/PerformAction"},"performActionAfterSec":{"type":"integer","description":"<para type=\"description\">Perform action after (in seconds).</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Action Settings</para>\r\n<para type=\"description\">Available to Personal Host Pools</para>\r\n<para type=\"description\"></para>"},"SessionAction":{"enum":[["0 = Disconnect","1 = Logoff"]],"type":"string","description":"<para type=\"synopsis\">Session Action type</para>\r\n<para type=\"description\"></para>","format":"int32"},"PerformAction":{"enum":[["0 = DoNothing","2 = Shutdown","4 = Suspend","7 = Delete","8 = Restart","9 = Unassign","10 = Recreate"]],"type":"string","description":"<para type=\"synopsis\">Perform Action type</para>\r\n<para type=\"description\"></para>","format":"int32"},"UserProfileSettings":{"type":"object","properties":{"technology":{"$ref":"#/components/schemas/UserProfileTech"},"fsLogix":{"$ref":"#/components/schemas/FSLogixSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">User Profile Settings</para>\r\n<para type=\"description\"></para>"},"UserProfileTech":{"enum":[["0 = DoNotManage","1 = UPD","2 = FSLogix"]],"type":"string","description":"<para type=\"synopsis\">User Profile Technology values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"FSLogixSettings":{"type":"object","properties":{"profileContainer":{"$ref":"#/components/schemas/ProfileContainerSettings"},"officeContainer":{"$ref":"#/components/schemas/OfficeContainerSettings"},"generalSettings":{"$ref":"#/components/schemas/FSLogixGeneralSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FXLogix Settings</para>\r\n<para type=\"description\"></para>"},"ProfileContainerSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Specifies if the Container is enabled or disabled.</para>"},"locationType":{"$ref":"#/components/schemas/LocationType"},"vhdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'VHD Locations'.</para>","nullable":true},"ccdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'CCDLocations'.</para>","nullable":true},"profileDiskFormat":{"$ref":"#/components/schemas/ProfileDiskFormat"},"allocationType":{"$ref":"#/components/schemas/AllocationType"},"defaultSize":{"type":"integer","description":"<para type=\"description\">Specifies the 'Default size'.</para>","format":"int32"},"userInclusionList":{"type":"array","items":{"$ref":"#/components/schemas/UserFilter"},"description":"<para type=\"description\">Specifies the 'User Inclusion List'.</para>","nullable":true},"userExclusionList":{"type":"array","items":{"$ref":"#/components/schemas/UserFilter"},"description":"<para type=\"description\">Specifies the 'User Exclusion List'.</para>","nullable":true},"cloudCache":{"$ref":"#/components/schemas/CloudCacheSettings"},"customizeProfileFolders":{"type":"boolean","description":"<para type=\"description\">Specifies whether the 'Customize Profile Folders' is enabled or disabled.</para>"},"excludeCommonFolders":{"$ref":"#/components/schemas/ExcludeCommonFolders"},"folderInclusionList":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'Folder Inclusion List'.</para>","nullable":true},"folderExclusionList":{"type":"array","items":{"$ref":"#/components/schemas/FolderExclusion"},"description":"<para type=\"description\">Specifies the 'Folder Exclusion List'.</para>","nullable":true},"advancedSettings":{"$ref":"#/components/schemas/ProfileContainerAdvancedSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Profile Container Settings</para>\r\n<para type=\"description\"></para>"},"LocationType":{"enum":[["0 = SMBLocation","1 = CloudCache"]],"type":"string","description":"<para type=\"synopsis\">Location Type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProfileDiskFormat":{"enum":[["0 = VHD","1 = VHDX"]],"type":"string","description":"<para type=\"synopsis\">Profile Disk Format values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"AllocationType":{"enum":[["0 = Dynamic","1 = Full"]],"type":"string","description":"<para type=\"synopsis\">Allocation Type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"UserFilter":{"type":"object","properties":{"account":{"type":"string","description":"<para type=\"description\">The name of the user/group account the filter is added to.</para>","nullable":true},"type":{"$ref":"#/components/schemas/UserType"},"sid":{"type":"string","description":"<para type=\"description\">The SID of the user/group account the filter is added to.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">User filter</para>\r\n<para type=\"description\"></para>"},"UserType":{"enum":[["1 = User","2 = Group","3 = ForeignSecurityPrincipal","4 = Computer"]],"type":"string","description":"<para type=\"synopsis\">User Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"CloudCacheSettings":{"type":"object","properties":{"useMaxCacheSizeInMBs":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Max cache size in MBs' option is enabled or disabled.</para>"},"maxCacheSizeInMBs":{"type":"integer","description":"<para type=\"description\">Specifies the 'Max cache size in MBs'.</para>","format":"int32"},"useClearCacheOnLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Clear cache on logoff' option is enabled or disabled.</para>"},"clearCacheOnLogoff":{"$ref":"#/components/schemas/EnableState"},"useHealthyProvidersRequiredForRegister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Healthy providers required for register' option is enabled or disabled.</para>"},"healthyProvidersRequiredForRegister":{"type":"integer","description":"<para type=\"description\">Specifies the 'Healthy providers required for register'.</para>","format":"int32"},"useHealthyProvidersRequiredForUnregister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.</para>"},"healthyProvidersRequiredForUnregister":{"type":"integer","description":"<para type=\"description\">Specifies the 'Healthy providers required for unregister'.</para>","format":"int32"},"useUnregisterTimeout":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Unregister timeout' option is enabled or disabled.</para>"},"unregisterTimeout":{"type":"integer","description":"<para type=\"description\">Specifies the 'Unregister timeout'.</para>","format":"int32"},"useClearCacheOnForcedUnregister":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.</para>"},"clearCacheOnForcedUnregister":{"$ref":"#/components/schemas/EnableState"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Cloud Cache Settings</para>\r\n<para type=\"description\"></para>"},"EnableState":{"enum":[["0 = Disable","1 = Enable"]],"type":"string","description":"<para type=\"synopsis\">Enable State values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ExcludeCommonFolders":{"enum":[["1 = Contacts","2 = Desktop","4 = Documents","8 = Links","16 = MusicPodcasts","32 = PicturesVideos","64 = FoldersLowIntegProcesses","128 = Downloads"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Exclude Common Folders.</para>\r\n<para type=\"description\"></para>","format":"int32"},"FolderExclusion":{"type":"object","properties":{"folder":{"type":"string","description":"<para type=\"description\">Specifies the 'Folder' path.</para>","nullable":true},"excludeFolderCopy":{"$ref":"#/components/schemas/ExcludeFolderCopy"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Folder Exclusion Settings</para>\r\n<para type=\"description\"></para>"},"ExcludeFolderCopy":{"enum":[["0 = None","1 = CopyBase","2 = CopyBack"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Exclude Folder Copy values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProfileContainerAdvancedSettings":{"type":"object","properties":{"useLockedRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.</para>"},"lockedRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Number of locked VHD(X) retries'.</para>","format":"int32"},"useLockedRetryInterval":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.</para>"},"lockedRetryInterval":{"type":"integer","description":"<para type=\"description\">Specifies the 'Delay between locked VHD(X) retries'.</para>","format":"int32"},"useAccessNetworkAsComputerObject":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Access network as computer object' option is enabled or disabled.</para>"},"accessNetworkAsComputerObject":{"$ref":"#/components/schemas/EnableState"},"useAttachVHDSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.</para>"},"attachVHDSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'SDDL used when attaching the VHD'.</para>","nullable":true},"useDiffDiskParentFolderPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Diff disk parent folder path' option is enabled or disabled.</para>"},"diffDiskParentFolderPath":{"type":"string","description":"<para type=\"description\">Specifies the 'Diff disk parent folder path'.</para>","nullable":true},"useFlipFlopProfileDirectoryName":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.</para>"},"flipFlopProfileDirectoryName":{"$ref":"#/components/schemas/EnableState"},"useNoProfileContainingFolder":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.</para>"},"noProfileContainingFolder":{"$ref":"#/components/schemas/EnableState"},"useOutlookCachedMode":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.</para>"},"outlookCachedMode":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithFailure":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with failures' option is enabled or disabled.</para>"},"preventLoginWithFailure":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithTempProfile":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.</para>"},"preventLoginWithTempProfile":{"$ref":"#/components/schemas/EnableState"},"useReAttachRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach retry limit' option is enabled or disabled.</para>"},"reAttachRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach retry limit'.</para>","format":"int32"},"useReAttachIntervalSeconds":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach interval' option is enabled or disabled.</para>"},"reAttachIntervalSeconds":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach interval'.</para>","format":"int32"},"useRemoveOrphanedOSTFilesOnLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.</para>"},"removeOrphanedOSTFilesOnLogoff":{"$ref":"#/components/schemas/EnableState"},"useRoamSearch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Search roaming feature mode' option is enabled or disabled.</para>"},"roamSearch":{"$ref":"#/components/schemas/RoamSearch"},"useSIDDirNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.</para>"},"sidDirNameMatch":{"type":"string","description":"<para type=\"description\">Specifies the 'User-to-Profile matching pattern'.</para>","nullable":true},"useSIDDirNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile folder naming pattern' option is enabled or disabled.</para>"},"sidDirNamePattern":{"type":"string","description":"<para type=\"description\">Specifies the 'Profile folder naming pattern'.</para>","nullable":true},"useSIDDirSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.</para>"},"sidDirSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'Use SSDL on creation of SID container folder'.</para>","nullable":true},"useVHDNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.</para>"},"vhdNameMatch":{"type":"string","description":"<para type=\"description\">Specifies the 'Profile VHD(X) file matching pattern'.</para>","nullable":true},"useVHDNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.</para>"},"vhdNamePattern":{"type":"string","description":"<para type=\"description\">Specifies the 'Naming pattern for new VHD(X) files'.</para>","nullable":true},"useVHDXSectorSize":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHDX sector size' option is enabled or disabled.</para>"},"vhdxSectorSize":{"$ref":"#/components/schemas/VHDXSectorSize"},"useVolumeWaitTimeMS":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Volume wait time' option is enabled or disabled.</para>"},"volumeWaitTimeMS":{"type":"integer","description":"<para type=\"description\">Specifies the 'Volume wait time'.</para>","format":"int32"},"useIgnoreNonAVD":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled.</para>"},"ignoreNonAVD":{"$ref":"#/components/schemas/IgnoreNonAVD"},"useRedirectType":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Redirect type' option is enabled or disabled.</para>"},"redirectType":{"$ref":"#/components/schemas/RedirectType"},"useKeepLocalDir":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Keep local profiles' option is enabled or disabled.</para>"},"keepLocalDir":{"$ref":"#/components/schemas/EnableState"},"useDeleteLocalProfileWhenVHDShouldApply":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.</para>"},"deleteLocalProfileWhenVHDShouldApply":{"$ref":"#/components/schemas/EnableState"},"useProfileDirSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.</para>"},"profileDirSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'Custom SDDL for profile directory'.</para>","nullable":true},"useProfileType":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile type' option is enabled or disabled.</para>"},"profileType":{"$ref":"#/components/schemas/ProfileType"},"useSetTempToLocalPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.</para>"},"setTempToLocalPath":{"$ref":"#/components/schemas/TempFolderRedirectionMode"},"useCleanOutNotifications":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Clean out notifications' option is enabled or disabled.</para>"},"cleanOutNotifications":{"$ref":"#/components/schemas/EnableState"},"useInstallAppxPackages":{"type":"boolean","description":"<para type=\"description\">Specifies if the Install Appx packages' option is enabled or disabled.</para>"},"installAppxPackages":{"$ref":"#/components/schemas/EnableState"},"useRebootOnUserLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.</para>"},"rebootOnUserLogoff":{"$ref":"#/components/schemas/EnableState"},"useRoamIdentity":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Roam identity' option is enabled or disabled.</para>"},"roamIdentity":{"$ref":"#/components/schemas/EnableState"},"useShutdownOnUserLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.</para>"},"shutdownOnUserLogoff":{"$ref":"#/components/schemas/EnableState"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Profile Container Advanced Settings</para>\r\n<para type=\"description\"></para>"},"RoamSearch":{"enum":[["0 = Disable","1 = SingleUser","2 = MultiUser"]],"type":"string","description":"<para type=\"synopsis\">Roam search values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"VHDXSectorSize":{"enum":[["0 = SystemDefault","512 = Size_512","4096 = Size_4096"]],"type":"string","description":"<para type=\"synopsis\">Enable State values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"IgnoreNonAVD":{"enum":[["0 = AnySession","1 = AVDSessions"]],"type":"string","description":"<para type=\"synopsis\">Ignore non-AVD values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"RedirectType":{"enum":[["1 = Legacy","2 = Advanced"]],"type":"string","description":"<para type=\"synopsis\">Redirect type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProfileType":{"enum":[["0 = NormalProfile","1 = OnlyRWProfile","2 = OnlyROProfile","3 = RWROProfile"]],"type":"string","description":"<para type=\"synopsis\">Profile Type values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"TempFolderRedirectionMode":{"enum":[["0 = TakeNoAction","1 = RedirectTempAndTmp","2 = RedirectINetCache","3 = RedirectTempTmpAndINetCache"]],"type":"string","description":"<para type=\"synopsis\">Temporary Folder Redirection Mode values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"OfficeContainerSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Specifies if the Container is enabled or disabled.</para>"},"locationType":{"$ref":"#/components/schemas/LocationType"},"vhdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'VHD Locations'.</para>","nullable":true},"ccdLocations":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Specifies the 'CCDLocations'.</para>","nullable":true},"profileDiskFormat":{"$ref":"#/components/schemas/ProfileDiskFormat"},"allocationType":{"$ref":"#/components/schemas/AllocationType"},"defaultSize":{"type":"integer","description":"<para type=\"description\">Specifies the 'Default size'.</para>","format":"int32"},"userInclusionList":{"type":"array","items":{"$ref":"#/components/schemas/UserFilter"},"description":"<para type=\"description\">Specifies the 'User Inclusion List'.</para>","nullable":true},"userExclusionList":{"type":"array","items":{"$ref":"#/components/schemas/UserFilter"},"description":"<para type=\"description\">Specifies the 'User Exclusion List'.</para>","nullable":true},"cloudCache":{"$ref":"#/components/schemas/CloudCacheSettings"},"advancedSettings":{"$ref":"#/components/schemas/OfficeContainerAdvancedSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Office Container Settings</para>\r\n<para type=\"description\"></para>"},"OfficeContainerAdvancedSettings":{"type":"object","properties":{"useLockedRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.</para>"},"lockedRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Number of locked VHD(X) retries'.</para>","format":"int32"},"useLockedRetryInterval":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.</para>"},"lockedRetryInterval":{"type":"integer","description":"<para type=\"description\">Specifies the 'Delay between locked VHD(X) retries'.</para>","format":"int32"},"useAccessNetworkAsComputerObject":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Access network as computer object' option is enabled or disabled.</para>"},"accessNetworkAsComputerObject":{"$ref":"#/components/schemas/EnableState"},"useAttachVHDSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.</para>"},"attachVHDSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'SDDL used when attaching the VHD'.</para>","nullable":true},"useDiffDiskParentFolderPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Diff disk parent folder path' option is enabled or disabled.</para>"},"diffDiskParentFolderPath":{"type":"string","description":"<para type=\"description\">Specifies the 'Diff disk parent folder path'.</para>","nullable":true},"useFlipFlopProfileDirectoryName":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.</para>"},"flipFlopProfileDirectoryName":{"$ref":"#/components/schemas/EnableState"},"useNoProfileContainingFolder":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.</para>"},"noProfileContainingFolder":{"$ref":"#/components/schemas/EnableState"},"useOutlookCachedMode":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.</para>"},"outlookCachedMode":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithFailure":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with failures' option is enabled or disabled.</para>"},"preventLoginWithFailure":{"$ref":"#/components/schemas/EnableState"},"usePreventLoginWithTempProfile":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.</para>"},"preventLoginWithTempProfile":{"$ref":"#/components/schemas/EnableState"},"useReAttachRetryCount":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach retry limit' option is enabled or disabled.</para>"},"reAttachRetryCount":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach retry limit'.</para>","format":"int32"},"useReAttachIntervalSeconds":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Re-attach interval' option is enabled or disabled.</para>"},"reAttachIntervalSeconds":{"type":"integer","description":"<para type=\"description\">Specifies the 'Re-attach interval'.</para>","format":"int32"},"useRemoveOrphanedOSTFilesOnLogoff":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.</para>"},"removeOrphanedOSTFilesOnLogoff":{"$ref":"#/components/schemas/EnableState"},"useRoamSearch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Search roaming feature mode' option is enabled or disabled.</para>"},"roamSearch":{"$ref":"#/components/schemas/RoamSearch"},"useSIDDirNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.</para>"},"sidDirNameMatch":{"type":"string","description":"<para type=\"description\">Specifies the 'User-to-Profile matching pattern'.</para>","nullable":true},"useSIDDirNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile folder naming pattern' option is enabled or disabled.</para>"},"sidDirNamePattern":{"type":"string","description":"<para type=\"description\">Specifies the 'Profile folder naming pattern'.</para>","nullable":true},"useSIDDirSDDL":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.</para>"},"sidDirSDDL":{"type":"string","description":"<para type=\"description\">Specifies the 'Use SSDL on creation of SID container folder'.</para>","nullable":true},"useVHDNameMatch":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.</para>"},"vhdNameMatch":{"type":"string","description":"<para type=\"description\">Specifies the 'Profile VHD(X) file matching pattern'.</para>","nullable":true},"useVHDNamePattern":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.</para>"},"vhdNamePattern":{"type":"string","description":"<para type=\"description\">Specifies the 'Naming pattern for new VHD(X) files'.</para>","nullable":true},"useVHDXSectorSize":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHDX sector size' option is enabled or disabled.</para>"},"vhdxSectorSize":{"$ref":"#/components/schemas/VHDXSectorSize"},"useVolumeWaitTimeMS":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Volume wait time' option is enabled or disabled.</para>"},"volumeWaitTimeMS":{"type":"integer","description":"<para type=\"description\">Specifies the 'Volume wait time'.</para>","format":"int32"},"useIgnoreNonAVD":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled.</para>"},"ignoreNonAVD":{"$ref":"#/components/schemas/IgnoreNonAVD"},"useRedirectType":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Redirect type' option is enabled or disabled.</para>"},"redirectType":{"$ref":"#/components/schemas/RedirectType"},"useIncludeOfficeActivation":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Office Activation' option is enabled or disabled.</para>"},"includeOfficeActivation":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneDrive":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneDrive' option is enabled or disabled.</para>"},"includeOneDrive":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneNote":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneNote' option is enabled or disabled.</para>"},"includeOneNote":{"$ref":"#/components/schemas/EnableState"},"useIncludeOneNoteUWP":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include OneNote UWP' option is enabled or disabled.</para>"},"includeOneNoteUWP":{"$ref":"#/components/schemas/EnableState"},"useIncludeOutlook":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Outlook' option is enabled or disabled.</para>"},"includeOutlook":{"$ref":"#/components/schemas/EnableState"},"useIncludeOutlookPersonalization":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Outlook Personalization' option is enabled or disabled.</para>"},"includeOutlookPersonalization":{"$ref":"#/components/schemas/EnableState"},"useIncludeSharepoint":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Sharepoint' option is enabled or disabled.</para>"},"includeSharepoint":{"$ref":"#/components/schemas/EnableState"},"useIncludeTeams":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Include Teams' option is enabled or disabled.</para>"},"includeTeams":{"$ref":"#/components/schemas/EnableState"},"useMirrorLocalOSTToVHD":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.</para>"},"mirrorLocalOSTToVHD":{"$ref":"#/components/schemas/MirrorLocalOSTToVHD"},"useNumSessionVHDsToKeep":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.</para>"},"numSessionVHDsToKeep":{"type":"integer","description":"<para type=\"description\">Specifies the 'Number of Session VHDs to Keep'.</para>","format":"int32"},"useOutlookFolderPath":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Outlook Folder Path' option is enabled or disabled.</para>"},"outlookFolderPath":{"type":"string","description":"<para type=\"description\">Specifies the 'Outlook Folder Path'.</para>","nullable":true},"useRefreshUserPolicy":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Refresh User Policy' option is enabled or disabled.</para>"},"refreshUserPolicy":{"$ref":"#/components/schemas/EnableState"},"useVHDAccessMode":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHD Access Mode' option is enabled or disabled.</para>"},"vhdAccessMode":{"$ref":"#/components/schemas/VHDAccessMode"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Office Container Advanced Settings</para>\r\n<para type=\"description\"></para>"},"MirrorLocalOSTToVHD":{"enum":[["0 = DoNothing","1 = Copy","2 = Move"]],"type":"string","description":"<para type=\"synopsis\">Mirror Local OST-VHD values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"VHDAccessMode":{"enum":[["0 = NormalDirectAccess","1 = DiffDiskNetwork","2 = DiffDiskLocal","3 = UniqueVHDPerSession"]],"type":"string","description":"<para type=\"synopsis\">VHD Access Mode values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"FSLogixGeneralSettings":{"type":"object","properties":{"appServices":{"$ref":"#/components/schemas/AppServicesSettings"},"cloudCacheGeneral":{"$ref":"#/components/schemas/CloudCacheGeneralSettings"},"logging":{"$ref":"#/components/schemas/FSLogixLoggingSettings"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix General Settings</para>\r\n<para type=\"description\"></para>"},"AppServicesSettings":{"type":"object","properties":{"useCleanupInvalidSessions":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.</para>"},"cleanupInvalidSessions":{"$ref":"#/components/schemas/EnableState"},"useRoamRecycleBin":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Roam recycle bin' option is enabled or disabled.</para>"},"roamRecycleBin":{"$ref":"#/components/schemas/EnableState"},"useVHDCompactDisk":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'VHD compact disk' option is enabled or disabled.</para>"},"vhdCompactDisk":{"$ref":"#/components/schemas/EnableState"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix App Services Settings</para>\r\n<para type=\"description\"></para>"},"CloudCacheGeneralSettings":{"type":"object","properties":{"useCacheDirectory":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Cache directory' option is enabled or disabled.</para>"},"cacheDirectory":{"type":"string","description":"<para type=\"description\">Specifies the 'Cache directory'.</para>","nullable":true},"useWriteCacheDirectory":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Write cache directory' option is enabled or disabled.</para>"},"writeCacheDirectory":{"type":"string","description":"<para type=\"description\">Specifies the 'Write cache directory'.</para>","nullable":true},"useProxyDirectory":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Proxy directory' option is enabled or disabled.</para>"},"proxyDirectory":{"type":"string","description":"<para type=\"description\">Specifies the 'Proxy directory'.</para>","nullable":true},"useSilenceACLWarning":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Silence ACL warning' option is enabled or disabled.</para>"},"silenceACLWarning":{"$ref":"#/components/schemas/EnableState"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Cloud Cache General Settings</para>\r\n<para type=\"description\"></para>"},"FSLogixLoggingSettings":{"type":"object","properties":{"logEnabled":{"$ref":"#/components/schemas/FSLogixLogEnabled"},"logLevel":{"$ref":"#/components/schemas/FSLogixLogLevel"},"logFileKeepingPeriod":{"type":"integer","description":"<para type=\"description\">Specifies the 'Log keeping period in days'. Default: '2'.</para>","format":"int32"},"logDirectory":{"type":"string","description":"<para type=\"description\">Specifies the 'Log directory'. Default: '%ProgramData%\\FSLogix\\Logs'.</para>","nullable":true},"robocopyLogPath":{"type":"string","description":"<para type=\"description\">Specifies the 'Robocopy log path'.</para>","nullable":true},"logSpecificComponents":{"$ref":"#/components/schemas/LogSpecificComponents"}},"additionalProperties":false,"description":"<para type=\"synopsis\">FSLogix Logging Settings</para>\r\n<para type=\"description\"></para>"},"FSLogixLogEnabled":{"enum":[["0 = Disable","1 = Specific","2 = All"]],"type":"string","description":"<para type=\"synopsis\">Log enabled values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"FSLogixLogLevel":{"enum":[["0 = Debug","1 = Information","2 = Warning","3 = Error"]],"type":"string","description":"<para type=\"synopsis\">FSLogix log level values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"LogSpecificComponents":{"enum":[["1 = ProfileConfigTool","2 = IEPlugin","4 = RuleEditor","8 = JavaRuleEditor","16 = FSLogixAgentService","32 = Profile","64 = JavaLauncher","128 = OfficeContainer","256 = RuleCompilation","512 = FontVisibility","1024 = Network","2048 = PrinterVisibility","4096 = ADSComputerGroup","8192 = DriverInterface","16384 = WindowsSearchRoaming","32768 = WindowsSearchPlugin","65536 = ProcessStartMonitor"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Log specific components values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"AppPackagesAssigned":{"type":"object","properties":{"applicationPackagesAssigned":{"type":"array","items":{"$ref":"#/components/schemas/AppPackageAssigned"},"description":"<para type=\"synopsis\">List of Application Packages Assigned</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Application Packages Assigned</para>\r\n<para type=\"description\"></para>"},"AppPackageAssigned":{"type":"object","properties":{"version":{"type":"string","description":"<para type=\"description\">Application version</para>","nullable":true},"tagName":{"type":"string","description":"<para type=\"description\">Application version tag name</para>","nullable":true},"tagId":{"type":"integer","description":"<para type=\"description\">Application version tag ID</para>","format":"int32","nullable":true},"packageName":{"type":"string","description":"<para type=\"description\">Assigned application package name</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Application Package Assigned</para>\r\n<para type=\"description\"></para>"},"ImageOptimization":{"type":"object","properties":{"enableOptimization":{"type":"boolean","description":"<para type=\"synopsis\">Whether Optimization is enabled or not</para>\r\n<para type=\"description\"></para>"},"optimizationType":{"$ref":"#/components/schemas/OptimizationTypeEnum"},"windowsDefenderATP":{"$ref":"#/components/schemas/WindowsDefenderATP"},"windowsComponents":{"$ref":"#/components/schemas/WindowsComponents"},"windowsDefenderATPEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Defender ATP is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsComponentsEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Components is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsServicesEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Services is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsScheduledTasksEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Scheduled Task is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsAdvancedOptionsEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Advanced Options is enabled or not</para>\r\n<para type=\"description\"></para>"},"networkPerformanceEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Network Performance is enabled or not</para>\r\n<para type=\"description\"></para>"},"registryEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Registry is enabled or not</para>\r\n<para type=\"description\"></para>"},"visualEffectsEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Visual Effects is enabled or not</para>\r\n<para type=\"description\"></para>"},"diskCleanupEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Disk Cleanup is enabled or not</para>\r\n<para type=\"description\"></para>"},"customScriptEnabled":{"type":"boolean","description":"<para type=\"synopsis\">Whether Custom Script is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsServices":{"$ref":"#/components/schemas/WindowsServices"},"windowsAdvancedOptions":{"$ref":"#/components/schemas/WindowsAdvancedOptions"},"networkPerformance":{"$ref":"#/components/schemas/NetworkPerformance"},"customScript":{"$ref":"#/components/schemas/CustomScript"},"diskCleanup":{"$ref":"#/components/schemas/DiskCleanup"},"visualEffects":{"$ref":"#/components/schemas/VisualEffects"},"windowsScheduledTasks":{"$ref":"#/components/schemas/WindowsScheduledTasks"},"registry":{"$ref":"#/components/schemas/Registries"},"uwpApps":{"$ref":"#/components/schemas/UWPApps"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization</para>\r\n<para type=\"description\"></para>"},"OptimizationTypeEnum":{"enum":[["0 = Automatic","1 = Manual"]],"type":"string","description":"<para type=\"synopsis\">Optimization Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowsDefenderATP":{"type":"object","properties":{"winDefATPTurnOffOn":{"$ref":"#/components/schemas/WindowsDefenderATPEnable"},"disableRealTimeProtection":{"type":"boolean","description":"<para type=\"synopsis\">Disable Real Time Protection</para>\r\n<para type=\"description\"></para>"},"excludeFolders":{"type":"array","items":{"type":"string"},"description":"<para type=\"synopsis\">Exclude Folders List</para>\r\n<para type=\"description\"></para>","nullable":true},"excludeProcesses":{"type":"array","items":{"type":"string"},"description":"<para type=\"synopsis\">Exclude Processes</para>\r\n<para type=\"description\"></para>","nullable":true},"excludeExtension":{"type":"array","items":{"type":"string"},"description":"<para type=\"synopsis\">Exclude Extensions</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Defender ATP</para>\r\n<para type=\"description\"></para>"},"WindowsDefenderATPEnable":{"enum":[["0 = TurnOffWindowsDefenderATP","1 = TurnOnWindowsDefenderATP"]],"type":"string","description":"<para type=\"synopsis\">Windows enable options</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowsComponents":{"type":"object","properties":{"windowsComponentsList":{"type":"array","items":{"$ref":"#/components/schemas/WindowsComponent"},"description":"<para type=\"synopsis\">Windows Components List</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Components</para>\r\n<para type=\"description\"></para>"},"WindowsComponent":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DetailsType"},"componentName":{"type":"string","description":"<para type=\"synopsis\">Windows Components Name</para>\r\n<para type=\"description\"></para>","nullable":true},"displayName":{"type":"string","description":"<para type=\"synopsis\">Windows Components Display Name</para>\r\n<para type=\"description\"></para>","nullable":true},"aliases":{"type":"string","description":"<para type=\"synopsis\">Windows Components Aliases</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image optimization windows component</para>\r\n<para type=\"description\"></para>"},"DetailsType":{"enum":[["0 = Predefined","1 = Custom"]],"type":"string","description":"<para type=\"synopsis\">Details Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowsServices":{"type":"object","properties":{"windowsServicesList":{"type":"array","items":{"$ref":"#/components/schemas/WindowsService"},"description":"<para type=\"synopsis\">Windows Services List</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Services</para>\r\n<para type=\"description\"></para>"},"WindowsService":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/DetailsType"},"serviceName":{"type":"string","description":"<para type=\"synopsis\">Windows Services Name</para>\r\n<para type=\"description\"></para>","nullable":true},"displayName":{"type":"string","description":"<para type=\"synopsis\">Windows Services Display Name</para>\r\n<para type=\"description\"></para>","nullable":true},"aliases":{"type":"string","description":"<para type=\"synopsis\">Windows Service Aliases</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image optimization windows services</para>\r\n<para type=\"description\"></para>"},"WindowsAdvancedOptions":{"type":"object","properties":{"partialStartLayoutContent":{"type":"string","description":"<para type=\"synopsis\">Partial Start menu layout</para>\r\n<para type=\"description\"></para>","nullable":true},"hibernate":{"type":"boolean","description":"<para type=\"synopsis\">Whether Hibernate is enabled or not</para>\r\n<para type=\"description\"></para>"},"teleCollection":{"type":"boolean","description":"<para type=\"synopsis\">Whether TeleCollection is enabled or not</para>\r\n<para type=\"description\"></para>"},"systemRestore":{"type":"boolean","description":"<para type=\"synopsis\">Whether System Restore is enabled or not</para>\r\n<para type=\"description\"></para>"},"additionalErrorReport":{"type":"boolean","description":"<para type=\"synopsis\">Whether Additional Error Reporting is enabled or not</para>\r\n<para type=\"description\"></para>"},"tiles":{"type":"boolean","description":"<para type=\"synopsis\">Whether Tiles is enabled or not</para>\r\n<para type=\"description\"></para>"},"cortana":{"type":"boolean","description":"<para type=\"synopsis\">Whether Cortana is enabled or not</para>\r\n<para type=\"description\"></para>"},"microsoftConsumerExperience":{"type":"boolean","description":"<para type=\"synopsis\">Whether Microsoft Consumer Experience is enabled or not</para>\r\n<para type=\"description\"></para>"},"windowsTips":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Tips is enabled or not</para>\r\n<para type=\"description\"></para>"},"commonProgramGroups":{"type":"boolean","description":"<para type=\"synopsis\">Whether Common Program Groups is enabled or not</para>\r\n<para type=\"description\"></para>"},"partialStartMenu":{"type":"boolean","description":"<para type=\"synopsis\">Whether Partial Start Menu is enabled or not</para>\r\n<para type=\"description\"></para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Advanced Options</para>\r\n<para type=\"description\"></para>"},"NetworkPerformance":{"type":"object","properties":{"dirCacheMax":{"type":"integer","description":"<para type=\"synopsis\">Directory Cache Value</para>\r\n<para type=\"description\"></para>","format":"int32"},"dormantFileLimit":{"type":"integer","description":"<para type=\"synopsis\">Dormant File Limit Value</para>\r\n<para type=\"description\"></para>","format":"int32"},"fileNotFoundCache":{"type":"integer","description":"<para type=\"synopsis\">File Not Found Cache Value</para>\r\n<para type=\"description\"></para>","format":"int32"},"fileInfoCache":{"type":"integer","description":"<para type=\"synopsis\">File Info Cache Value</para>\r\n<para type=\"description\"></para>","format":"int32"},"fileInfoCacheEnable":{"type":"boolean","description":"<para type=\"synopsis\">Whether File Info Cache is enabled or not</para>\r\n<para type=\"description\"></para>"},"directoryCacheEnable":{"type":"boolean","description":"<para type=\"synopsis\">Whether Directory Cache is enabled or not</para>\r\n<para type=\"description\"></para>"},"fileNotFoundCacheEnable":{"type":"boolean","description":"<para type=\"synopsis\">Whether File Not Found Cache is enabled or not</para>\r\n<para type=\"description\"></para>"},"dormantFileLimitEnable":{"type":"boolean","description":"<para type=\"synopsis\">Whether Dormant File Limit is enabled or not</para>\r\n<para type=\"description\"></para>"},"disableTCP":{"type":"boolean","description":"<para type=\"synopsis\">Whether TCP is disabled or not</para>\r\n<para type=\"description\"></para>"},"disableIPv6CompEnable":{"type":"boolean","description":"<para type=\"synopsis\">Whether Disable IPv6 Components is enabled or not</para>\r\n<para type=\"description\"></para>"},"disableIPv6ToIPv4":{"type":"boolean","description":"<para type=\"synopsis\">Whether Disable IPv6 To IPv4 is enabled or not</para>\r\n<para type=\"description\"></para>"},"disableIsaTap":{"type":"boolean","description":"<para type=\"synopsis\">Whether Disable IsaTap for IPv6 is enabled or not</para>\r\n<para type=\"description\"></para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Network Performance</para>\r\n<para type=\"description\"></para>"},"CustomScript":{"type":"object","properties":{"arguments":{"type":"string","description":"<para type=\"synopsis\">Arguments</para>\r\n<para type=\"description\"></para>","nullable":true},"command":{"type":"string","description":"<para type=\"synopsis\">Command</para>\r\n<para type=\"description\"></para>","nullable":true},"initDir":{"type":"string","description":"<para type=\"synopsis\">Initial Directory</para>\r\n<para type=\"description\"></para>","nullable":true},"user":{"type":"string","description":"<para type=\"synopsis\">User</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Custom Script</para>\r\n<para type=\"description\"></para>"},"DiskCleanup":{"type":"object","properties":{"cleanupWinSxSFolder":{"type":"boolean","description":"<para type=\"synopsis\">Whether Clean up windows SxS Folder is enabled or not</para>\r\n<para type=\"description\"></para>"},"cleanupSystemFiles":{"type":"boolean","description":"<para type=\"synopsis\">Whether Clean up system files is enabled or not</para>\r\n<para type=\"description\"></para>"},"cleanupTemporaryFileLogs":{"type":"boolean","description":"<para type=\"synopsis\">Whether Clean up temporary file logs is enabled or not</para>\r\n<para type=\"description\"></para>"},"removeOneDrive":{"type":"boolean","description":"<para type=\"synopsis\">Whether Remove One Drives is enabled or not</para>\r\n<para type=\"description\"></para>"},"deleteUserProfiles":{"type":"boolean","description":"<para type=\"synopsis\">Whether Delete User Profiles is enabled or not</para>\r\n<para type=\"description\"></para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Disk Cleanup</para>\r\n<para type=\"description\"></para>"},"VisualEffects":{"type":"object","properties":{"visualEffectsTypes":{"$ref":"#/components/schemas/VisualEffectsType"},"animateControlSelectElements":{"type":"boolean","description":"<para type=\"synopsis\">Whether Animate Control Select Elements is enabled or not</para>\r\n<para type=\"description\"></para>"},"animateWindowsWhenMinimizingMaximizing":{"type":"boolean","description":"<para type=\"synopsis\">Whether Animate Windows When Minimizing Or Maximizing is enabled or not</para>\r\n<para type=\"description\"></para>"},"animateTaskbar":{"type":"boolean","description":"<para type=\"synopsis\">Whether Animate Taskbar is enabled or not</para>\r\n<para type=\"description\"></para>"},"enablePeek":{"type":"boolean","description":"<para type=\"synopsis\">Whether Peek is enabled or not</para>\r\n<para type=\"description\"></para>"},"fadeSlideMenus":{"type":"boolean","description":"<para type=\"synopsis\">Whether Fade Slide Menus is enabled or not</para>\r\n<para type=\"description\"></para>"},"fadeSlideToolTips":{"type":"boolean","description":"<para type=\"synopsis\">Whether Fade Slide Tool Tips is enabled or not</para>\r\n<para type=\"description\"></para>"},"fadeOutMenuItems":{"type":"boolean","description":"<para type=\"synopsis\">Whether Fade Out Menu Items is enabled or not</para>\r\n<para type=\"description\"></para>"},"saveTaskbarThumbnail":{"type":"boolean","description":"<para type=\"synopsis\">Whether Taskbar Thumbnail is enabled or not</para>\r\n<para type=\"description\"></para>"},"showShadowUnderMouse":{"type":"boolean","description":"<para type=\"synopsis\">Whether Shadow Under Mouse is enabled or not</para>\r\n<para type=\"description\"></para>"},"shadowUnderWindows":{"type":"boolean","description":"<para type=\"synopsis\">Whether Shadow Under Windows is enabled or not</para>\r\n<para type=\"description\"></para>"},"thumbnailsInsteadOfIcons":{"type":"boolean","description":"<para type=\"synopsis\">Whether Thumbnails instead of icons is enabled or not</para>\r\n<para type=\"description\"></para>"},"showTranslucentSelection":{"type":"boolean","description":"<para type=\"synopsis\">Whether Translucent Selection is enabled or not</para>\r\n<para type=\"description\"></para>"},"showWindowsContentWhilstDragging":{"type":"boolean","description":"<para type=\"synopsis\">Whether Windows Content Whilst Dragging is enabled or not</para>\r\n<para type=\"description\"></para>"},"slideOpenComboBoxes":{"type":"boolean","description":"<para type=\"synopsis\">Whether Slide open combo boxes is enabled or not</para>\r\n<para type=\"description\"></para>"},"smoothEdgesScreenFonts":{"type":"boolean","description":"<para type=\"synopsis\">Whether Smooth Edges Screen Fonts is enabled or not</para>\r\n<para type=\"description\"></para>"},"smoothScrollListBoxes":{"type":"boolean","description":"<para type=\"synopsis\">Whether Smooth Scroll List Boxes is enabled or not</para>\r\n<para type=\"description\"></para>"},"dropShadowsIcon":{"type":"boolean","description":"<para type=\"synopsis\">Whether Drop Shadow Icon is enabled or not</para>\r\n<para type=\"description\"></para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Visual Effects</para>\r\n<para type=\"description\"></para>"},"VisualEffectsType":{"enum":[["0 = LetWindowsChooseWhatsBest","1 = AdjustForBestAppearance","2 = AdjustForBestPerformance","3 = Custom"]],"type":"string","description":"<para type=\"synopsis\">Visual Effects Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"WindowsScheduledTasks":{"type":"object","properties":{"windowsScheduledTasksList":{"type":"array","items":{"$ref":"#/components/schemas/ImageOptimizationWindowsScheduledTask"},"description":"<para type=\"descrition\">The Windows Scheduled Tasks List</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Scheduled Tasks</para>\r\n<para type=\"description\">A List of Windows Scheduled Task settings</para>"},"ImageOptimizationWindowsScheduledTask":{"type":"object","properties":{"task":{"type":"string","description":"<para type=\"synopsis\">Scheduled Task</para>\r\n<para type=\"description\"></para>","nullable":true},"location":{"type":"string","description":"<para type=\"synopsis\">Scheduled Task Location</para>\r\n<para type=\"description\"></para>","nullable":true},"type":{"$ref":"#/components/schemas/OptimizationFileType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Windows Scheduled Task</para>\r\n<para type=\"description\"></para>"},"OptimizationFileType":{"enum":[["0 = Folder","1 = Task"]],"type":"string","description":"<para type=\"synopsis\">Whether file type is a folder or a task.</para>\r\n<para type=\"description\"></para>","format":"int32"},"Registries":{"type":"object","properties":{"registryList":{"type":"array","items":{"$ref":"#/components/schemas/Registry"},"description":"<para type=\"descrition\">The Registry List</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Registries</para>\r\n<para type=\"description\">A list of Registries</para>"},"Registry":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"synopsis\">The Id of the registry</para>\r\n<para type=\"description\"></para>","format":"int32"},"action":{"$ref":"#/components/schemas/ActionType"},"registryName":{"type":"string","description":"<para type=\"synopsis\">Registry Name</para>\r\n<para type=\"description\"></para>","nullable":true},"dwordValue":{"type":"integer","description":"<para type=\"synopsis\">Value</para>\r\n<para type=\"description\"></para>","format":"int32"},"displayName":{"type":"string","description":"<para type=\"synopsis\">Display Name</para>\r\n<para type=\"description\"></para>","nullable":true},"hiveType":{"$ref":"#/components/schemas/HiveType"},"path":{"type":"string","description":"<para type=\"synopsis\">Path</para>\r\n<para type=\"description\"></para>","nullable":true},"regType":{"$ref":"#/components/schemas/ValueType"},"stringValue":{"type":"string","description":"<para type=\"synopsis\">String Value</para>\r\n<para type=\"description\"></para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - Registry</para>\r\n<para type=\"description\"></para>"},"ActionType":{"enum":[["0 = Add","1 = Modify","2 = Delete"]],"type":"string","description":"<para type=\"synopsis\">The action type for add registry entry</para>\r\n<para type=\"description\"></para>","format":"int32"},"HiveType":{"enum":[["0 = HKEY_CURRENT_CONFIG","1 = HKEY_USERS","2 = HKEY_LOCAL_MACHINE","3 = HKEY_CLASSES_ROOT"]],"type":"string","description":"<para type=\"synopsis\">The hive type for add registry entry</para>\r\n<para type=\"description\"></para>","format":"int32"},"ValueType":{"enum":[["0 = REG_SZ","1 = REG_DWORD","2 = REG_QWORD","3 = REG_MULTI_SZ","4 = REG_EXPAND_SZ"]],"type":"string","description":"<para type=\"synopsis\">The value type for add registry entry</para>\r\n<para type=\"description\"></para>","format":"int32"},"UWPApps":{"type":"object","properties":{"allExcept":{"type":"array","items":{"type":"string"},"description":"<para type=\"synopsis\">All Except List</para>\r\n<para type=\"description\"></para>","nullable":true},"followingPkgs":{"type":"array","items":{"type":"string"},"description":"<para type=\"synopsis\">Following Pkgs List</para>\r\n<para type=\"description\"></para>","nullable":true},"removeType":{"$ref":"#/components/schemas/RemoveType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Image Optimization - UWPApps</para>\r\n<para type=\"description\"></para>"},"RemoveType":{"enum":[["0 = AllExcept","1 = FollowingPkgs"]],"type":"string","description":"<para type=\"synopsis\">Remove Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"AgentSettings":{"type":"object","properties":{"disconnectActiveSessionAfter":{"type":"integer","description":"<para type=\"description\">Disconnect active session after (in seconds). 0 for 'Never'.</para>","format":"int32"},"logoffDisconnectedSessionAfter":{"type":"integer","description":"<para type=\"description\">Logoff disconnected session after (in seconds). 0 for 'Never'; 1 for 'Immediate'.</para>","format":"int32"},"sessionReadinessTimeout":{"type":"integer","description":"<para type=\"description\">Session readiness timeout (in seconds).</para>","format":"int32"},"allowURLAndMailRedirection":{"$ref":"#/components/schemas/AllowURLAndMailRedirection"},"supportShellURLNamespaceObjects":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.</para>"},"dragAndDropMode":{"$ref":"#/components/schemas/DragAndDropModeValue"},"allowRemoteExec":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.</para>"},"manageRDPTransportProtocol":{"$ref":"#/components/schemas/ManageRDPTransportProtocol"},"fileTransferMode":{"$ref":"#/components/schemas/FileTransferControlMode"},"fileTransferLocation":{"type":"string","description":"<para type=\"description\">Location where the File Transfer takes place, if and where it is allowed.</para>","nullable":true},"fileTransferLockLocation":{"type":"boolean","description":"<para type=\"description\">Lock Location where the File Transfer takes place, if and where it is allowed.</para>"},"enableDriveRedirectionCache":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.</para>"},"enableZOrder":{"type":"boolean","description":"<para type=\"description\">Specifies if the 'Enable Z-Order' option is enabled or disabled. (Experimental)</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Host Pool Agent Settings</para>\r\n<para type=\"description\"></para>"},"AllowURLAndMailRedirection":{"enum":[["0 = Disabled","1 = Enabled","2 = EnabledWithAppRegistration"]],"type":"string","description":"<para type=\"synopsis\">URL and Mail Redirection values.</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"DragAndDropModeValue":{"enum":[["0 = Disabled","1 = ClientToServer","2 = ServerToClient","3 = Bidirectional"]],"type":"string","description":"<para type=\"synopsis\">Drag and drop redirection values.</para>\r\n<para type=\"description\"></para>","format":"int32"},"ManageRDPTransportProtocol":{"enum":[["0 = Disabled","1 = BothUDPTCP","2 = OnlyTCP","3 = EitherUDPTCP"]],"type":"string","description":"<para type=\"synopsis\">Manage RDP transport protocol.</para>\r\n<para type=\"description\"></para>","format":"int32"},"FileTransferControlMode":{"enum":[["0 = Disabled","1 = ClientToServer","2 = ServerToClient","3 = Bidirectional"]],"type":"string","description":"<para type=\"synopsis\">File Transfer Control modes.</para>\r\n<para type=\"description\"></para>","format":"int32"},"RDPPrinterSettings":{"type":"object","properties":{"printerNameFormat":{"$ref":"#/components/schemas/PrnNameFormat"},"removeSessionNumberFromPrinterName":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Remove session number from printer name' option is enabled or disabled.</para>"},"removeClientNameFromPrinterName":{"type":"boolean","description":"<para type=\"description\">Specifies if 'Remove client name from printer name' option is enabled or disabled.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Host Pool Printer Settings</para>\r\n<para type=\"description\"></para>"},"PrnNameFormat":{"enum":[["0 = PrnFormat_PRN_CMP_SES","1 = PrnFormat_SES_CMP_PRN","2 = PrnFormat_PRN_REDSES"]],"type":"string","description":"<para type=\"synopsis\">Printer Name Format</para>\r\n<para type=\"description\"></para>\r\n<para type=\"description\"></para>","format":"int32"},"VDISecuritySettings":{"type":"object","properties":{"isUsersGrantedRDPermissions":{"type":"boolean","description":"<para type=\"description\">Grant users RD permission.</para>"},"groupType":{"$ref":"#/components/schemas/UserGroupType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">VDI Security Settings</para>\r\n<para type=\"description\"></para>"},"UserGroupType":{"enum":[["1 = Administrators","2 = RemoteDesktopUsers"]],"type":"string","description":"<para type=\"synopsis\">Group types to allow remote desktop access</para>\r\n<para type=\"description\"></para>","format":"int32"},"AutoUpgradeSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"<para type=\"description\">Enable auto-upgrade maintenance window</para>"},"startDateTime":{"type":"string","description":"<para type=\"description\">Start Date</para>","format":"date-time"},"drainModeDurationInSecs":{"type":"number","description":"<para type=\"description\">Drain mode duration</para>","format":"double"},"forceLogoffSessions":{"type":"boolean","description":"<para type=\"description\">Force logoff sessions at the end of the drain mode period</para>"},"repeat":{"$ref":"#/components/schemas/RepeatType"},"specificDays":{"$ref":"#/components/schemas/RepeatSpecificDays"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/ScheduleMessage"},"description":"<para type=\"description\">Messages</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Auto-upgrade Settings</para>\r\n<para type=\"description\"></para>"},"RepeatType":{"enum":[["0 = Never","1 = EveryDay","2 = EveryWeek","3 = Every2Weeks","4 = EveryMonth","5 = EveryYear","6 = SpecificDays"]],"type":"string","description":"<para type=\"synopsis\">Repeat Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"RepeatSpecificDays":{"enum":[["0 = Never","1 = Sunday","2 = Monday","4 = Tuesday","8 = Wednesday","16 = Thursday","32 = Friday","64 = Saturday"]],"type":"string[Flag]","description":"<para type=\"synopsis\">Repeat Specific Days</para>\r\n<para type=\"description\"></para>","format":"int32"},"ScheduleMessage":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"enabled":{"type":"boolean","description":"<para type=\"description\">Enabled</para>"},"messageTitle":{"type":"string","description":"<para type=\"description\">Message title</para>","nullable":true},"message":{"type":"string","description":"<para type=\"description\">Message</para>","nullable":true},"sendMsgSecs":{"type":"integer","description":"<para type=\"description\">Seconds before message is sent</para>","format":"int32"},"sendMsgWhen":{"$ref":"#/components/schemas/SendMsgWhen"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Schedule Message</para>\r\n<para type=\"description\"></para>"},"SendMsgWhen":{"enum":[["0 = Before","1 = After"]],"type":"string","description":"<para type=\"synopsis\">Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.</para>\r\n<para type=\"description\"></para>","format":"int32"},"Template":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"objType":{"$ref":"#/components/schemas/TemplateObjType"},"name":{"type":"string","description":"<para type=\"description\">Template Name</para>","nullable":true},"siteId":{"type":"integer","description":"<para type=\"description\">Site ID</para>","format":"int32"},"description":{"type":"string","description":"<para type=\"description\">Template Description</para>","nullable":true},"providerId":{"type":"integer","description":"<para type=\"description\">Provider ID</para>","format":"int32"},"templateType":{"$ref":"#/components/schemas/HostSessionType"},"vmId":{"type":"string","description":"<para type=\"description\">The ID of the source VM.</para>","nullable":true},"cloneMethod":{"$ref":"#/components/schemas/CloneMethod"},"availabilitySet":{"type":"boolean","description":"<para type=\"description\">Availability Set.</para>"},"advanced":{"$ref":"#/components/schemas/TemplateAdvanced"},"preparation":{"$ref":"#/components/schemas/TemplatePreparation"},"inheritDefaultOptimizationSettings":{"type":"boolean","description":"<para type=\"description\">Specifies the 'Image Optimization' object.</para>","nullable":true},"optimization":{"$ref":"#/components/schemas/ImageOptimization"},"licenseKeys":{"$ref":"#/components/schemas/TemplateLicense"},"azureId":{"type":"string","description":"<para type=\"description\">Azure ID.</para>","nullable":true},"distribution":{"$ref":"#/components/schemas/TemplateDistribution"}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template</para>\r\n<para type=\"description\"></para>"},"TemplateObjType":{"enum":[["89 = AVDTemplate","101 = RDSTemplate","102 = VDITemplate"]],"type":"string","description":"<para type=\"synopsis\">Template Object Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"HostSessionType":{"enum":[["0 = SingleSession","1 = MultiSession"]],"type":"string","description":"<para type=\"synopsis\">Host Session Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"CloneMethod":{"enum":[["0 = FullClone","1 = LinkedClone"]],"type":"string","description":"<para type=\"synopsis\">Clone Method</para>\r\n<para type=\"description\"></para>","format":"int32"},"TemplateAdvanced":{"type":"object","properties":{"folder":{"$ref":"#/components/schemas/TemplateAdvancedFolder"},"nativePool":{"$ref":"#/components/schemas/TemplateAdvancedNativePool"},"physicalHost":{"$ref":"#/components/schemas/TemplateAdvancedPhysicalHost"},"multipleNIC":{"$ref":"#/components/schemas/TemplateAdvancedMultipleNIC"},"aws":{"$ref":"#/components/schemas/TemplateAdvancedAWS"},"azure":{"$ref":"#/components/schemas/TemplateAdvancedAzure"}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template Advanced settings</para>\r\n<para type=\"description\"></para>"},"TemplateAdvancedFolder":{"type":"object","properties":{"folderName":{"type":"string","description":"<para type=\"description\">Folder name where desktop VMs will be created.</para>","nullable":true},"folderId":{"type":"string","description":"<para type=\"description\">The ID of a folder where desktop VMs will be created.</para>","nullable":true},"subFolderName":{"type":"string","description":"<para type=\"description\">Subfolder name where desktop VMs will be created.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template Advanced Folder settings</para>\r\n<para type=\"description\">Available to VDI/RDS Templates VCenter/MSCluster/HyperV</para>"},"TemplateAdvancedNativePool":{"type":"object","properties":{"nativePoolId":{"type":"string","description":"<para type=\"description\">The ID of the native pool where desktop VMs will be created.</para>","nullable":true},"nativePoolName":{"type":"string","description":"<para type=\"description\">The name of the native pool where desktop VMs will be created.</para>","nullable":true},"hwgpu":{"type":"boolean","description":"<para type=\"description\">Enable hardware acceleration graphics licensing support.</para>"}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template Advanced Native Pool settings</para>\r\n<para type=\"description\">Available to VDI/RDS Templates VMWareESXi/VCenter</para>"},"TemplateAdvancedPhysicalHost":{"type":"object","properties":{"physicalHostId":{"type":"string","description":"<para type=\"description\">The ID of a physical host where desktop VMs will be created.</para>","nullable":true},"physicalHostName":{"type":"string","description":"<para type=\"description\">The name of a physical host where desktop VMs will be created.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template Advanced Physical Host settings</para>\r\n<para type=\"description\">Available to VDI/RDS Templates VCenter</para>"},"TemplateAdvancedMultipleNIC":{"type":"object","properties":{"useSeperateNetworkInterface":{"type":"boolean","description":"<para type=\"description\">Use a separate network interface for LAN access.</para>"},"address":{"type":"string","description":"<para type=\"description\">The address of the network interface.</para>","nullable":true},"subnetMask":{"type":"string","description":"<para type=\"description\">The subnet mask of the network interface.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template Multiple NIC settings</para>\r\n<para type=\"description\">Available to VDI/RDS Templates HyperV/VMWareESXi/VCenter</para>"},"TemplateAdvancedAWS":{"type":"object","properties":{"instanceType":{"type":"string","description":"<para type=\"description\">Instance type.</para>","nullable":true},"storageDevices":{"type":"array","items":{"$ref":"#/components/schemas/StorageDevice"},"description":"<para type=\"description\">Storage devices.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template Advanced AWS settings</para>\r\n<para type=\"description\">Available to VDI/RDS Templates AWD Templates</para>"},"StorageDevice":{"type":"object","properties":{"deviceName":{"type":"string","description":"<para type=\"description\">Device name.</para>","nullable":true},"volumeType":{"$ref":"#/components/schemas/VolumeType"},"size":{"type":"integer","description":"<para type=\"description\">Size (GiB).</para>","format":"int64"},"maximumIOPS":{"type":"integer","description":"<para type=\"description\">Maximum IOPS.</para>","format":"int64","nullable":true},"throughput":{"type":"integer","description":"<para type=\"description\">Throughput (MB/s).</para>","format":"int64","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template Advanced AWS Storage Device settings</para>\r\n<para type=\"description\"></para>"},"VolumeType":{"enum":[["0 = gp2","1 = gp3","2 = io1","3 = io2","4 = standard"]],"type":"string","description":"<para type=\"synopsis\">Volume type</para>\r\n<para type=\"description\"></para>","format":"int32"},"TemplateAdvancedAzure":{"type":"object","properties":{"resourceGroup":{"type":"string","description":"<para type=\"description\">Resource group.</para>","nullable":true},"location":{"type":"string","description":"<para type=\"description\">Location.</para>","nullable":true},"vmSize":{"type":"string","description":"<para type=\"description\">VM size.</para>","nullable":true},"osDiskType":{"$ref":"#/components/schemas/DiskType"},"virtualNetworkID":{"type":"string","description":"<para type=\"description\">Virtual network ID.</para>","nullable":true},"virtualNetworkName":{"type":"string","description":"<para type=\"description\">Virtual network name.</para>","nullable":true},"subnet":{"$ref":"#/components/schemas/Subnet"}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template Advanced Azure settings</para>\r\n<para type=\"description\">Available to VDI/RDS Templates Azure and AVD Templates</para>"},"DiskType":{"enum":[["1 = StandardHDD","2 = StandardSSD","4 = PremiumSSD"]],"type":"string","description":"<para type=\"synopsis\">Volume type</para>\r\n<para type=\"description\"></para>","format":"int32"},"Subnet":{"type":"object","properties":{"subnetID":{"type":"string","description":"<para type=\"description\">Subnet ID.</para>","nullable":true},"subnetName":{"type":"string","description":"<para type=\"description\">Subnet name.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template Advanced Azure SubNet settings</para>\r\n<para type=\"description\"></para>"},"TemplatePreparation":{"type":"object","properties":{"imagePrepTool":{"$ref":"#/components/schemas/ImagePrepTool"},"computerName":{"type":"string","description":"<para type=\"description\">The FQDN or IP address of the target VM.</para>","nullable":true},"ownerName":{"type":"string","description":"<para type=\"description\">A desktop VM owner name (assigned to a VM by RASprep or Sysprep).</para>","nullable":true},"organization":{"type":"string","description":"<para type=\"description\">Organization name (assigned to a VM by RASprep or Sysprep).</para>","nullable":true},"administrator":{"type":"string","description":"<para type=\"description\">The administrator of the domain specified in the JoinDomain parameter.</para>","nullable":true},"domain":{"type":"string","description":"<para type=\"description\">Domain or WorkGroup to join (assigned to a VM by RASprep or Sysprep).</para>","nullable":true},"domainOrgUnit":{"type":"string","description":"<para type=\"description\">Domain Organization unit</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template Preparation settings</para>\r\n<para type=\"description\"></para>"},"ImagePrepTool":{"enum":[["0 = SysPrep","1 = RASPrep"]],"type":"string","description":"<para type=\"synopsis\">Image preparation tool</para>\r\n<para type=\"description\"></para>","format":"int32"},"TemplateLicense":{"type":"object","properties":{"licenseKeyType":{"$ref":"#/components/schemas/LicenseKeyType"},"keys":{"type":"array","items":{"$ref":"#/components/schemas/TemplateLicenseKey"},"description":"<para type=\"description\">List of template license keys.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Template License Keys</para>\r\n<para type=\"description\">Available to VDI/RDS Templates</para>"},"LicenseKeyType":{"enum":[["0 = KMS","1 = MAK"]],"type":"string","description":"<para type=\"synopsis\">License Key Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"TemplateLicenseKey":{"type":"object","properties":{"licenseKey":{"type":"string","description":"<para type=\"description\">The license key.</para>","nullable":true},"keyLimit":{"type":"integer","description":"<para type=\"description\">The max limit for the license key.</para>","format":"int32"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Key</para>\r\n<para type=\"description\"></para>"},"TemplateDistribution":{"type":"object","properties":{"datastoreSource":{"$ref":"#/components/schemas/DatastoreSourceType"},"datastoreIDs":{"type":"array","items":{"type":"string"},"description":"<para type=\"description\">Datastore IDs.</para>","nullable":true}},"additionalProperties":false,"description":"<para type=\"synopsis\">Template Distribution Settings</para>\r\n<para type=\"description\"></para>"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Delete

> Delete a published application from a site.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/PubItems/{id}/Apps/VDI":{"delete":{"tags":["3-Publishing/Applications//VDI"],"summary":"Delete","description":"Delete a published application from a site.","operationId":"c0a8fb49-bbb3-48e9-b7a3-3efa38cf93e9","parameters":[{"name":"id","in":"path","description":"ID of the published VDI application to be deleted","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```