host_pools

Creates, updates, deletes, gets or lists a host_pools resource.

Overview

Name	host_pools
Type	Resource
Id	azure.desktop_virtualization.host_pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
agentUpdate	object	The session host configuration for updating agent, monitoring agent, and stack component.
appAttachPackageReferences	array	List of App Attach Package links.
applicationGroupReferences	array	List of applicationGroup links.
cloudPcResource	boolean	Is cloud pc resource.
customRdpProperty	string	Custom rdp property of HostPool.
description	string	Description of HostPool.
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.
friendlyName	string	Friendly name of HostPool.
hostPoolType	string	HostPool type for desktop. Required. Known values are: "Personal", "Pooled", and "BYODesktop".
identity	object	:vartype identity: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetIdentity
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.
loadBalancerType	string	The type of the load balancer. Required. Known values are: "BreadthFirst", "DepthFirst", and "Persistent".
location	string	The geo-location where the resource lives. Required.
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.
maxSessionLimit	integer	The max session limit of HostPool.
objectId	string	ObjectId of HostPool. (internal use).
personalDesktopAssignmentType	string	PersonalDesktopAssignment type for HostPool. Known values are: "Automatic" and "Direct".
plan	object	:vartype plan: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetPlan
preferredAppGroupType	string	The type of preferred application group type, default to Desktop Application Group. Required. Known values are: "None", "Desktop", and "RailApplications".
privateEndpointConnections	array	List of private endpoint connection associated with the specified resource.
publicNetworkAccess	string	Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints. Known values are: "Enabled", "Disabled", "EnabledForSessionHostsOnly", and "EnabledForClientsOnly".
registrationInfo	object	The registration info of HostPool.
ring	integer	The ring number of HostPool.
sku	object	:vartype sku: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetSku
ssoClientId	string	ClientId for the registered Relying Party used to issue WVD SSO certificates.
ssoClientSecretKeyVaultPath	string	Path to Azure KeyVault storing the secret used for communication to ADFS.
ssoSecretType	string	The type of single sign on Secret Type. Known values are: "SharedKey", "Certificate", "SharedKeyInKeyVault", and "CertificateInKeyVault".
ssoadfsAuthority	string	URL to customer ADFS server for signing WVD SSO certificates.
startVMOnConnect	boolean	The flag to turn on/off StartVMOnConnect feature.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationEnvironment	boolean	Is validation environment.
vmTemplate	string	VM template for sessionhosts configuration within hostpool.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
agentUpdate	object	The session host configuration for updating agent, monitoring agent, and stack component.
appAttachPackageReferences	array	List of App Attach Package links.
applicationGroupReferences	array	List of applicationGroup links.
cloudPcResource	boolean	Is cloud pc resource.
customRdpProperty	string	Custom rdp property of HostPool.
description	string	Description of HostPool.
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.
friendlyName	string	Friendly name of HostPool.
hostPoolType	string	HostPool type for desktop. Required. Known values are: "Personal", "Pooled", and "BYODesktop".
identity	object	:vartype identity: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetIdentity
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.
loadBalancerType	string	The type of the load balancer. Required. Known values are: "BreadthFirst", "DepthFirst", and "Persistent".
location	string	The geo-location where the resource lives. Required.
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.
maxSessionLimit	integer	The max session limit of HostPool.
objectId	string	ObjectId of HostPool. (internal use).
personalDesktopAssignmentType	string	PersonalDesktopAssignment type for HostPool. Known values are: "Automatic" and "Direct".
plan	object	:vartype plan: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetPlan
preferredAppGroupType	string	The type of preferred application group type, default to Desktop Application Group. Required. Known values are: "None", "Desktop", and "RailApplications".
privateEndpointConnections	array	List of private endpoint connection associated with the specified resource.
publicNetworkAccess	string	Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints. Known values are: "Enabled", "Disabled", "EnabledForSessionHostsOnly", and "EnabledForClientsOnly".
registrationInfo	object	The registration info of HostPool.
ring	integer	The ring number of HostPool.
sku	object	:vartype sku: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetSku
ssoClientId	string	ClientId for the registered Relying Party used to issue WVD SSO certificates.
ssoClientSecretKeyVaultPath	string	Path to Azure KeyVault storing the secret used for communication to ADFS.
ssoSecretType	string	The type of single sign on Secret Type. Known values are: "SharedKey", "Certificate", "SharedKeyInKeyVault", and "CertificateInKeyVault".
ssoadfsAuthority	string	URL to customer ADFS server for signing WVD SSO certificates.
startVMOnConnect	boolean	The flag to turn on/off StartVMOnConnect feature.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationEnvironment	boolean	Is validation environment.
vmTemplate	string	VM template for sessionhosts configuration within hostpool.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
agentUpdate	object	The session host configuration for updating agent, monitoring agent, and stack component.
appAttachPackageReferences	array	List of App Attach Package links.
applicationGroupReferences	array	List of applicationGroup links.
cloudPcResource	boolean	Is cloud pc resource.
customRdpProperty	string	Custom rdp property of HostPool.
description	string	Description of HostPool.
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.
friendlyName	string	Friendly name of HostPool.
hostPoolType	string	HostPool type for desktop. Required. Known values are: "Personal", "Pooled", and "BYODesktop".
identity	object	:vartype identity: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetIdentity
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.
loadBalancerType	string	The type of the load balancer. Required. Known values are: "BreadthFirst", "DepthFirst", and "Persistent".
location	string	The geo-location where the resource lives. Required.
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.
maxSessionLimit	integer	The max session limit of HostPool.
objectId	string	ObjectId of HostPool. (internal use).
personalDesktopAssignmentType	string	PersonalDesktopAssignment type for HostPool. Known values are: "Automatic" and "Direct".
plan	object	:vartype plan: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetPlan
preferredAppGroupType	string	The type of preferred application group type, default to Desktop Application Group. Required. Known values are: "None", "Desktop", and "RailApplications".
privateEndpointConnections	array	List of private endpoint connection associated with the specified resource.
publicNetworkAccess	string	Enabled allows this resource to be accessed from both public and private networks, Disabled allows this resource to only be accessed via private endpoints. Known values are: "Enabled", "Disabled", "EnabledForSessionHostsOnly", and "EnabledForClientsOnly".
registrationInfo	object	The registration info of HostPool.
ring	integer	The ring number of HostPool.
sku	object	:vartype sku: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetSku
ssoClientId	string	ClientId for the registered Relying Party used to issue WVD SSO certificates.
ssoClientSecretKeyVaultPath	string	Path to Azure KeyVault storing the secret used for communication to ADFS.
ssoSecretType	string	The type of single sign on Secret Type. Known values are: "SharedKey", "Certificate", "SharedKeyInKeyVault", and "CertificateInKeyVault".
ssoadfsAuthority	string	URL to customer ADFS server for signing WVD SSO certificates.
startVMOnConnect	boolean	The flag to turn on/off StartVMOnConnect feature.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
validationEnvironment	boolean	Is validation environment.
vmTemplate	string	VM template for sessionhosts configuration within hostpool.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, host_pool_name, subscription_id		Get a host pool.
list_by_resource_group	select	resource_group_name, subscription_id	pageSize, isDescending, initialSkip	List hostPools.
list	select	subscription_id	pageSize, isDescending, initialSkip	List hostPools in subscription.
create_or_update	insert	resource_group_name, host_pool_name, subscription_id, location, properties		Create or update a host pool.
update	update	resource_group_name, host_pool_name, subscription_id		Update a host pool.
create_or_update	replace	resource_group_name, host_pool_name, subscription_id, location, properties		Create or update a host pool.
delete	delete	resource_group_name, host_pool_name, subscription_id	force	Remove a host pool.
list_registration_tokens	exec	resource_group_name, host_pool_name, subscription_id		Operation to list the RegistrationTokens associated with the HostPool.
retrieve_registration_token	exec	resource_group_name, host_pool_name, subscription_id		Registration token of the host pool.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
host_pool_name	string	The name of the host pool within the specified resource group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
force	boolean	Force flag to delete sessionHost. Default value is None.
initialSkip	integer	Initial number of items to skip. Default value is None.
isDescending	boolean	Indicates whether the collection is descending. Default value is None.
pageSize	integer	Number of items per page. Default value is None.

