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

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
activeDirectoryUserName	string	The active directory user name.
applicationType	string	Application type of application. Known values are: "RemoteApp" and "Desktop".
createTime	string (date-time)	The timestamp of the user session create.
objectId	string	ObjectId of user session. (internal use).
sessionState	string	State of user session. Known values are: "Unknown", "Active", "Disconnected", "Pending", "LogOff", and "UserProfileDiskMounted".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userPrincipalName	string	The user principal name.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
activeDirectoryUserName	string	The active directory user name.
applicationType	string	Application type of application. Known values are: "RemoteApp" and "Desktop".
createTime	string (date-time)	The timestamp of the user session create.
objectId	string	ObjectId of user session. (internal use).
sessionState	string	State of user session. Known values are: "Unknown", "Active", "Disconnected", "Pending", "LogOff", and "UserProfileDiskMounted".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userPrincipalName	string	The user principal name.

list_by_host_pool

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}". # pylint: disable=line-too-long
name	string	The name of the resource.
activeDirectoryUserName	string	The active directory user name.
applicationType	string	Application type of application. Known values are: "RemoteApp" and "Desktop".
createTime	string (date-time)	The timestamp of the user session create.
objectId	string	ObjectId of user session. (internal use).
sessionState	string	State of user session. Known values are: "Unknown", "Active", "Disconnected", "Pending", "LogOff", and "UserProfileDiskMounted".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userPrincipalName	string	The user principal name.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, host_pool_name, session_host_name, user_session_id, subscription_id		Get a userSession.
list	select	resource_group_name, host_pool_name, session_host_name, subscription_id	pageSize, isDescending, initialSkip	List userSessions.
list_by_host_pool	select	resource_group_name, host_pool_name, subscription_id	$filter, pageSize, isDescending, initialSkip	List userSessions.
delete	delete	resource_group_name, host_pool_name, session_host_name, user_session_id, subscription_id	force	Remove a userSession.
disconnect	exec	resource_group_name, host_pool_name, session_host_name, user_session_id, subscription_id		Disconnect a userSession.
send_message	exec	resource_group_name, host_pool_name, session_host_name, user_session_id, subscription_id		Send a message to a user.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
host_pool_name	string	The name of the host pool within the specified resource group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
session_host_name	string	The name of the session host within the specified host pool. Required.
subscription_id	string
user_session_id	string	The name of the user session within the specified session host. Required.
$filter	string	OData filter expression. Valid properties for filtering are userprincipalname and sessionstate. Default value is None.
force	boolean	Force flag to login off userSession. Default value is None.
initialSkip	integer	Initial number of items to skip. Default value is None.
isDescending	boolean	Indicates whether the collection is descending. Default value is None.
pageSize	integer	Number of items per page. Default value is None.

SELECT examples

get

Get a userSession.

SELECT
id,
name,
activeDirectoryUserName,
applicationType,
createTime,
objectId,
sessionState,
systemData,
type,
userPrincipalName
FROM azure.desktop_virtualization.user_sessions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND host_pool_name = '{{ host_pool_name }}' -- required
AND session_host_name = '{{ session_host_name }}' -- required
AND user_session_id = '{{ user_session_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List userSessions.

SELECT
id,
name,
activeDirectoryUserName,
applicationType,
createTime,
objectId,
sessionState,
systemData,
type,
userPrincipalName
FROM azure.desktop_virtualization.user_sessions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND host_pool_name = '{{ host_pool_name }}' -- required
AND session_host_name = '{{ session_host_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

list_by_host_pool

List userSessions.

SELECT
id,
name,
activeDirectoryUserName,
applicationType,
createTime,
objectId,
sessionState,
systemData,
type,
userPrincipalName
FROM azure.desktop_virtualization.user_sessions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND host_pool_name = '{{ host_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

DELETE examples

delete

Remove a userSession.

DELETE FROM azure.desktop_virtualization.user_sessions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND host_pool_name = '{{ host_pool_name }}' --required
AND session_host_name = '{{ session_host_name }}' --required
AND user_session_id = '{{ user_session_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

disconnect

Disconnect a userSession.

EXEC azure.desktop_virtualization.user_sessions.disconnect 
@resource_group_name='{{ resource_group_name }}' --required, 
@host_pool_name='{{ host_pool_name }}' --required, 
@session_host_name='{{ session_host_name }}' --required, 
@user_session_id='{{ user_session_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

send_message

Send a message to a user.

EXEC azure.desktop_virtualization.user_sessions.send_message 
@resource_group_name='{{ resource_group_name }}' --required, 
@host_pool_name='{{ host_pool_name }}' --required, 
@session_host_name='{{ session_host_name }}' --required, 
@user_session_id='{{ user_session_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"messageTitle": "{{ messageTitle }}", 
"messageBody": "{{ messageBody }}"
}'
;