VDI
Retrieve a list of all the published VDI applications
Query parameters
SiteIdinteger · int32Optional
Site ID for which to retrieve all the published VDI applications (optional)
NamestringOptional
Filter the result by name (optional)
Responses
200
Success
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
get
GET /api/PubItems/Apps/VDI HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T14:43:12.767Z",
"timeLastMod": "2025-07-07T14:43:12.767Z",
"maintenanceMessages": {
"maintenanceMessage_en_US": "text",
"maintenanceMessage_ja_JP": "text",
"maintenanceMessage_fr_FR": "text",
"maintenanceMessage_es_ES": "text",
"maintenanceMessage_it_IT": "text",
"maintenanceMessage_pt_BR": "text",
"maintenanceMessage_nl_NL": "text",
"maintenanceMessage_zh_TW": "text",
"maintenanceMessage_zh_CN": "text",
"maintenanceMessage_ko_KR": "text",
"maintenanceMessage_de_DE": "text"
},
"inheritMaintenance": true,
"replicateMaintenance": true,
"name": "text",
"type": [
"0 = Any",
"1 = Folder",
"2 = RDSApp",
"3 = RDSDesktop",
"4 = VDIDesktop",
"5 = PCDesktop",
"6 = PCApp",
"7 = VDIApp",
"8 = AVDApp",
"9 = AVDDesktop"
],
"parentId": 1,
"previousId": 1,
"description": "text",
"enabledMode": [
"0 = Disabled",
"1 = Enabled",
"2 = Maintenance"
],
"enabled": true,
"publishToSite": [
1
],
"userFilterEnabled": true,
"allowedUsers": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
],
"clientFilterEnabled": true,
"allowedClients": [
"text"
],
"ipFilterEnabled": true,
"allowedIP4s": [
{
"from": "text",
"to": "text"
}
],
"allowedIP6s": [
{
"from": "text",
"to": "text"
}
],
"macFilterEnabled": true,
"allowedMACs": [
"text"
],
"allowedGateways": [
"text"
],
"osFilterEnabled": true,
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
},
"preferredRoutingEnabled": true,
"preferredRoutes": [
{
"id": 1,
"priority": 1,
"name": "text",
"description": "text",
"enabled": true,
"referenceType": [
"3 = Gateway",
"51 = HALB",
"83 = Custom"
],
"referenceId": 1
}
],
"filter": {
"rules": [
{
"id": 1,
"priority": 1,
"enabled": true,
"name": "text",
"description": "text",
"criteria": {
"securityPrincipals": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
]
},
"gateways": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"gatewayIP": "text"
}
]
},
"oSs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
}
},
"iPs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedIPs": {
"iPv4s": [
{
"from": "text",
"to": "text"
}
],
"iPv6s": [
{
"from": "text",
"to": "text"
}
]
}
},
"hardwareIDs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"hardwareID": "text"
}
]
},
"access": [
"0 = DenyCriteriaWhen",
"1 = AllowCriteriaWhen"
],
"devices": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"client": "text"
}
]
},
"themes": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"ids": [
1
]
}
}
}
],
"default": [
"0 = Deny",
"1 = Allow"
]
},
"startOnLogon": true,
"excludePrelaunch": true,
"inheritShortcutDefaultSettings": true,
"createShortcutOnDesktop": true,
"createShortcutInStartFolder": true,
"startPath": "text",
"createShortcutInStartUpFolder": true,
"replicateShortcutSettings": true,
"winType": [
"0 = Normal",
"1 = Maximized",
"2 = Minimized"
],
"target": "text",
"startIn": "text",
"parameters": "text",
"package": "text",
"packagedApp": "text",
"vdiHostPoolId": 1,
"persistent": true,
"connectTo": [
"0 = AnyGuest"
]
}Add a published VDI application to a site.
Body
Create a new published application from a VDI Desktop
namestring | nullableRequired
Published resource name.
parentIdinteger · int32 | nullableOptional
Parent publishing folder ID.
previousIdinteger · int32 | nullableOptional
Previous published ID.
replicateMaintenanceboolean | nullableOptional
Whether the option 'Replicate Maintenance' is enabled or not.
inheritMaintenanceboolean | nullableOptional
Whether to inherit default Maintenance settings.
enabledboolean | nullableOptionalDeprecated
Enable or disable a published resource.
enabledModestring · enumOptionalPossible values:
Published resource availability modes.
maintenanceMessage_en_USstring | nullableOptional
Maintenance message for the published resource in English.
maintenanceMessage_ja_JPstring | nullableOptional
Maintenance message for the published resource in Japanese.
maintenanceMessage_fr_FRstring | nullableOptional
Maintenance message for the published resource in French.
maintenanceMessage_es_ESstring | nullableOptional
Maintenance message for the published resource in Spanish.
maintenanceMessage_it_ITstring | nullableOptional
Maintenance message for the published resource in Italian.
maintenanceMessage_pt_BRstring | nullableOptional
Maintenance message for the published resource in Portuguese.
maintenanceMessage_de_DEstring | nullableOptional
Maintenance message for the published resource in German.
maintenanceMessage_nl_NLstring | nullableOptional
Maintenance message for the published resource in Dutch.
maintenanceMessage_zh_TWstring | nullableOptional
Maintenance message for the published resource in Chinese (Traditional).
maintenanceMessage_zh_CNstring | nullableOptional
Maintenance message for the published resource in Chinese (Simplified).
maintenanceMessage_ko_KRstring | nullableOptional
Maintenance message for the published resource in Korean.
descriptionstring | nullableOptional
Published resource description.
publishToSiteIdsinteger · int32[] | nullableOptional
An array of Sites IDs to which to publish a resource.
siteIdinteger · int32Optional
Site ID in which to publish the specified Item. If the parameter is omitted, the site ID of the Licensing Server will be used.
ipFilterEnabledboolean | nullableOptionalDeprecated
Enable or disable IP filters.
clientFilterEnabledboolean | nullableOptionalDeprecated
Enable or disable client filters.
macFilterEnabledboolean | nullableOptionalDeprecated
Enable or disable mac filters.
userFilterEnabledboolean | nullableOptionalDeprecated
Enable or disable user filters.
gatewayFilterEnabledboolean | nullableOptionalDeprecated
Enable or disable Secure Gateway filters.
targetstring | nullableOptional
File name and path of a published application executable.
startInstring | nullableOptional
Folder name in which to start a published application.
parametersstring | nullableOptional
Optional parameters to pass to the published application executable.
packagestring | nullableOptional
The MSIX package.
packagedAppstring | nullableOptional
The Application within the MSIX Package.
startOnLogonbooleanOptionalDefault:
Enable or disable the 'Start automatically when user logs on' option.
falsewinTypestring · enumOptionalPossible values:
Published application window type
persistentbooleanOptional
Specifies whether the connection is persistent or not.
connectTostring · enumOptionalPossible values:
VDI Matching Mode.
vdiHostPoolIdinteger · int32 | nullableOptional
Specifies the VDI Host Pool ID from which to publish an application.
vdiTemplateIdinteger · int32 | nullableOptional
Specifies the VDI Template ID from which to publish an application.
Responses
201
Created
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
409
Conflict
application/json; api-version=1.0
post
POST /api/PubItems/Apps/VDI HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 841
{
"name": "text",
"parentId": 1,
"previousId": 1,
"replicateMaintenance": true,
"inheritMaintenance": true,
"enabledMode": [
"0 = Disabled",
"1 = Enabled",
"2 = Maintenance"
],
"maintenanceMessage_en_US": "text",
"maintenanceMessage_ja_JP": "text",
"maintenanceMessage_fr_FR": "text",
"maintenanceMessage_es_ES": "text",
"maintenanceMessage_it_IT": "text",
"maintenanceMessage_pt_BR": "text",
"maintenanceMessage_de_DE": "text",
"maintenanceMessage_nl_NL": "text",
"maintenanceMessage_zh_TW": "text",
"maintenanceMessage_zh_CN": "text",
"maintenanceMessage_ko_KR": "text",
"description": "text",
"publishToSiteIds": [
1
],
"siteId": 1,
"target": "text",
"startIn": "text",
"parameters": "text",
"package": "text",
"packagedApp": "text",
"startOnLogon": false,
"winType": [
"0 = Normal",
"1 = Maximized",
"2 = Minimized"
],
"persistent": true,
"connectTo": [
"0 = AnyGuest"
],
"vdiHostPoolId": 1,
"vdiTemplateId": 1
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T14:43:12.767Z",
"timeLastMod": "2025-07-07T14:43:12.767Z",
"maintenanceMessages": {
"maintenanceMessage_en_US": "text",
"maintenanceMessage_ja_JP": "text",
"maintenanceMessage_fr_FR": "text",
"maintenanceMessage_es_ES": "text",
"maintenanceMessage_it_IT": "text",
"maintenanceMessage_pt_BR": "text",
"maintenanceMessage_nl_NL": "text",
"maintenanceMessage_zh_TW": "text",
"maintenanceMessage_zh_CN": "text",
"maintenanceMessage_ko_KR": "text",
"maintenanceMessage_de_DE": "text"
},
"inheritMaintenance": true,
"replicateMaintenance": true,
"name": "text",
"type": [
"0 = Any",
"1 = Folder",
"2 = RDSApp",
"3 = RDSDesktop",
"4 = VDIDesktop",
"5 = PCDesktop",
"6 = PCApp",
"7 = VDIApp",
"8 = AVDApp",
"9 = AVDDesktop"
],
"parentId": 1,
"previousId": 1,
"description": "text",
"enabledMode": [
"0 = Disabled",
"1 = Enabled",
"2 = Maintenance"
],
"enabled": true,
"publishToSite": [
1
],
"userFilterEnabled": true,
"allowedUsers": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
],
"clientFilterEnabled": true,
"allowedClients": [
"text"
],
"ipFilterEnabled": true,
"allowedIP4s": [
{
"from": "text",
"to": "text"
}
],
"allowedIP6s": [
{
"from": "text",
"to": "text"
}
],
"macFilterEnabled": true,
"allowedMACs": [
"text"
],
"allowedGateways": [
"text"
],
"osFilterEnabled": true,
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
},
"preferredRoutingEnabled": true,
"preferredRoutes": [
{
"id": 1,
"priority": 1,
"name": "text",
"description": "text",
"enabled": true,
"referenceType": [
"3 = Gateway",
"51 = HALB",
"83 = Custom"
],
"referenceId": 1
}
],
"filter": {
"rules": [
{
"id": 1,
"priority": 1,
"enabled": true,
"name": "text",
"description": "text",
"criteria": {
"securityPrincipals": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
]
},
"gateways": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"gatewayIP": "text"
}
]
},
"oSs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
}
},
"iPs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedIPs": {
"iPv4s": [
{
"from": "text",
"to": "text"
}
],
"iPv6s": [
{
"from": "text",
"to": "text"
}
]
}
},
"hardwareIDs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"hardwareID": "text"
}
]
},
"access": [
"0 = DenyCriteriaWhen",
"1 = AllowCriteriaWhen"
],
"devices": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"client": "text"
}
]
},
"themes": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"ids": [
1
]
}
}
}
],
"default": [
"0 = Deny",
"1 = Allow"
]
},
"startOnLogon": true,
"excludePrelaunch": true,
"inheritShortcutDefaultSettings": true,
"createShortcutOnDesktop": true,
"createShortcutInStartFolder": true,
"startPath": "text",
"createShortcutInStartUpFolder": true,
"replicateShortcutSettings": true,
"winType": [
"0 = Normal",
"1 = Maximized",
"2 = Minimized"
],
"target": "text",
"startIn": "text",
"parameters": "text",
"package": "text",
"packagedApp": "text",
"vdiHostPoolId": 1,
"persistent": true,
"connectTo": [
"0 = AnyGuest"
]
}Retrieve a specified published VDI application
Path parameters
idinteger · int32Required
ID of the published VDI application to be retrieved
Responses
200
Success
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
get
GET /api/PubItems/{id}/Apps/VDI HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T14:43:12.767Z",
"timeLastMod": "2025-07-07T14:43:12.767Z",
"maintenanceMessages": {
"maintenanceMessage_en_US": "text",
"maintenanceMessage_ja_JP": "text",
"maintenanceMessage_fr_FR": "text",
"maintenanceMessage_es_ES": "text",
"maintenanceMessage_it_IT": "text",
"maintenanceMessage_pt_BR": "text",
"maintenanceMessage_nl_NL": "text",
"maintenanceMessage_zh_TW": "text",
"maintenanceMessage_zh_CN": "text",
"maintenanceMessage_ko_KR": "text",
"maintenanceMessage_de_DE": "text"
},
"inheritMaintenance": true,
"replicateMaintenance": true,
"name": "text",
"type": [
"0 = Any",
"1 = Folder",
"2 = RDSApp",
"3 = RDSDesktop",
"4 = VDIDesktop",
"5 = PCDesktop",
"6 = PCApp",
"7 = VDIApp",
"8 = AVDApp",
"9 = AVDDesktop"
],
"parentId": 1,
"previousId": 1,
"description": "text",
"enabledMode": [
"0 = Disabled",
"1 = Enabled",
"2 = Maintenance"
],
"enabled": true,
"publishToSite": [
1
],
"userFilterEnabled": true,
"allowedUsers": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
],
"clientFilterEnabled": true,
"allowedClients": [
"text"
],
"ipFilterEnabled": true,
"allowedIP4s": [
{
"from": "text",
"to": "text"
}
],
"allowedIP6s": [
{
"from": "text",
"to": "text"
}
],
"macFilterEnabled": true,
"allowedMACs": [
"text"
],
"allowedGateways": [
"text"
],
"osFilterEnabled": true,
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
},
"preferredRoutingEnabled": true,
"preferredRoutes": [
{
"id": 1,
"priority": 1,
"name": "text",
"description": "text",
"enabled": true,
"referenceType": [
"3 = Gateway",
"51 = HALB",
"83 = Custom"
],
"referenceId": 1
}
],
"filter": {
"rules": [
{
"id": 1,
"priority": 1,
"enabled": true,
"name": "text",
"description": "text",
"criteria": {
"securityPrincipals": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
]
},
"gateways": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"gatewayIP": "text"
}
]
},
"oSs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedOSes": {
"chrome": true,
"android": true,
"webClient": true,
"iOS": true,
"linux": true,
"mac": true,
"wyse": true,
"windows": true
}
},
"iPs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"allowedIPs": {
"iPv4s": [
{
"from": "text",
"to": "text"
}
],
"iPv6s": [
{
"from": "text",
"to": "text"
}
]
}
},
"hardwareIDs": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"hardwareID": "text"
}
]
},
"access": [
"0 = DenyCriteriaWhen",
"1 = AllowCriteriaWhen"
],
"devices": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"members": [
{
"client": "text"
}
]
},
"themes": {
"enabled": true,
"matchingMode": [
"0 = IsNotOneOfTheFollowing",
"1 = IsOneOfTheFollowing"
],
"ids": [
1
]
}
}
}
],
"default": [
"0 = Deny",
"1 = Allow"
]
},
"startOnLogon": true,
"excludePrelaunch": true,
"inheritShortcutDefaultSettings": true,
"createShortcutOnDesktop": true,
"createShortcutInStartFolder": true,
"startPath": "text",
"createShortcutInStartUpFolder": true,
"replicateShortcutSettings": true,
"winType": [
"0 = Normal",
"1 = Maximized",
"2 = Minimized"
],
"target": "text",
"startIn": "text",
"parameters": "text",
"package": "text",
"packagedApp": "text",
"vdiHostPoolId": 1,
"persistent": true,
"connectTo": [
"0 = AnyGuest"
]
}Modify properties of a published VDI application.
Path parameters
idinteger · int32Required
ID of the published VDI application to be updated
Body
Update settings of an application published from VDI Desktop
namestring | nullableOptional
A new name to assign to the published resource.
replicateMaintenanceboolean | nullableOptional
Replicate Maintenance
inheritMaintenanceboolean | nullableOptional
Inherit Maintenance
enabledboolean | nullableOptionalDeprecated
Enable or disable a published resource.
enabledModestring · enumOptionalPossible values:
Published resource availability modes.
maintenanceMessage_en_USstring | nullableOptional
Maintenance message for the published resource in English.
maintenanceMessage_ja_JPstring | nullableOptional
Maintenance message for the published resource in Japanese.
maintenanceMessage_fr_FRstring | nullableOptional
Maintenance message for the published resource in French.
maintenanceMessage_es_ESstring | nullableOptional
Maintenance message for the published resource in Spanish.
maintenanceMessage_it_ITstring | nullableOptional
Maintenance message for the published resource in Italian.
maintenanceMessage_pt_BRstring | nullableOptional
Maintenance message for the published resource in Portuguese.
maintenanceMessage_nl_NLstring | nullableOptional
Maintenance message for the published resource in Dutch.
maintenanceMessage_de_DEstring | nullableOptional
Maintenance message for the published resource in German.
maintenanceMessage_zh_TWstring | nullableOptional
Maintenance message for the published resource in Chinese (Traditional).
maintenanceMessage_zh_CNstring | nullableOptional
Maintenance message for the published resource in Chinese (Simplified).
maintenanceMessage_ko_KRstring | nullableOptional
Maintenance message for the published resource in Korean.
descriptionstring | nullableOptional
Published resource description.
publishToSiteIdsinteger · int32[] | nullableOptional
An array of sites to which to publish a resource.
ipFilterEnabledboolean | nullableOptionalDeprecated
Enable or disable IP filters.
clientFilterEnabledboolean | nullableOptionalDeprecated
Enable or disable client filters.
macFilterEnabledboolean | nullableOptionalDeprecated
Enable or disable mac filters.
userFilterEnabledboolean | nullableOptionalDeprecated
Enable or disable user filters.
gatewayFilterEnabledboolean | nullableOptionalDeprecated
Enable or disable Secure Gateway filters.
osFilterEnabledboolean | nullableOptionalDeprecated
Enable or disable the OS filter.
allowClientChromeboolean | nullableOptionalDeprecated
Allow or not Chrome OS Clients.
allowClientAndroidboolean | nullableOptionalDeprecated
Allow or not Android Clients.
allowClientWebboolean | nullableOptionalDeprecated
Allow or not Web Clients.
allowClientIOSboolean | nullableOptionalDeprecated
Allow or not IOS Clients.
allowClientLinuxboolean | nullableOptionalDeprecated
Allow or not Linux Clients.
allowClientMACboolean | nullableOptionalDeprecated
Allow or not MAC Clients.
allowClientWindowsboolean | nullableOptionalDeprecated
Allow or not Windows Clients.
allowClientWyseboolean | nullableOptionalDeprecated
Allow or not Wyse Clients.
preferredRoutingEnabledboolean | nullableOptional
Enable or disable Preferred Routing.
replicateShortcutSettingsboolean | nullableOptional
Replicate shortcut settings to all sites.
createShortcutOnDesktopboolean | nullableOptional
Create a shortcut on a client's desktop.
createShortcutInStartFolderboolean | nullableOptional
Create a shortcut in the client's Start folder.
createShortcutInStartUpFolderboolean | nullableOptional
Create a shortcut in the client's Auto Start folder.
startPathstring | nullableOptional
Specifies the path in the Start folder where the shortcut will be created.
inheritShortcutDefaultSettingsboolean | nullableOptional
Inherit default shortcut settings.
startOnLogonboolean | nullableOptional
Start a resource automatically when a user logs on.
excludePrelaunchboolean | nullableOptional
Exclude application from prelaunch.
targetstring | nullableOptional
File name and path of a published application executable.
startInstring | nullableOptional
Folder name in which to start a published application.
parametersstring | nullableOptional
Optional parameters to pass to the published application executable.
packagestring | nullableOptional
The MSIX Package.
packagedAppstring | nullableOptional
The application within the MSIX package.
winTypestring · enumOptionalPossible values:
Published application window type
persistentboolean | nullableOptional
Specifies whether the connection is persistent or not.
connectTostring · enumOptionalPossible values:
VDI Matching Mode.
vdiHostPoolIdinteger · int32 | nullableOptional
Specifies the VDI Host Pool from which to publish an application.
Responses
204
No Content
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
put
PUT /api/PubItems/{id}/Apps/VDI HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 19959
{
"name": "text",
"replicateMaintenance": true,
"inheritMaintenance": true,
"enabledMode": [
"0 = Disabled",
"1 = Enabled",
"2 = Maintenance"
],
"maintenanceMessage_en_US": "text",
"maintenanceMessage_ja_JP": "text",
"maintenanceMessage_fr_FR": "text",
"maintenanceMessage_es_ES": "text",
"maintenanceMessage_it_IT": "text",
"maintenanceMessage_pt_BR": "text",
"maintenanceMessage_nl_NL": "text",
"maintenanceMessage_de_DE": "text",
"maintenanceMessage_zh_TW": "text",
"maintenanceMessage_zh_CN": "text",
"maintenanceMessage_ko_KR": "text",
"description": "text",
"publishToSiteIds": [
1
],
"preferredRoutingEnabled": true,
"replicateShortcutSettings": true,
"createShortcutOnDesktop": true,
"createShortcutInStartFolder": true,
"createShortcutInStartUpFolder": true,
"startPath": "text",
"inheritShortcutDefaultSettings": true,
"startOnLogon": true,
"excludePrelaunch": true,
"target": "text",
"startIn": "text",
"parameters": "text",
"package": "text",
"packagedApp": "text",
"winType": [
"0 = Normal",
"1 = Maximized",
"2 = Minimized"
],
"persistent": true,
"connectTo": [
"0 = AnyGuest"
],
"vdiHostPoolId": 1,
"vdiHostPool": {
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T14:43:12.767Z",
"timeLastMod": "2025-07-07T14:43:12.767Z",
"name": "text",
"siteId": 1,
"description": "text",
"enabled": true,
"provisioning": {
"hostName": "text",
"defaultPowerState": [
"0 = PoweredOn",
"1 = PoweredOff",
"2 = Suspended"
],
"maxHosts": 1,
"preCreatedHosts": 1,
"duration": 1
},
"members": {
"members": [
{
"id": 1,
"name": "text",
"type": [
"0 = AllHostsInProvider",
"2 = Host",
"3 = NativePool",
"5 = Template",
"7 = TemplateVersion"
],
"providerId": 1
}
],
"wildCard": "text"
},
"template": {
"templateId": 1,
"templateVersionId": 1
},
"inheritDefaultVDIActionSettings": true,
"action": {
"sessionAction": [
"0 = Disconnect",
"1 = Logoff"
],
"performAction": [
"0 = DoNothing",
"2 = Shutdown",
"4 = Suspend",
"7 = Delete",
"8 = Restart",
"9 = Unassign",
"10 = Recreate"
],
"performActionAfterSec": 1
},
"inheritDefaultUserProfileSettings": true,
"userProfile": {
"technology": [
"0 = DoNotManage",
"1 = UPD",
"2 = FSLogix"
],
"fsLogix": {
"profileContainer": {
"enabled": true,
"locationType": [
"0 = SMBLocation",
"1 = CloudCache"
],
"vhdLocations": [
"text"
],
"ccdLocations": [
"text"
],
"profileDiskFormat": [
"0 = VHD",
"1 = VHDX"
],
"allocationType": [
"0 = Dynamic",
"1 = Full"
],
"defaultSize": 1,
"userInclusionList": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
],
"userExclusionList": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
],
"cloudCache": {
"useMaxCacheSizeInMBs": true,
"maxCacheSizeInMBs": 1,
"useClearCacheOnLogoff": true,
"clearCacheOnLogoff": [
"0 = Disable",
"1 = Enable"
],
"useHealthyProvidersRequiredForRegister": true,
"healthyProvidersRequiredForRegister": 1,
"useHealthyProvidersRequiredForUnregister": true,
"healthyProvidersRequiredForUnregister": 1,
"useUnregisterTimeout": true,
"unregisterTimeout": 1,
"useClearCacheOnForcedUnregister": true,
"clearCacheOnForcedUnregister": [
"0 = Disable",
"1 = Enable"
]
},
"customizeProfileFolders": true,
"excludeCommonFolders": [
"1 = Contacts",
"2 = Desktop",
"4 = Documents",
"8 = Links",
"16 = MusicPodcasts",
"32 = PicturesVideos",
"64 = FoldersLowIntegProcesses",
"128 = Downloads"
],
"folderInclusionList": [
"text"
],
"folderExclusionList": [
{
"folder": "text",
"excludeFolderCopy": [
"0 = None",
"1 = CopyBase",
"2 = CopyBack"
]
}
],
"advancedSettings": {
"useLockedRetryCount": true,
"lockedRetryCount": 1,
"useLockedRetryInterval": true,
"lockedRetryInterval": 1,
"useAccessNetworkAsComputerObject": true,
"accessNetworkAsComputerObject": [
"0 = Disable",
"1 = Enable"
],
"useAttachVHDSDDL": true,
"attachVHDSDDL": "text",
"useDiffDiskParentFolderPath": true,
"diffDiskParentFolderPath": "text",
"useFlipFlopProfileDirectoryName": true,
"flipFlopProfileDirectoryName": [
"0 = Disable",
"1 = Enable"
],
"useNoProfileContainingFolder": true,
"noProfileContainingFolder": [
"0 = Disable",
"1 = Enable"
],
"useOutlookCachedMode": true,
"outlookCachedMode": [
"0 = Disable",
"1 = Enable"
],
"usePreventLoginWithFailure": true,
"preventLoginWithFailure": [
"0 = Disable",
"1 = Enable"
],
"usePreventLoginWithTempProfile": true,
"preventLoginWithTempProfile": [
"0 = Disable",
"1 = Enable"
],
"useReAttachRetryCount": true,
"reAttachRetryCount": 1,
"useReAttachIntervalSeconds": true,
"reAttachIntervalSeconds": 1,
"useRemoveOrphanedOSTFilesOnLogoff": true,
"removeOrphanedOSTFilesOnLogoff": [
"0 = Disable",
"1 = Enable"
],
"useRoamSearch": true,
"roamSearch": [
"0 = Disable",
"1 = SingleUser",
"2 = MultiUser"
],
"useSIDDirNameMatch": true,
"sidDirNameMatch": "text",
"useSIDDirNamePattern": true,
"sidDirNamePattern": "text",
"useSIDDirSDDL": true,
"sidDirSDDL": "text",
"useVHDNameMatch": true,
"vhdNameMatch": "text",
"useVHDNamePattern": true,
"vhdNamePattern": "text",
"useVHDXSectorSize": true,
"vhdxSectorSize": [
"0 = SystemDefault",
"512 = Size_512",
"4096 = Size_4096"
],
"useVolumeWaitTimeMS": true,
"volumeWaitTimeMS": 1,
"useIgnoreNonAVD": true,
"ignoreNonAVD": [
"0 = AnySession",
"1 = AVDSessions"
],
"useRedirectType": true,
"redirectType": [
"1 = Legacy",
"2 = Advanced"
],
"useKeepLocalDir": true,
"keepLocalDir": [
"0 = Disable",
"1 = Enable"
],
"useDeleteLocalProfileWhenVHDShouldApply": true,
"deleteLocalProfileWhenVHDShouldApply": [
"0 = Disable",
"1 = Enable"
],
"useProfileDirSDDL": true,
"profileDirSDDL": "text",
"useProfileType": true,
"profileType": [
"0 = NormalProfile",
"1 = OnlyRWProfile",
"2 = OnlyROProfile",
"3 = RWROProfile"
],
"useSetTempToLocalPath": true,
"setTempToLocalPath": [
"0 = TakeNoAction",
"1 = RedirectTempAndTmp",
"2 = RedirectINetCache",
"3 = RedirectTempTmpAndINetCache"
],
"useCleanOutNotifications": true,
"cleanOutNotifications": [
"0 = Disable",
"1 = Enable"
],
"useInstallAppxPackages": true,
"installAppxPackages": [
"0 = Disable",
"1 = Enable"
],
"useRebootOnUserLogoff": true,
"rebootOnUserLogoff": [
"0 = Disable",
"1 = Enable"
],
"useRoamIdentity": true,
"roamIdentity": [
"0 = Disable",
"1 = Enable"
],
"useShutdownOnUserLogoff": true,
"shutdownOnUserLogoff": [
"0 = Disable",
"1 = Enable"
]
}
},
"officeContainer": {
"enabled": true,
"locationType": [
"0 = SMBLocation",
"1 = CloudCache"
],
"vhdLocations": [
"text"
],
"ccdLocations": [
"text"
],
"profileDiskFormat": [
"0 = VHD",
"1 = VHDX"
],
"allocationType": [
"0 = Dynamic",
"1 = Full"
],
"defaultSize": 1,
"userInclusionList": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
],
"userExclusionList": [
{
"account": "text",
"type": [
"1 = User",
"2 = Group",
"3 = ForeignSecurityPrincipal",
"4 = Computer"
],
"sid": "text"
}
],
"cloudCache": {
"useMaxCacheSizeInMBs": true,
"maxCacheSizeInMBs": 1,
"useClearCacheOnLogoff": true,
"clearCacheOnLogoff": [
"0 = Disable",
"1 = Enable"
],
"useHealthyProvidersRequiredForRegister": true,
"healthyProvidersRequiredForRegister": 1,
"useHealthyProvidersRequiredForUnregister": true,
"healthyProvidersRequiredForUnregister": 1,
"useUnregisterTimeout": true,
"unregisterTimeout": 1,
"useClearCacheOnForcedUnregister": true,
"clearCacheOnForcedUnregister": [
"0 = Disable",
"1 = Enable"
]
},
"advancedSettings": {
"useLockedRetryCount": true,
"lockedRetryCount": 1,
"useLockedRetryInterval": true,
"lockedRetryInterval": 1,
"useAccessNetworkAsComputerObject": true,
"accessNetworkAsComputerObject": [
"0 = Disable",
"1 = Enable"
],
"useAttachVHDSDDL": true,
"attachVHDSDDL": "text",
"useDiffDiskParentFolderPath": true,
"diffDiskParentFolderPath": "text",
"useFlipFlopProfileDirectoryName": true,
"flipFlopProfileDirectoryName": [
"0 = Disable",
"1 = Enable"
],
"useNoProfileContainingFolder": true,
"noProfileContainingFolder": [
"0 = Disable",
"1 = Enable"
],
"useOutlookCachedMode": true,
"outlookCachedMode": [
"0 = Disable",
"1 = Enable"
],
"usePreventLoginWithFailure": true,
"preventLoginWithFailure": [
"0 = Disable",
"1 = Enable"
],
"usePreventLoginWithTempProfile": true,
"preventLoginWithTempProfile": [
"0 = Disable",
"1 = Enable"
],
"useReAttachRetryCount": true,
"reAttachRetryCount": 1,
"useReAttachIntervalSeconds": true,
"reAttachIntervalSeconds": 1,
"useRemoveOrphanedOSTFilesOnLogoff": true,
"removeOrphanedOSTFilesOnLogoff": [
"0 = Disable",
"1 = Enable"
],
"useRoamSearch": true,
"roamSearch": [
"0 = Disable",
"1 = SingleUser",
"2 = MultiUser"
],
"useSIDDirNameMatch": true,
"sidDirNameMatch": "text",
"useSIDDirNamePattern": true,
"sidDirNamePattern": "text",
"useSIDDirSDDL": true,
"sidDirSDDL": "text",
"useVHDNameMatch": true,
"vhdNameMatch": "text",
"useVHDNamePattern": true,
"vhdNamePattern": "text",
"useVHDXSectorSize": true,
"vhdxSectorSize": [
"0 = SystemDefault",
"512 = Size_512",
"4096 = Size_4096"
],
"useVolumeWaitTimeMS": true,
"volumeWaitTimeMS": 1,
"useIgnoreNonAVD": true,
"ignoreNonAVD": [
"0 = AnySession",
"1 = AVDSessions"
],
"useRedirectType": true,
"redirectType": [
"1 = Legacy",
"2 = Advanced"
],
"useIncludeOfficeActivation": true,
"includeOfficeActivation": [
"0 = Disable",
"1 = Enable"
],
"useIncludeOneDrive": true,
"includeOneDrive": [
"0 = Disable",
"1 = Enable"
],
"useIncludeOneNote": true,
"includeOneNote": [
"0 = Disable",
"1 = Enable"
],
"useIncludeOneNoteUWP": true,
"includeOneNoteUWP": [
"0 = Disable",
"1 = Enable"
],
"useIncludeOutlook": true,
"includeOutlook": [
"0 = Disable",
"1 = Enable"
],
"useIncludeOutlookPersonalization": true,
"includeOutlookPersonalization": [
"0 = Disable",
"1 = Enable"
],
"useIncludeSharepoint": true,
"includeSharepoint": [
"0 = Disable",
"1 = Enable"
],
"useIncludeSkype": true,
"includeSkype": [
"0 = Disable",
"1 = Enable"
],
"useIncludeTeams": true,
"includeTeams": [
"0 = Disable",
"1 = Enable"
],
"useMirrorLocalOSTToVHD": true,
"mirrorLocalOSTToVHD": [
"0 = DoNothing",
"1 = Copy",
"2 = Move"
],
"useNumSessionVHDsToKeep": true,
"numSessionVHDsToKeep": 1,
"useOutlookFolderPath": true,
"outlookFolderPath": "text",
"useRefreshUserPolicy": true,
"refreshUserPolicy": [
"0 = Disable",
"1 = Enable"
],
"useVHDAccessMode": true,
"vhdAccessMode": [
"0 = NormalDirectAccess",
"1 = DiffDiskNetwork",
"2 = DiffDiskLocal",
"3 = UniqueVHDPerSession"
]
}
},
"generalSettings": {
"appServices": {
"useCleanupInvalidSessions": true,
"cleanupInvalidSessions": [
"0 = Disable",
"1 = Enable"
],
"useRoamRecycleBin": true,
"roamRecycleBin": [
"0 = Disable",
"1 = Enable"
],
"useVHDCompactDisk": true,
"vhdCompactDisk": [
"0 = Disable",
"1 = Enable"
]
},
"cloudCacheGeneral": {
"useCacheDirectory": true,
"cacheDirectory": "text",
"useWriteCacheDirectory": true,
"writeCacheDirectory": "text",
"useProxyDirectory": true,
"proxyDirectory": "text",
"useSilenceACLWarning": true,
"silenceACLWarning": [
"0 = Disable",
"1 = Enable"
]
},
"logging": {
"logEnabled": [
"0 = Disable",
"1 = Specific",
"2 = All"
],
"logLevel": [
"0 = Debug",
"1 = Information",
"2 = Warning",
"3 = Error"
],
"logFileKeepingPeriod": 1,
"logDirectory": "text",
"robocopyLogPath": "text",
"logSpecificComponents": [
"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"
]
}
}
}
},
"inheritDefaultAppPackageSettings": true,
"appPackagesAssigned": {
"applicationPackagesAssigned": [
{
"version": "text",
"tagName": "text",
"tagId": 1,
"packageName": "text"
}
]
},
"inheritDefaultOptimizationSettings": true,
"optimization": {
"enableOptimization": true,
"optimizationType": [
"0 = Automatic",
"1 = Manual"
],
"windowsDefenderATP": {
"winDefATPTurnOffOn": [
"0 = TurnOffWindowsDefenderATP",
"1 = TurnOnWindowsDefenderATP"
],
"disableRealTimeProtection": true,
"excludeFolders": [
"text"
],
"excludeProcesses": [
"text"
],
"excludeExtension": [
"text"
]
},
"windowsComponents": {
"windowsComponentsList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"componentName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsDefenderATPEnabled": true,
"windowsComponentsEnabled": true,
"windowsServicesEnabled": true,
"windowsScheduledTasksEnabled": true,
"windowsAdvancedOptionsEnabled": true,
"networkPerformanceEnabled": true,
"registryEnabled": true,
"visualEffectsEnabled": true,
"diskCleanupEnabled": true,
"customScriptEnabled": true,
"windowsServices": {
"windowsServicesList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"serviceName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsAdvancedOptions": {
"partialStartLayoutContent": "text",
"hibernate": true,
"teleCollection": true,
"systemRestore": true,
"additionalErrorReport": true,
"tiles": true,
"cortana": true,
"microsoftConsumerExperience": true,
"windowsTips": true,
"commonProgramGroups": true,
"partialStartMenu": true
},
"networkPerformance": {
"dirCacheMax": 1,
"dormantFileLimit": 1,
"fileNotFoundCache": 1,
"fileInfoCache": 1,
"fileInfoCacheEnable": true,
"directoryCacheEnable": true,
"fileNotFoundCacheEnable": true,
"dormantFileLimitEnable": true,
"disableTCP": true,
"disableIPv6CompEnable": true,
"disableIPv6ToIPv4": true,
"disableIsaTap": true
},
"customScript": {
"arguments": "text",
"command": "text",
"initDir": "text",
"user": "text"
},
"diskCleanup": {
"cleanupWinSxSFolder": true,
"cleanupSystemFiles": true,
"cleanupTemporaryFileLogs": true,
"removeOneDrive": true,
"deleteUserProfiles": true
},
"visualEffects": {
"visualEffectsTypes": [
"0 = LetWindowsChooseWhatsBest",
"1 = AdjustForBestAppearance",
"2 = AdjustForBestPerformance",
"3 = Custom"
],
"animateControlSelectElements": true,
"animateWindowsWhenMinimizingMaximizing": true,
"animateTaskbar": true,
"enablePeek": true,
"fadeSlideMenus": true,
"fadeSlideToolTips": true,
"fadeOutMenuItems": true,
"saveTaskbarThumbnail": true,
"showShadowUnderMouse": true,
"shadowUnderWindows": true,
"thumbnailsInsteadOfIcons": true,
"showTranslucentSelection": true,
"showWindowsContentWhilstDragging": true,
"slideOpenComboBoxes": true,
"smoothEdgesScreenFonts": true,
"smoothScrollListBoxes": true,
"dropShadowsIcon": true
},
"windowsScheduledTasks": {
"windowsScheduledTasksList": [
{
"task": "text",
"location": "text",
"type": [
"0 = Folder",
"1 = Task"
]
}
]
},
"registry": {
"registryList": [
{
"id": 1,
"action": [
"0 = Add",
"1 = Modify",
"2 = Delete"
],
"registryName": "text",
"dwordValue": 1,
"displayName": "text",
"hiveType": [
"0 = HKEY_CURRENT_CONFIG",
"1 = HKEY_USERS",
"2 = HKEY_LOCAL_MACHINE",
"3 = HKEY_CLASSES_ROOT"
],
"path": "text",
"regType": [
"0 = REG_SZ",
"1 = REG_DWORD",
"2 = REG_QWORD",
"3 = REG_MULTI_SZ",
"4 = REG_EXPAND_SZ"
],
"stringValue": "text"
}
]
},
"uwpApps": {
"allExcept": [
"text"
],
"followingPkgs": [
"text"
],
"removeType": [
"0 = AllExcept",
"1 = FollowingPkgs"
]
}
},
"inheritDefaultAgentSettings": true,
"agent": {
"disconnectActiveSessionAfter": 1,
"logoffDisconnectedSessionAfter": 1,
"sessionReadinessTimeout": 1,
"allowURLAndMailRedirection": [
"0 = Disabled",
"1 = Enabled",
"2 = EnabledWithAppRegistration"
],
"supportShellURLNamespaceObjects": true,
"dragAndDropMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"allowRemoteExec": true,
"manageRDPTransportProtocol": [
"0 = Disabled",
"1 = BothUDPTCP",
"2 = OnlyTCP",
"3 = EitherUDPTCP"
],
"fileTransferMode": [
"0 = Disabled",
"1 = ClientToServer",
"2 = ServerToClient",
"3 = Bidirectional"
],
"fileTransferLocation": "text",
"fileTransferLockLocation": true,
"enableDriveRedirectionCache": true
},
"inheritDefaultRDPPrinterSettings": true,
"rdpPrinter": {
"printerNameFormat": [
"0 = PrnFormat_PRN_CMP_SES",
"1 = PrnFormat_SES_CMP_PRN",
"2 = PrnFormat_PRN_REDSES"
],
"removeSessionNumberFromPrinterName": true,
"removeClientNameFromPrinterName": true
},
"inheritDefaultVDISecuritySettings": true,
"security": {
"isUsersGrantedRDPermissions": true,
"groupType": [
"1 = Administrators",
"2 = RemoteDesktopUsers"
]
},
"inheritDefaultAutoUpgradeSettings": true,
"autoUpgrade": {
"enabled": true,
"startDateTime": "2025-07-07T14:43:12.767Z",
"drainModeDurationInSecs": 1,
"forceLogoffSessions": true,
"repeat": [
"0 = Never",
"1 = EveryDay",
"2 = EveryWeek",
"3 = Every2Weeks",
"4 = EveryMonth",
"5 = EveryYear",
"6 = SpecificDays"
],
"specificDays": [
"0 = Never",
"1 = Sunday",
"2 = Monday",
"4 = Tuesday",
"8 = Wednesday",
"16 = Thursday",
"32 = Friday",
"64 = Saturday"
],
"messages": [
{
"id": 1,
"enabled": true,
"messageTitle": "text",
"message": "text",
"sendMsgSecs": 1,
"sendMsgWhen": [
"0 = Before",
"1 = After"
]
}
]
}
},
"vdiTemplate": {
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-07-07T14:43:12.767Z",
"timeLastMod": "2025-07-07T14:43:12.767Z",
"objType": [
"89 = AVDTemplate",
"101 = RDSTemplate",
"102 = VDITemplate"
],
"name": "text",
"siteId": 1,
"description": "text",
"providerId": 1,
"templateType": [
"0 = SingleSession",
"1 = MultiSession"
],
"vmId": "text",
"cloneMethod": [
"0 = FullClone",
"1 = LinkedClone"
],
"advanced": {
"folder": {
"folderName": "text",
"folderId": "text",
"subFolderName": "text"
},
"nativePool": {
"nativePoolId": "text",
"nativePoolName": "text",
"hwgpu": true
},
"physicalHost": {
"physicalHostId": "text",
"physicalHostName": "text"
},
"multipleNIC": {
"useSeperateNetworkInterface": true,
"address": "text",
"subnetMask": "text"
},
"aws": {
"instanceType": "text",
"storageDevices": [
{
"deviceName": "text",
"volumeType": [
"0 = gp2",
"1 = gp3",
"2 = io1",
"3 = io2",
"4 = standard"
],
"size": 1,
"maximumIOPS": 1,
"throughput": 1
}
]
},
"azure": {
"resourceGroup": "text",
"location": "text",
"vmSize": "text",
"osDiskType": [
"1 = StandardHDD",
"2 = StandardSSD",
"4 = PremiumSSD"
],
"virtualNetworkID": "text",
"virtualNetworkName": "text",
"subnet": {
"subnetID": "text",
"subnetName": "text"
}
}
},
"preparation": {
"imagePrepTool": [
"0 = SysPrep",
"1 = RASPrep"
],
"computerName": "text",
"ownerName": "text",
"organization": "text",
"administrator": "text",
"domain": "text",
"domainOrgUnit": "text"
},
"inheritDefaultOptimizationSettings": true,
"optimization": {
"enableOptimization": true,
"optimizationType": [
"0 = Automatic",
"1 = Manual"
],
"windowsDefenderATP": {
"winDefATPTurnOffOn": [
"0 = TurnOffWindowsDefenderATP",
"1 = TurnOnWindowsDefenderATP"
],
"disableRealTimeProtection": true,
"excludeFolders": [
"text"
],
"excludeProcesses": [
"text"
],
"excludeExtension": [
"text"
]
},
"windowsComponents": {
"windowsComponentsList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"componentName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsDefenderATPEnabled": true,
"windowsComponentsEnabled": true,
"windowsServicesEnabled": true,
"windowsScheduledTasksEnabled": true,
"windowsAdvancedOptionsEnabled": true,
"networkPerformanceEnabled": true,
"registryEnabled": true,
"visualEffectsEnabled": true,
"diskCleanupEnabled": true,
"customScriptEnabled": true,
"windowsServices": {
"windowsServicesList": [
{
"type": [
"0 = Predefined",
"1 = Custom"
],
"serviceName": "text",
"displayName": "text",
"aliases": "text"
}
]
},
"windowsAdvancedOptions": {
"partialStartLayoutContent": "text",
"hibernate": true,
"teleCollection": true,
"systemRestore": true,
"additionalErrorReport": true,
"tiles": true,
"cortana": true,
"microsoftConsumerExperience": true,
"windowsTips": true,
"commonProgramGroups": true,
"partialStartMenu": true
},
"networkPerformance": {
"dirCacheMax": 1,
"dormantFileLimit": 1,
"fileNotFoundCache": 1,
"fileInfoCache": 1,
"fileInfoCacheEnable": true,
"directoryCacheEnable": true,
"fileNotFoundCacheEnable": true,
"dormantFileLimitEnable": true,
"disableTCP": true,
"disableIPv6CompEnable": true,
"disableIPv6ToIPv4": true,
"disableIsaTap": true
},
"customScript": {
"arguments": "text",
"command": "text",
"initDir": "text",
"user": "text"
},
"diskCleanup": {
"cleanupWinSxSFolder": true,
"cleanupSystemFiles": true,
"cleanupTemporaryFileLogs": true,
"removeOneDrive": true,
"deleteUserProfiles": true
},
"visualEffects": {
"visualEffectsTypes": [
"0 = LetWindowsChooseWhatsBest",
"1 = AdjustForBestAppearance",
"2 = AdjustForBestPerformance",
"3 = Custom"
],
"animateControlSelectElements": true,
"animateWindowsWhenMinimizingMaximizing": true,
"animateTaskbar": true,
"enablePeek": true,
"fadeSlideMenus": true,
"fadeSlideToolTips": true,
"fadeOutMenuItems": true,
"saveTaskbarThumbnail": true,
"showShadowUnderMouse": true,
"shadowUnderWindows": true,
"thumbnailsInsteadOfIcons": true,
"showTranslucentSelection": true,
"showWindowsContentWhilstDragging": true,
"slideOpenComboBoxes": true,
"smoothEdgesScreenFonts": true,
"smoothScrollListBoxes": true,
"dropShadowsIcon": true
},
"windowsScheduledTasks": {
"windowsScheduledTasksList": [
{
"task": "text",
"location": "text",
"type": [
"0 = Folder",
"1 = Task"
]
}
]
},
"registry": {
"registryList": [
{
"id": 1,
"action": [
"0 = Add",
"1 = Modify",
"2 = Delete"
],
"registryName": "text",
"dwordValue": 1,
"displayName": "text",
"hiveType": [
"0 = HKEY_CURRENT_CONFIG",
"1 = HKEY_USERS",
"2 = HKEY_LOCAL_MACHINE",
"3 = HKEY_CLASSES_ROOT"
],
"path": "text",
"regType": [
"0 = REG_SZ",
"1 = REG_DWORD",
"2 = REG_QWORD",
"3 = REG_MULTI_SZ",
"4 = REG_EXPAND_SZ"
],
"stringValue": "text"
}
]
},
"uwpApps": {
"allExcept": [
"text"
],
"followingPkgs": [
"text"
],
"removeType": [
"0 = AllExcept",
"1 = FollowingPkgs"
]
}
},
"licenseKeys": {
"licenseKeyType": [
"0 = KMS",
"1 = MAK"
],
"keys": [
{
"licenseKey": "text",
"keyLimit": 1
}
]
}
}
}No content
Delete a published application from a site.
Path parameters
idinteger · int32Required
ID of the published VDI application to be deleted
Responses
204
No Content
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
delete
DELETE /api/PubItems/{id}/Apps/VDI HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?