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

vw_host_pools

Name	Datatype	Description
description	text	field from the properties object
agent_update	text	field from the properties object
app_attach_package_references	text	field from the properties object
application_group_references	text	field from the properties object
cloud_pc_resource	text	field from the properties object
custom_rdp_property	text	field from the properties object
direct_udp	text	field from the properties object
etag	text	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.
friendly_name	text	field from the properties object
hostPoolName	text	field from the properties object
host_pool_type	text	field from the properties object
identity	text	Identity for the resource.
kind	text	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.
load_balancer_type	text	field from the properties object
managed_by	text	field from the properties object
managed_private_udp	text	field from the properties object
management_type	text	field from the properties object
max_session_limit	text	field from the properties object
object_id	text	field from the properties object
personal_desktop_assignment_type	text	field from the properties object
plan	text	Plan for the resource.
preferred_app_group_type	text	field from the properties object
private_endpoint_connections	text	field from the properties object
public_network_access	text	field from the properties object
public_udp	text	field from the properties object
registration_info	text	field from the properties object
relay_udp	text	field from the properties object
resourceGroupName	text	field from the properties object
ring	text	field from the properties object
sku	text	The resource model definition representing SKU
sso_client_id	text	field from the properties object
sso_client_secret_key_vault_path	text	field from the properties object
sso_secret_type	text	field from the properties object
ssoadfs_authority	text	field from the properties object
start_vm_on_connect	text	field from the properties object
subscriptionId	text	field from the properties object
validation_environment	text	field from the properties object
vm_template	text	field from the properties object

host_pools

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.
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	Properties of HostPool.
sku	object	The resource model definition representing SKU

Methods

Name	Accessible by	Required Params	Description
get	SELECT	hostPoolName, resourceGroupName, subscriptionId	Get a host pool.
list	SELECT	subscriptionId	List hostPools in subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	List hostPools.
create_or_update	INSERT	hostPoolName, resourceGroupName, subscriptionId, data__properties	Create or update a host pool.
delete	DELETE	hostPoolName, resourceGroupName, subscriptionId	Remove a host pool.
update	UPDATE	hostPoolName, resourceGroupName, subscriptionId	Update a host pool.
retrieve_registration_token	EXEC	hostPoolName, resourceGroupName, subscriptionId	Registration token of the host pool.

SELECT examples

List hostPools in subscription.

vw_host_pools

SELECT
description,
agent_update,
app_attach_package_references,
application_group_references,
cloud_pc_resource,
custom_rdp_property,
direct_udp,
etag,
friendly_name,
hostPoolName,
host_pool_type,
identity,
kind,
load_balancer_type,
managed_by,
managed_private_udp,
management_type,
max_session_limit,
object_id,
personal_desktop_assignment_type,
plan,
preferred_app_group_type,
private_endpoint_connections,
public_network_access,
public_udp,
registration_info,
relay_udp,
resourceGroupName,
ring,
sku,
sso_client_id,
sso_client_secret_key_vault_path,
sso_secret_type,
ssoadfs_authority,
start_vm_on_connect,
subscriptionId,
validation_environment,
vm_template
FROM azure.desktop_virtualization.vw_host_pools
WHERE subscriptionId = '{{ subscriptionId }}';

host_pools

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

INSERT example

Use the following StackQL query and manifest file to create a new host_pools resource.

All Properties

/*+ create */
INSERT INTO azure.desktop_virtualization.host_pools (
hostPoolName,
resourceGroupName,
subscriptionId,
data__properties,
managedBy,
kind,
identity,
sku,
plan,
properties
)
SELECT 
'{{ hostPoolName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ managedBy }}',
'{{ kind }}',
'{{ identity }}',
'{{ sku }}',
'{{ plan }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: managedBy
      value: string
    - name: kind
      value: string
    - name: etag
      value: string
    - name: identity
      value: string
    - name: sku
      value: string
    - name: plan
      value: string
    - name: properties
      value:
        - name: objectId
          value: string
        - name: friendlyName
          value: string
        - name: description
          value: string
        - name: hostPoolType
          value: string
        - name: personalDesktopAssignmentType
          value: string
        - name: customRdpProperty
          value: string
        - name: maxSessionLimit
          value: integer
        - name: loadBalancerType
          value: string
        - name: ring
          value: integer
        - name: validationEnvironment
          value: boolean
        - name: registrationInfo
          value:
            - name: expirationTime
              value: string
            - name: token
              value: string
            - name: registrationTokenOperation
              value: string
        - name: vmTemplate
          value: string
        - name: managementType
          value: string
        - name: applicationGroupReferences
          value:
            - string
        - name: appAttachPackageReferences
          value:
            - string
        - name: ssoadfsAuthority
          value: string
        - name: ssoClientId
          value: string
        - name: ssoClientSecretKeyVaultPath
          value: string
        - name: ssoSecretType
          value: string
        - name: preferredAppGroupType
          value: string
        - name: startVMOnConnect
          value: boolean
        - name: cloudPcResource
          value: boolean
        - name: publicNetworkAccess
          value: string
        - name: agentUpdate
          value:
            - name: type
              value: string
            - name: useSessionHostLocalTime
              value: boolean
            - name: maintenanceWindowTimeZone
              value: string
            - name: maintenanceWindows
              value:
                - - name: hour
                    value: integer
                  - name: dayOfWeek
                    value: string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: groupIds
                    value:
                      - string
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: provisioningState
                    value: []
              - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: systemData
                value:
                  - name: createdBy
                    value: string
                  - name: createdByType
                    value: string
                  - name: createdAt
                    value: string
                  - name: lastModifiedBy
                    value: string
                  - name: lastModifiedByType
                    value: string
                  - name: lastModifiedAt
                    value: string
        - name: managedPrivateUDP
          value: string
        - name: directUDP
          value: string
        - name: publicUDP
          value: string
        - name: relayUDP
          value: string

UPDATE example

Updates a host_pools resource.

/*+ update */
UPDATE azure.desktop_virtualization.host_pools
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
hostPoolName = '{{ hostPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified host_pools resource.

/*+ delete */
DELETE FROM azure.desktop_virtualization.host_pools
WHERE hostPoolName = '{{ hostPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';