session_host_configurations

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

Overview

Name	session_host_configurations
Type	Resource
Id	azure.desktop_virtualization.session_host_configurations

Fields

vw_session_host_configurations

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	text	The name of the resource
availability_zones	text	field from the properties object
boot_diagnostics_info	text	field from the properties object
custom_configuration_script_url	text	field from the properties object
disk_info	text	field from the properties object
domain_info	text	field from the properties object
friendly_name	text	field from the properties object
hostPoolName	text	field from the properties object
image_info	text	field from the properties object
network_info	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
security_info	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
version	text	field from the properties object
vm_admin_credentials	text	field from the properties object
vm_location	text	field from the properties object
vm_name_prefix	text	field from the properties object
vm_resource_group	text	field from the properties object
vm_size_id	text	field from the properties object
vm_tags	text	field from the properties object

session_host_configurations

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Session host configurations of HostPool.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	hostPoolName, resourceGroupName, subscriptionId	Get a SessionHostConfiguration.
list_by_host_pool	SELECT	hostPoolName, resourceGroupName, subscriptionId	List sessionHostConfigurations.
create_or_update	INSERT	hostPoolName, resourceGroupName, subscriptionId, data__properties	Create or update a SessionHostConfiguration.
update	UPDATE	hostPoolName, resourceGroupName, subscriptionId	Update a SessionHostConfiguration.

SELECT examples

Get a SessionHostConfiguration.

vw_session_host_configurations

SELECT
id,
name,
availability_zones,
boot_diagnostics_info,
custom_configuration_script_url,
disk_info,
domain_info,
friendly_name,
hostPoolName,
image_info,
network_info,
provisioning_state,
resourceGroupName,
security_info,
subscriptionId,
system_data,
type,
version,
vm_admin_credentials,
vm_location,
vm_name_prefix,
vm_resource_group,
vm_size_id,
vm_tags
FROM azure.desktop_virtualization.vw_session_host_configurations
WHERE hostPoolName = '{{ hostPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

session_host_configurations

SELECT
id,
name,
properties,
systemData,
type
FROM azure.desktop_virtualization.session_host_configurations
WHERE hostPoolName = '{{ hostPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.desktop_virtualization.session_host_configurations (
hostPoolName,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ hostPoolName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - 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: properties
      value:
        - name: version
          value: string
        - name: friendlyName
          value: string
        - name: provisioningState
          value: string
        - name: vmTags
          value: object
        - name: vmLocation
          value: string
        - name: vmResourceGroup
          value: string
        - name: vmNamePrefix
          value: string
        - name: availabilityZones
          value:
            - integer
        - name: networkInfo
          value:
            - name: subnetId
              value: string
            - name: securityGroupId
              value: string
        - name: vmSizeId
          value: string
        - name: diskInfo
          value:
            - name: type
              value: string
        - name: customConfigurationScriptUrl
          value: string
        - name: imageInfo
          value:
            - name: type
              value: string
            - name: marketplaceInfo
              value:
                - name: offer
                  value: string
                - name: publisher
                  value: string
                - name: sku
                  value: string
                - name: exactVersion
                  value: string
            - name: customInfo
              value:
                - name: resourceId
                  value: string
        - name: domainInfo
          value:
            - name: joinType
              value: string
            - name: activeDirectoryInfo
              value:
                - name: domainCredentials
                  value:
                    - name: usernameKeyVaultSecretUri
                      value: string
                    - name: passwordKeyVaultSecretUri
                      value: string
                - name: ouPath
                  value: string
                - name: domainName
                  value: string
            - name: azureActiveDirectoryInfo
              value:
                - name: mdmProviderGuid
                  value: string
        - name: securityInfo
          value:
            - name: type
              value: string
            - name: secureBootEnabled
              value: boolean
            - name: vTpmEnabled
              value: boolean
        - name: bootDiagnosticsInfo
          value:
            - name: enabled
              value: boolean
            - name: storageUri
              value: string

UPDATE example

Updates a session_host_configurations resource.

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