user_sessions

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

Overview

Name	user_sessions
Type	Resource
Id	azure.desktop_virtualization.user_sessions

Fields

vw_user_sessions

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
active_directory_user_name	text	field from the properties object
application_type	text	field from the properties object
create_time	text	field from the properties object
hostPoolName	text	field from the properties object
object_id	text	field from the properties object
resourceGroupName	text	field from the properties object
sessionHostName	text	field from the properties object
session_state	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"
userSessionId	text	field from the properties object
user_principal_name	text	field from the properties object

user_sessions

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 UserSession 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, userSessionId	Get a userSession.
list	SELECT	hostPoolName, resourceGroupName, sessionHostName, subscriptionId	List userSessions.
list_by_host_pool	SELECT	hostPoolName, resourceGroupName, subscriptionId	List userSessions.
delete	DELETE	hostPoolName, resourceGroupName, sessionHostName, subscriptionId, userSessionId	Remove a userSession.
disconnect	EXEC	hostPoolName, resourceGroupName, sessionHostName, subscriptionId, userSessionId	Disconnect a userSession.
send_message	EXEC	hostPoolName, resourceGroupName, sessionHostName, subscriptionId, userSessionId	Send a message to a user.

SELECT examples

List userSessions.

vw_user_sessions

SELECT
id,
name,
active_directory_user_name,
application_type,
create_time,
hostPoolName,
object_id,
resourceGroupName,
sessionHostName,
session_state,
subscriptionId,
system_data,
type,
userSessionId,
user_principal_name
FROM azure.desktop_virtualization.vw_user_sessions
WHERE hostPoolName = '{{ hostPoolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

user_sessions

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

DELETE example

Deletes the specified user_sessions resource.

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