Host Pools - Get

Get a host pool.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}?api-version=2019-12-10-preview

URI Parameters

Name In Required Type Description
hostPoolName
path True
  • string

The name of the host pool within the specified resource group

resourceGroupName
path True
  • string

The name of the resource group. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

The ID of the target subscription.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

Successfully retrieved host pool.

Other Status Codes

Automation error response describing why the operation failed.

Examples

HostPool_Get

Sample Request

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1?api-version=2019-12-10-preview

Sample Response

{
  "name": "hostPool1",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1",
  "type": "/Microsoft.DesktopVirtualization/hostPools",
  "location": "centralus",
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "properties": {
    "friendlyName": "friendly",
    "description": "des1",
    "hostPoolType": "Pooled",
    "personalDesktopAssignmentType": "Automatic",
    "customRdpProperty": null,
    "maxSessionLimit": 999999,
    "loadBalancerType": "BreadthFirst",
    "validationEnvironment": null,
    "ring": null,
    "registrationInfo": {
      "expirationTime": "2008-09-22T14:01:54.9571247Z",
      "token": "token",
      "registrationTokenOperation": "Update"
    },
    "ssoContext": "KeyVaultPath",
    "preferredAppGroupType": "Desktop"
  }
}

Definitions

CloudError

Error response of an operation failure

HostPool

Represents a HostPool definition.

HostPoolType

HostPool type for desktop.

LoadBalancerType

The type of the load balancer.

PersonalDesktopAssignmentType

PersonalDesktopAssignment type for HostPool.

PreferredAppGroupType

The type of preferred application group type, default to Desktop Application Group

RegistrationInfo

Represents a RegistrationInfo definition.

RegistrationTokenOperation

The type of resetting the token.

CloudError

Error response of an operation failure

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.

HostPool

Represents a HostPool definition.

Name Type Description
id
  • string

Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location
  • string

The geo-location where the resource lives

name
  • string

The name of the resource

properties.applicationGroupReferences
  • string[]

List of applicationGroup links.

properties.customRdpProperty
  • string

Custom rdp property of HostPool.

properties.description
  • string

Description of HostPool.

properties.friendlyName
  • string

Friendly name of HostPool.

properties.hostPoolType

HostPool type for desktop.

properties.loadBalancerType

The type of the load balancer.

properties.maxSessionLimit
  • integer

The max session limit of HostPool.

properties.personalDesktopAssignmentType

PersonalDesktopAssignment type for HostPool.

properties.preferredAppGroupType

The type of preferred application group type, default to Desktop Application Group

properties.registrationInfo

The registration info of HostPool.

properties.ring
  • integer

The ring number of HostPool.

properties.ssoContext
  • string

Path to keyvault containing ssoContext secret.

properties.validationEnvironment
  • boolean

Is validation environment.

properties.vmTemplate
  • string

VM template for sessionhosts configuration within hostpool.

tags
  • object

Resource tags.

type
  • string

The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

HostPoolType

HostPool type for desktop.

Name Type Description
Personal
  • string
Pooled
  • string

LoadBalancerType

The type of the load balancer.

Name Type Description
BreadthFirst
  • string
DepthFirst
  • string
Persistent
  • string

PersonalDesktopAssignmentType

PersonalDesktopAssignment type for HostPool.

Name Type Description
Automatic
  • string
Direct
  • string

PreferredAppGroupType

The type of preferred application group type, default to Desktop Application Group

Name Type Description
Desktop
  • string
None
  • string
RailApplications
  • string

RegistrationInfo

Represents a RegistrationInfo definition.

Name Type Description
expirationTime
  • string

Expiration time of registration token.

registrationTokenOperation

The type of resetting the token.

token
  • string

The registration token base64 encoded string.

RegistrationTokenOperation

The type of resetting the token.

Name Type Description
Delete
  • string
None
  • string
Update
  • string