session_hosts

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

Overview

Name	session_hosts
Type	Resource
Id	azure.desktop_virtualization.session_hosts

Fields

vw_session_hosts

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
agent_version	text	field from the properties object
allow_new_session	text	field from the properties object
assigned_user	text	field from the properties object
friendly_name	text	field from the properties object
hostPoolName	text	field from the properties object
last_heart_beat	text	field from the properties object
last_session_host_update_time	text	field from the properties object
last_update_time	text	field from the properties object
object_id	text	field from the properties object
os_version	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_id	text	field from the properties object
sessionHostName	text	field from the properties object
session_host_configuration	text	field from the properties object
session_host_health_check_results	text	field from the properties object
sessions	text	field from the properties object
status	text	field from the properties object
status_timestamp	text	field from the properties object
subscriptionId	text	field from the properties object
sx_s_stack_version	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"
update_error_message	text	field from the properties object
update_state	text	field from the properties object
virtual_machine_id	text	field from the properties object

session_hosts

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	Schema for SessionHost properties.
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, sessionHostName, subscriptionId	Get a session host.
list	SELECT	hostPoolName, resourceGroupName, subscriptionId	List sessionHosts.
delete	DELETE	hostPoolName, resourceGroupName, sessionHostName, subscriptionId	Remove a SessionHost.
update	UPDATE	hostPoolName, resourceGroupName, sessionHostName, subscriptionId	Update a session host.
retry_provisioning	EXEC	hostPoolName, resourceGroupName, sessionHostName, subscriptionId	Retry provisioning on a SessionHost.

SELECT examples

List sessionHosts.

vw_session_hosts

SELECT
id,
name,
agent_version,
allow_new_session,
assigned_user,
friendly_name,
hostPoolName,
last_heart_beat,
last_session_host_update_time,
last_update_time,
object_id,
os_version,
resourceGroupName,
resource_id,
sessionHostName,
session_host_configuration,
session_host_health_check_results,
sessions,
status,
status_timestamp,
subscriptionId,
sx_s_stack_version,
system_data,
type,
update_error_message,
update_state,
virtual_machine_id
FROM azure.desktop_virtualization.vw_session_hosts
WHERE hostPoolName = '{{ hostPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

session_hosts

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

UPDATE example

Updates a session_hosts resource.

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

DELETE example

Deletes the specified session_hosts resource.

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