SELECT examples

get

Get a host pool.

SELECT
id,
name,
agentUpdate,
appAttachPackageReferences,
applicationGroupReferences,
cloudPcResource,
customRdpProperty,
description,
etag,
friendlyName,
hostPoolType,
identity,
kind,
loadBalancerType,
location,
managedBy,
maxSessionLimit,
objectId,
personalDesktopAssignmentType,
plan,
preferredAppGroupType,
privateEndpointConnections,
publicNetworkAccess,
registrationInfo,
ring,
sku,
ssoClientId,
ssoClientSecretKeyVaultPath,
ssoSecretType,
ssoadfsAuthority,
startVMOnConnect,
systemData,
tags,
type,
validationEnvironment,
vmTemplate
FROM azure.desktop_virtualization.host_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND host_pool_name = '{{ host_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List hostPools.

SELECT
id,
name,
agentUpdate,
appAttachPackageReferences,
applicationGroupReferences,
cloudPcResource,
customRdpProperty,
description,
etag,
friendlyName,
hostPoolType,
identity,
kind,
loadBalancerType,
location,
managedBy,
maxSessionLimit,
objectId,
personalDesktopAssignmentType,
plan,
preferredAppGroupType,
privateEndpointConnections,
publicNetworkAccess,
registrationInfo,
ring,
sku,
ssoClientId,
ssoClientSecretKeyVaultPath,
ssoSecretType,
ssoadfsAuthority,
startVMOnConnect,
systemData,
tags,
type,
validationEnvironment,
vmTemplate
FROM azure.desktop_virtualization.host_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

