Get Pool
DescriptionGet pool record by id
Request
URLURL
Path Parameters
Path Parameters
id
Query Parameters
Query Parameters
org_id
Authentication
Response
Response BodyResponse Body
200 OK
Successfully retrieved the pool.
{
"connectionAffinity": "NEAREST_SITE",
"description": "Pool description",
"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",
"type": "DESKTOP"
}
Pool name
Pool type
Possible values are: APPLICATION , DESKTOP , DESKTOP_APPLICATION
Template type - templates added to the poolType must match this value
Possible values are: DEDICATED , FLOATING , MULTI_SESSION , RDSH , WVD
Pool ID
Location that is mapped with Org Id
Map to store UsersId or GroupId with their preferred homesite Id
Org ID that owns this poolType
Preferred Client Type
Possible values are: BROWSER , HORIZON_CLIENT
Enable SSO on this pool.
Flag to specify home site restriction is enabled or not
Scope - use first preferred homesite or all preferred home sites
Possible values are: ALL_SITES , WITHIN_SITE
Pool description
Time when the pool was created
Connection Affinity - rule to be used while brokering the pool
Possible values are: HOME_SITE , NEAREST_SITE
Time when the pool was updated
Errors
Code Samples
