Skip to main content

active_session_host_configurations

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

Overview

Nameactive_session_host_configurations
TypeResource
Idazure.desktop_virtualization.active_session_host_configurations

Fields

NameDatatypeDescription
idtextFully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
nametextThe name of the resource
availability_zonestextfield from the properties object
boot_diagnostics_infotextfield from the properties object
custom_configuration_script_urltextfield from the properties object
disk_infotextfield from the properties object
domain_infotextfield from the properties object
friendly_nametextfield from the properties object
hostPoolNametextfield from the properties object
image_infotextfield from the properties object
network_infotextfield from the properties object
resourceGroupNametextfield from the properties object
security_infotextfield from the properties object
subscriptionIdtextfield from the properties object
system_datatextfield from the properties object
typetextThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
versiontextfield from the properties object
vm_admin_credentialstextfield from the properties object
vm_locationtextfield from the properties object
vm_name_prefixtextfield from the properties object
vm_resource_grouptextfield from the properties object
vm_size_idtextfield from the properties object
vm_tagstextfield from the properties object

Methods

NameAccessible byRequired ParamsDescription
getSELECThostPoolName, resourceGroupName, subscriptionIdGet the ActiveSessionHostConfiguration for the hostPool that is currently being used for update operations.
list_by_host_poolSELECThostPoolName, resourceGroupName, subscriptionIdList activeSessionHostConfigurations.

SELECT examples

Get the ActiveSessionHostConfiguration for the hostPool that is currently being used for update operations.

SELECT
id,
name,
availability_zones,
boot_diagnostics_info,
custom_configuration_script_url,
disk_info,
domain_info,
friendly_name,
hostPoolName,
image_info,
network_info,
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_active_session_host_configurations
WHERE hostPoolName = '{{ hostPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';