VMware Developer Documentation
API Reference PowerCLI Reference
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
Horizon Cloud Service - next-gen Portal Pool

Patch Pool

Description

Update an existing pool record by adding and/or removing users and/or user groups

Request

Request

URL

URL

patch
https://cloud.vmwarehorizon.com/portal/v2/pools/{id}
Copy
Path Parameters

Path Parameters

string
id Required

id

Query Parameters

Query Parameters

boolean
delete Optional

delete
string
disassociateAction Optional

disassociateAction
string
org_id Optional

org_id

Request Body

Request Body

PatchPoolReq of mimetype application/json Required

patchPool

{
	"applicationsToAdd": [
		{
			"displayName": "Google Chrome",
			"icons": {
				"key": {
					"height": 0,
					"iconHash": "string",
					"icondata": "string",
					"path": "string",
					"width": 0
				}
			},
			"id": "string",
			"name": "Chrome",
			"orgId": "0123456789",
			"os": "Windows",
			"path": "c:\\app\\chrome.exe",
			"publisher": "VMware Inc",
			"registeredExtensions": {
				"extensions": [
					{
						"friendlyName": "string",
						"value": "string"
					}
				],
				"otherFileType": [
					{
						"friendlyName": "string",
						"type": "string",
						"value": "string"
					}
				]
			},
			"streamId": "string",
			"templateIds": [
				"string"
			],
			"version": "1.0.0",
			"versionId": "string"
		}
	],
	"applicationsToRemove": [
		{
			"displayName": "Google Chrome",
			"icons": {
				"key": {
					"height": 0,
					"iconHash": "string",
					"icondata": "string",
					"path": "string",
					"width": 0
				}
			},
			"id": "string",
			"name": "Chrome",
			"orgId": "0123456789",
			"os": "Windows",
			"path": "c:\\app\\chrome.exe",
			"publisher": "VMware Inc",
			"registeredExtensions": {
				"extensions": [
					{
						"friendlyName": "string",
						"value": "string"
					}
				],
				"otherFileType": [
					{
						"friendlyName": "string",
						"type": "string",
						"value": "string"
					}
				]
			},
			"streamId": "string",
			"templateIds": [
				"string"
			],
			"version": "1.0.0",
			"versionId": "string"
		}
	],
	"enableSSO": false,
	"powerPolicy": {
		"enabled": false,
		"min": 2,
		"minUnit": "PERCENTAGE",
		"modelVersion": 0,
		"occupancyPresetMode": "BALANCED",
		"powerOffProtectTimeMins": 30,
		"powerSchedules": [
			{
				"allDay": false,
				"endTime": "17:00",
				"min": 5,
				"modelVersion": 0,
				"name": "VmwareWeekdaySchedule",
				"occursOn": 31,
				"startTime": "08:00",
				"timeZone": "Asia/Tokyo"
			}
		]
	},
	"templatesToAdd": [
		[
			{
				"dataCenterId": "datacenter-1",
				"edgeDeploymentId": "string",
				"id": "template-3",
				"location": "string",
				"name": "string",
				"orgId": "string",
				"powerPolicy": {
					"base": "TOTAL",
					"enabled": false,
					"min": 2,
					"minUnit": "PERCENTAGE",
					"occupancyPresetMode": "BALANCED",
					"powerOffProtectTimeMins": 30,
					"powerSchedules": [
						{
							"allDay": false,
							"endTime": "17:00",
							"min": 5,
							"name": "VmwareWeekdaySchedule",
							"occursOn": 31,
							"startTime": "08:00",
							"timeZone": "Asia/Tokyo"
						}
					]
				},
				"templateType": "DEDICATED"
			}
		]
	],
	"templatesToRemove": [
		"template-1 | template-2"
	]
}
array of ApplicationItem
applicationsToAdd Optional

List of applications to be added to the pool
array of ApplicationItem
applicationsToRemove Optional

List of applications to be removed from the pool
boolean
enableSSO Optional

Enable SSO on this pool.
PowerPolicy
powerPolicy Optional

Power policy Spec
array of Template
templatesToAdd Optional

List of templates to be added to the pool
array of string
templatesToRemove Optional

