Host Pools - Get

Get a host pool.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}?api-version=2021-01-14-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=2021-01-14-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": {
    "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
    "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"
    },
    "vmTemplate": "{json:json}",
    "ssoadfsAuthority": "https://adfs",
    "ssoClientId": "client",
    "ssoClientSecretKeyVaultPath": "https://keyvault/secret",
    "ssoSecretType": "SharedKey",
    "preferredAppGroupType": "Desktop",
    "startVMOnConnect": false,
    "cloudPcResource": false
  }
}

Definitions

CloudError
CloudErrorProperties
HostPool

Represents a HostPool definition.

HostPoolType

HostPool type for desktop.

Identity
LoadBalancerType

The type of the load balancer.

MigrationRequestProperties

Properties for arm migration.

Operation

The type of operation for migration.

PersonalDesktopAssignmentType

PersonalDesktopAssignment type for HostPool.

Plan
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.

ResourceIdentityType

The identity type.

Sku
SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SSOSecretType

The type of single sign on Secret Type.

CloudError

Name Type Description
error

CloudErrorProperties

Name Type Description
code
  • string

Error code

message
  • string

Error message indicating why the operation failed.

HostPool

Represents a HostPool definition.

Name Type Description
etag
  • string

The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.

id
  • string

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

identity
kind
  • string

Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.

location
  • string

The geo-location where the resource lives

managedBy
  • string

The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.

name
  • string

The name of the resource

plan
properties.applicationGroupReferences
  • string[]

List of applicationGroup links.

properties.cloudPcResource
  • boolean

Is cloud pc resource.

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.migrationRequest

The registration info of HostPool.

properties.objectId
  • string

ObjectId of HostPool. (internal use)

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.ssoClientId
  • string

ClientId for the registered Relying Party used to issue WVD SSO certificates.

properties.ssoClientSecretKeyVaultPath
  • string

Path to Azure KeyVault storing the secret used for communication to ADFS.

properties.ssoSecretType

The type of single sign on Secret Type.

properties.ssoadfsAuthority
  • string

URL to customer ADFS server for signing WVD SSO certificates.

properties.startVMOnConnect
  • boolean

The flag to turn on/off StartVMOnConnect feature.

properties.validationEnvironment
  • boolean

Is validation environment.

properties.vmTemplate
  • string

VM template for sessionhosts configuration within hostpool.

sku
tags
  • object

Resource tags.

type
  • string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

HostPoolType

HostPool type for desktop.

Name Type Description
BYODesktop
  • string

Users assign their own machines, load balancing logic remains the same as Personal. PersonalDesktopAssignmentType must be Direct.

Personal
  • string

Users will be assigned a SessionHost either by administrators (PersonalDesktopAssignmentType = Direct) or upon connecting to the pool (PersonalDesktopAssignmentType = Automatic). They will always be redirected to their assigned SessionHost.

Pooled
  • string

Users get a new (random) SessionHost every time it connects to the HostPool.

Identity

Name Type Description
principalId
  • string

The principal ID of resource identity.

tenantId
  • string

The tenant ID of resource.

type

The identity type.

LoadBalancerType

The type of the load balancer.

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

MigrationRequestProperties

Properties for arm migration.

Name Type Description
migrationPath
  • string

The path to the legacy object to migrate.

operation

The type of operation for migration.

Operation

The type of operation for migration.

Name Type Description
Complete
  • string

Complete the migration.

Hide
  • string

Hide the hostpool.

Revoke
  • string

Revoke the migration.

Start
  • string

Start the migration.

Unhide
  • string

Unhide the hostpool.

PersonalDesktopAssignmentType

PersonalDesktopAssignment type for HostPool.

Name Type Description
Automatic
  • string
Direct
  • string

Plan

Name Type Description
name
  • string

A user defined name of the 3rd Party Artifact that is being procured.

product
  • string

The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding.

promotionCode
  • string

A publisher provided promotion code as provisioned in Data Market for the said product/artifact.

publisher
  • string

The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic

version
  • string

The version of the desired product/artifact.

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

ResourceIdentityType

The identity type.

Name Type Description
SystemAssigned
  • string

Sku

Name Type Description
capacity
  • integer

If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.

family
  • string

If the service has different generations of hardware, for the same SKU, then that can be captured here.

name
  • string

The name of the SKU. Ex - P3. It is typically a letter+number code

size
  • string

The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.

tier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Name Type Description
Basic
  • string
Free
  • string
Premium
  • string
Standard
  • string

SSOSecretType

The type of single sign on Secret Type.

Name Type Description
Certificate
  • string
CertificateInKeyVault
  • string
SharedKey
  • string
SharedKeyInKeyVault
  • string