list

List hostPools in subscription.

SELECT
id,
name,
agentUpdate,
appAttachPackageReferences,
applicationGroupReferences,
cloudPcResource,
customRdpProperty,
description,
etag,
friendlyName,
hostPoolType,
identity,
kind,
loadBalancerType,
location,
managedBy,
maxSessionLimit,
objectId,
personalDesktopAssignmentType,
plan,
preferredAppGroupType,
privateEndpointConnections,
publicNetworkAccess,
registrationInfo,
ring,
sku,
ssoClientId,
ssoClientSecretKeyVaultPath,
ssoSecretType,
ssoadfsAuthority,
startVMOnConnect,
systemData,
tags,
type,
validationEnvironment,
vmTemplate
FROM azure.desktop_virtualization.host_pools
WHERE subscription_id = '{{ subscription_id }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

INSERT examples

create_or_update

Create or update a host pool.

INSERT INTO azure.desktop_virtualization.host_pools (
tags,
location,
managedBy,
kind,
identity,
sku,
plan,
properties,
resource_group_name,
host_pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ managedBy }}',
'{{ kind }}',
'{{ identity }}',
'{{ sku }}',
'{{ plan }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ host_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: host_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the host_pools resource.
  - name: host_pool_name
    value: "{{ host_pool_name }}"
    description: Required parameter for the host_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the host_pools resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: managedBy
    value: "{{ managedBy }}"
    description: |
      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: kind
    value: "{{ kind }}"
    description: |
      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.
  - name: identity
    description: |
      :vartype identity: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetIdentity
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
  - name: sku
    description: |
      :vartype sku: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetSku
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}
  - name: plan
    description: |
      :vartype plan: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetPlan
    value:
      name: "{{ name }}"
      publisher: "{{ publisher }}"
      product: "{{ product }}"
      promotionCode: "{{ promotionCode }}"
      version: "{{ version }}"
  - name: properties
    value:
      friendlyName: "{{ friendlyName }}"
      description: "{{ description }}"
      hostPoolType: "{{ hostPoolType }}"
      personalDesktopAssignmentType: "{{ personalDesktopAssignmentType }}"
      customRdpProperty: "{{ customRdpProperty }}"
      maxSessionLimit: {{ maxSessionLimit }}
      loadBalancerType: "{{ loadBalancerType }}"
      ring: {{ ring }}
      validationEnvironment: {{ validationEnvironment }}
      registrationInfo:
        expirationTime: "{{ expirationTime }}"
        token: "{{ token }}"
        registrationTokenOperation: "{{ registrationTokenOperation }}"
      vmTemplate: "{{ vmTemplate }}"
      ssoadfsAuthority: "{{ ssoadfsAuthority }}"
      ssoClientId: "{{ ssoClientId }}"
      ssoClientSecretKeyVaultPath: "{{ ssoClientSecretKeyVaultPath }}"
      ssoSecretType: "{{ ssoSecretType }}"
      preferredAppGroupType: "{{ preferredAppGroupType }}"
      startVMOnConnect: {{ startVMOnConnect }}
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      agentUpdate:
        type: "{{ type }}"
        useSessionHostLocalTime: {{ useSessionHostLocalTime }}
        maintenanceWindowTimeZone: "{{ maintenanceWindowTimeZone }}"
        maintenanceWindows:
          - hour: {{ hour }}
            dayOfWeek: "{{ dayOfWeek }}"

UPDATE examples

update

Update a host pool.

UPDATE azure.desktop_virtualization.host_pools
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND host_pool_name = '{{ host_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a host pool.

REPLACE azure.desktop_virtualization.host_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
managedBy = '{{ managedBy }}',
kind = '{{ kind }}',
identity = '{{ identity }}',
sku = '{{ sku }}',
plan = '{{ plan }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND host_pool_name = '{{ host_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Remove a host pool.

DELETE FROM azure.desktop_virtualization.host_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND host_pool_name = '{{ host_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

list_registration_tokens

Operation to list the RegistrationTokens associated with the HostPool.

EXEC azure.desktop_virtualization.host_pools.list_registration_tokens 
@resource_group_name='{{ resource_group_name }}' --required, 
@host_pool_name='{{ host_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

retrieve_registration_token

Registration token of the host pool.

EXEC azure.desktop_virtualization.host_pools.retrieve_registration_token 
@resource_group_name='{{ resource_group_name }}' --required, 
@host_pool_name='{{ host_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;