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

Delete Pool Deprecated

Description

Delete pool record by id

Request

Request

URL

URL

delete
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

Possible values are: FORCEFUL , GRACEFUL

string
org_id Optional

org_id

Authentication

Authentication

This operation uses the following authentication methods.

Bearer

Response

Response

200 OK Response Body>

Response Body

200 OK

Returns Pool of type */* 
{
    "connectionAffinity": "NEAREST_SITE",
    "description": "Pool description",
    "displayName": "NewPool",
    "homesiteMappings": {
        "group-id-1": "site-id-2",
        "user-id-1": "site-id-1"
    },
    "id": "ent-id-12345",
    "location": "US",
    "name": "pg-123",
    "orgId": "0123456789",
    "preferredClientType": "HORIZON_CLIENT",
    "requireHomesite": true,
    "scope": "ALL_SITES",
    "templateType": "MULTI_SESSION",
    "transientLoadThresholdSecs": 10,
    "type": "DESKTOP"
}
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: APP_CAPTURE_STUDIO , DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD

array of Protocol
protocols Required

List of supported desktop protocols
AgentCustomization
agentCustomization Optional
boolean
disabled Optional

If disabled, pool will not recieve any launch request.
string
displayName Optional

Pool’s display name
boolean
enableSSO Optional

Enable SSO on this pool.
map of string
homesiteMappings Optional

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

Pool ID
string
location Optional

Location that is mapped with Org Id
string
description Optional

Pool description
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

string as date-time
createdAt Optional

Time when the pool was created
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
connectionAffinity Optional

Connection Affinity - rule to be used while brokering the pool

Possible values are: HOME_SITE , NEAREST_SITE

array of ApplicationItem
applications Optional

List of applications
integer as int32
transientLoadThresholdSecs Optional

Time spacing (in seconds) between consecutive session placement on a MULTI-SESSIONtemplate VM. This property will be used to load balance session slots among theMULTI-SESSION template VMs. This value should be between 0 to 300
string
transientLoadThresholdSecsStatus Optional

transient load threshold update status

Possible values are: ACTIVE , PARTIAL_SUCCESS , PENDING_ACTIVE

string
agentCustomizationStatus Optional

Agent Customization Status

Possible values are: ACTIVE , PARTIAL_SUCCESS , PENDING_ACTIVE

string as date-time
updatedAt Optional

Time when the pool was updated
202 Accepted Response Body>

Response Body

202 Accepted

Returns Pool of type */*

Accepted the request for graceful/forceful deletion of the pool and Response holds the pool with disable flag true.

{
    "connectionAffinity": "NEAREST_SITE",
    "description": "Pool description",
    "displayName": "NewPool",
    "homesiteMappings": {
        "group-id-1": "site-id-2",
        "user-id-1": "site-id-1"
    },
    "id": "ent-id-12345",
    "location": "US",
    "name": "pg-123",
    "orgId": "0123456789",
    "preferredClientType": "HORIZON_CLIENT",
    "requireHomesite": true,
    "scope": "ALL_SITES",
    "templateType": "MULTI_SESSION",
    "transientLoadThresholdSecs": 10,
    "type": "DESKTOP"
}
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: APP_CAPTURE_STUDIO , DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD

array of Protocol
protocols Required

List of supported desktop protocols
AgentCustomization
agentCustomization Optional
boolean
disabled Optional

If disabled, pool will not recieve any launch request.
string
displayName Optional

Pool’s display name
boolean
enableSSO Optional

Enable SSO on this pool.
map of string
homesiteMappings Optional

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

Pool ID
string
location Optional

Location that is mapped with Org Id
string
description Optional

Pool description
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

string as date-time
createdAt Optional

Time when the pool was created
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
connectionAffinity Optional

Connection Affinity - rule to be used while brokering the pool

Possible values are: HOME_SITE , NEAREST_SITE

array of ApplicationItem
applications Optional

List of applications
integer as int32
transientLoadThresholdSecs Optional

Time spacing (in seconds) between consecutive session placement on a MULTI-SESSIONtemplate VM. This property will be used to load balance session slots among theMULTI-SESSION template VMs. This value should be between 0 to 300
string
transientLoadThresholdSecsStatus Optional

transient load threshold update status

Possible values are: ACTIVE , PARTIAL_SUCCESS , PENDING_ACTIVE

string
agentCustomizationStatus Optional

Agent Customization Status

Possible values are: ACTIVE , PARTIAL_SUCCESS , PENDING_ACTIVE

string as date-time
updatedAt Optional

Time when the pool was updated
204 No Content Response Body>

Response Body

204 No Content

Returns Pool of type */*

Successfully deleted pool record

{
    "connectionAffinity": "NEAREST_SITE",
    "description": "Pool description",
    "displayName": "NewPool",
    "homesiteMappings": {
        "group-id-1": "site-id-2",
        "user-id-1": "site-id-1"
    },
    "id": "ent-id-12345",
    "location": "US",
    "name": "pg-123",
    "orgId": "0123456789",
    "preferredClientType": "HORIZON_CLIENT",
    "requireHomesite": true,
    "scope": "ALL_SITES",
    "templateType": "MULTI_SESSION",
    "transientLoadThresholdSecs": 10,
    "type": "DESKTOP"
}
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: APP_CAPTURE_STUDIO , DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD

array of Protocol
protocols Required

List of supported desktop protocols
AgentCustomization
agentCustomization Optional
boolean
disabled Optional

If disabled, pool will not recieve any launch request.
string
displayName Optional

Pool’s display name
boolean
enableSSO Optional

Enable SSO on this pool.
map of string
homesiteMappings Optional

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

Pool ID
string
location Optional

Location that is mapped with Org Id
string
description Optional

Pool description
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

string as date-time
createdAt Optional

Time when the pool was created
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
connectionAffinity Optional

Connection Affinity - rule to be used while brokering the pool

Possible values are: HOME_SITE , NEAREST_SITE

array of ApplicationItem
applications Optional

List of applications
integer as int32
transientLoadThresholdSecs Optional

Time spacing (in seconds) between consecutive session placement on a MULTI-SESSIONtemplate VM. This property will be used to load balance session slots among theMULTI-SESSION template VMs. This value should be between 0 to 300
string
transientLoadThresholdSecsStatus Optional

transient load threshold update status

Possible values are: ACTIVE , PARTIAL_SUCCESS , PENDING_ACTIVE

string
agentCustomizationStatus Optional

Agent Customization Status

Possible values are: ACTIVE , PARTIAL_SUCCESS , PENDING_ACTIVE

string as date-time
updatedAt Optional

Time when the pool was updated
Errors

Errors

ErrorResponse
401

Unauthorized
ErrorResponse
403

Forbidden
ErrorResponse
404

Not found
Code Samples

Code Samples

cURL Command

curl -X DELETE https://cloud.vmwarehorizon.com/portal/v2/pools/{id}

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

Was this page helpful?

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