List of templates to be removed from the pool
Authentication

Authentication

This operation uses the following authentication methods.

Bearer

Response

Response

Response Body

Response Body

204 No Content returns Pool of type */*

Pool patched

{
	"applications": [
		{
			"displayName": "Google Chrome",
			"icons": {
				"key": {
					"height": 0,
					"iconHash": "string",
					"icondata": "string",
					"path": "string",
					"width": 0
				}
			},
			"id": "string",
			"name": "Chrome",
			"orgId": "0123456789",
			"os": "Windows",
			"path": "c:\\app\\chrome.exe",
			"publisher": "VMware Inc",
			"registeredExtensions": {
				"extensions": [
					{
						"friendlyName": "string",
						"value": "string"
					}
				],
				"otherFileType": [
					{
						"friendlyName": "string",
						"type": "string",
						"value": "string"
					}
				]
			},
			"streamId": "string",
			"templateIds": [
				"string"
			],
			"version": "1.0.0",
			"versionId": "string"
		}
	],
	"connectionAffinity": "NEAREST_SITE",
	"createdAt": "string",
	"description": "Pool description",
	"enableSSO": false,
	"homesiteMappings": {
		"key": "site-id-1 | site-id-2"
	},
	"id": "ent-id-12345",
	"location": "US",
	"name": "pg-123",
	"orgId": "0123456789",
	"powerPolicy": {
		"enabled": false,
		"min": 2,
		"minUnit": "PERCENTAGE",
		"modelVersion": 0,
		"occupancyPresetMode": "BALANCED",
		"powerOffProtectTimeMins": 30,
		"powerSchedules": [
			{
				"allDay": false,
				"endTime": "17:00",
				"min": 5,
				"modelVersion": 0,
				"name": "VmwareWeekdaySchedule",
				"occursOn": 31,
				"startTime": "08:00",
				"timeZone": "Asia/Tokyo"
			}
		]
	},
	"preferredClientType": "HORIZON_CLIENT",
	"protocols": [
		{
			"defaultProtocol": false,
			"name": "BLAST"
		}
	],
	"reportedCapacity": {
		"consumedVMs": 0,
		"freeSessions": 0,
		"maxVMs": 0,
		"provisionedSessions": 0,
		"provisionedVMs": 0,
		"usedSessions": 0
	},
	"requireHomesite": true,
	"scope": "ALL_SITES",
	"templateType": "MULTI_SESSION",
	"templates": [
		{
			"activeDirectoryId": "string",
			"avAgentInstalled": false,
			"clientAccessLicenseApplicable": false,
			"dataCenterId": "datacenter-1",
			"delete": false,
			"disabled": false,
			"disassociateAction": "FORCEFUL",
			"edgeDeploymentId": "string",
			"id": "template-1",
			"imageReference": {
				"modelVersion": 0,
				"streamId": "string",
				"versionId": "string"
			},
			"location": "string",
			"name": "string",
			"orgId": "string",
			"powerPolicy": {
				"enabled": false,
				"min": 2,
				"minUnit": "PERCENTAGE",
				"modelVersion": 0,
				"occupancyPresetMode": "BALANCED",
				"powerOffProtectTimeMins": 30,
				"powerSchedules": [
					{
						"allDay": false,
						"endTime": "17:00",
						"min": 5,
						"modelVersion": 0,
						"name": "VmwareWeekdaySchedule",
						"occursOn": 31,
						"startTime": "08:00",
						"timeZone": "Asia/Tokyo"
					}
				]
			},
			"providerInstance": {
				"id": "0123456789"
			},
			"templateType": "DEDICATED"
		}
	],
	"type": "DESKTOP",
	"updatedAt": "string"
}
string as ^[a-zA-Z][a-zA-Z0-9\- ]+$
name Required

Pool name
string
type Required

Pool type

Possible values are: APPLICATION , DESKTOP , DESKTOP_APPLICATION

array of Template
templates Required

List of templates
string
templateType Required

Template type - templates added to the poolType must match this value

Possible values are: DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD

array of Protocol
protocols Required

List of supported desktop protocols
array of ApplicationItem
applications Optional

List of applications
string
id Optional

Pool ID
string
location Optional

Location that is mapped with Org Id
map of string
homesiteMappings Optional

Map to store UsersId or GroupId with their preferred homesite Id
string
orgId Optional

Org ID that owns this poolType
PowerPolicy
powerPolicy Optional

Power policy Spec
string
preferredClientType Optional

Preferred Client Type

Possible values are: BROWSER , HORIZON_CLIENT

boolean
enableSSO Optional

Enable SSO on this pool.
ReportedCapacity
reportedCapacity Optional
boolean
requireHomesite Optional

Flag to specify home site restriction is enabled or not
string
scope Optional

Scope - use first preferred homesite or all preferred home sites

Possible values are: ALL_SITES , WITHIN_SITE

string
description Optional

Pool description
string as date-time
createdAt Optional

Time when the pool was created
string
connectionAffinity Optional

Connection Affinity - rule to be used while brokering the pool

Possible values are: HOME_SITE , NEAREST_SITE

string as date-time
updatedAt Optional

Time when the pool was updated
Errors

Errors

ErrorResponse
400

Bad Request
ErrorResponse
401

Unauthorized
ErrorResponse
403

Forbidden
ErrorResponse
404

Not found
ErrorResponse
412

Precondition Failed
Code Samples

Code Samples

cURL Command

curl -X PATCH -H "Content-Type: application/json" -d '{"applicationsToAdd":[{"displayName":"Google Chrome","icons":{"key":{"height":0,"iconHash":"string","icondata":"string","path":"string","width":0}},"id":"string","name":"Chrome","orgId":"0123456789","os":"Windows","path":"c:\\app\\chrome.exe","publisher":"VMware Inc","registeredExtensions":{"extensions":[{"friendlyName":"string","value":"string"}],"otherFileType":[{"friendlyName":"string","type":"string","value":"string"}]},"streamId":"string","templateIds":["string"],"version":"1.0.0","versionId":"string"}],"applicationsToRemove":[{"displayName":"Google Chrome","icons":{"key":{"height":0,"iconHash":"string","icondata":"string","path":"string","width":0}},"id":"string","name":"Chrome","orgId":"0123456789","os":"Windows","path":"c:\\app\\chrome.exe","publisher":"VMware Inc","registeredExtensions":{"extensions":[{"friendlyName":"string","value":"string"}],"otherFileType":[{"friendlyName":"string","type":"string","value":"string"}]},"streamId":"string","templateIds":["string"],"version":"1.0.0","versionId":"string"}],"enableSSO":false,"powerPolicy":{"enabled":false,"min":2,"minUnit":"PERCENTAGE","modelVersion":0,"occupancyPresetMode":"BALANCED","powerOffProtectTimeMins":30,"powerSchedules":[{"allDay":false,"endTime":"17:00","min":5,"modelVersion":0,"name":"VmwareWeekdaySchedule","occursOn":31,"startTime":"08:00","timeZone":"Asia/Tokyo"}]},"templatesToAdd":[[{"dataCenterId":"datacenter-1","edgeDeploymentId":"string","id":"template-3","location":"string","name":"string","orgId":"string","powerPolicy":{"base":"TOTAL","enabled":false,"min":2,"minUnit":"PERCENTAGE","occupancyPresetMode":"BALANCED","powerOffProtectTimeMins":30,"powerSchedules":[{"allDay":false,"endTime":"17:00","min":5,"name":"VmwareWeekdaySchedule","occursOn":31,"startTime":"08:00","timeZone":"Asia/Tokyo"}]},"templateType":"DEDICATED"}]],"templatesToRemove":["template-1 | template-2"]}' https://cloud.vmwarehorizon.com/portal/v2/pools/{id}
 Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: patchPool


Generated on: 12 May 22 14:40 UTC
[{"label":"Latest (V1)","version":"latest"}]
horizon-cloud-nextgen
On This Page
Portal Operations
post
Create
delete
Delete Pool
get
Get Pool
get
Get Pools
get
List All Apps For Pools
get
List VMS With User
patch
Patch Pool
put
Update Pool
Feedback

Was this page helpful?

© 2022 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us