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

Successfully retrieved host pool.

Name	Datatype	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.
identity	object	Identity for the resource.
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. (pattern: ^[-\w._,()]+$)
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.
plan	object	Plan for the resource.
properties	object	Detailed properties for HostPool
sku	object	The resource model definition representing SKU

list_by_resource_group

Successfully retrieved host pool in resource group.

Name	Datatype	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.
identity	object	Identity for the resource.
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. (pattern: ^[-\w._,()]+$)
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.
plan	object	Plan for the resource.
properties	object	Detailed properties for HostPool
sku	object	The resource model definition representing SKU

list

Successfully retrieved host pool in subscription.

Name	Datatype	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.
identity	object	Identity for the resource.
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. (pattern: ^[-\w._,()]+$)
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.
plan	object	Plan for the resource.
properties	object	Detailed properties for HostPool
sku	object	The resource model definition representing SKU

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, hostPoolName		Get a host pool.
list_by_resource_group	select	subscriptionId, resourceGroupName	pageSize, isDescending, initialSkip	List hostPools.
list	select	subscriptionId	pageSize, isDescending, initialSkip	List hostPools in subscription.
create_or_update	insert	subscriptionId, resourceGroupName, hostPoolName, data__properties		Create or update a host pool.
update	update	subscriptionId, resourceGroupName, hostPoolName		Update a host pool.
delete	delete	subscriptionId, resourceGroupName, hostPoolName	force	Remove a host pool.
retrieve_registration_token	exec	subscriptionId, resourceGroupName, hostPoolName		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
hostPoolName	string	The name of the host pool within the specified resource group
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
force	boolean	Force flag to delete sessionHost.
initialSkip	integer (int32)	Initial number of items to skip.
isDescending	boolean	Indicates whether the collection is descending.
pageSize	integer (int32)	Number of items per page.

SELECT examples

get

Get a host pool.

SELECT
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.desktop_virtualization.host_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND hostPoolName = '{{ hostPoolName }}' -- required
;

list_by_resource_group

List hostPools.

SELECT
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.desktop_virtualization.host_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

list

List hostPools in subscription.

SELECT
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.desktop_virtualization.host_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- 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 (
data__managedBy,
data__kind,
data__identity,
data__sku,
data__plan,
data__properties,
subscriptionId,
resourceGroupName,
hostPoolName
)
SELECT 
'{{ managedBy }}',
'{{ kind }}',
'{{ identity }}',
'{{ sku }}',
'{{ plan }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ hostPoolName }}'
RETURNING
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
;

Manifest

# Description fields are for documentation purposes
- name: host_pools
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the host_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the host_pools resource.
    - name: hostPoolName
      value: string
      description: Required parameter for the host_pools resource.
    - name: managedBy
      value: string
      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: string
      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
      value: object
      description: |
        Identity for the resource.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: plan
      value: object
      description: |
        Plan for the resource.
    - name: properties
      value: object
      description: |
        Detailed properties for HostPool

UPDATE examples

update

Update a host pool.

UPDATE azure.desktop_virtualization.host_pools
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND hostPoolName = '{{ hostPoolName }}' --required
RETURNING
etag,
identity,
kind,
managedBy,
plan,
properties,
sku;

DELETE examples

delete

Remove a host pool.

DELETE FROM azure.desktop_virtualization.host_pools
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND hostPoolName = '{{ hostPoolName }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

retrieve_registration_token

Registration token of the host pool.

EXEC azure.desktop_virtualization.host_pools.retrieve_registration_token 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@hostPoolName='{{ hostPoolName }}' --required
;