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

Successfully retrieved user session.

Name	Datatype	Description
id	string (arm-id)	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	Detailed properties for UserSession
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"

list

Successfully retrieved user sessions in session host.

Name	Datatype	Description
id	string (arm-id)	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	Detailed properties for UserSession
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"

list_by_host_pool

Successfully retrieved user sessions in host pool.

Name	Datatype	Description
id	string (arm-id)	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	Detailed properties for UserSession
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"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, hostPoolName, sessionHostName, userSessionId		Get a userSession.
list	select	subscriptionId, resourceGroupName, hostPoolName, sessionHostName	pageSize, isDescending, initialSkip	List userSessions.
list_by_host_pool	select	subscriptionId, resourceGroupName, hostPoolName	$filter, pageSize, isDescending, initialSkip	List userSessions.
delete	delete	subscriptionId, resourceGroupName, hostPoolName, sessionHostName, userSessionId	force	Remove a userSession.
disconnect	exec	subscriptionId, resourceGroupName, hostPoolName, sessionHostName, userSessionId		Disconnect a userSession.
send_message	exec	subscriptionId, resourceGroupName, hostPoolName, sessionHostName, userSessionId		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
hostPoolName	string	The name of the host pool within the specified resource group
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sessionHostName	string	The name of the session host within the specified host pool
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
userSessionId	string	The name of the user session within the specified session host
$filter	string	OData filter expression. Valid properties for filtering are userprincipalname and sessionstate.
force	boolean	Force flag to login off userSession.
initialSkip	integer (int32)	Initial number of items to skip.
isDescending	boolean	Indicates whether the collection is descending.
pageSize	integer (int32)	Number of items per page.

SELECT examples

get

Get a userSession.

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

list

List userSessions.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.desktop_virtualization.user_sessions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND hostPoolName = '{{ hostPoolName }}' -- required
AND sessionHostName = '{{ sessionHostName }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

list_by_host_pool

List userSessions.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.desktop_virtualization.user_sessions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND hostPoolName = '{{ hostPoolName }}' -- 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 subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND hostPoolName = '{{ hostPoolName }}' --required
AND sessionHostName = '{{ sessionHostName }}' --required
AND userSessionId = '{{ userSessionId }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

disconnect

Disconnect a userSession.

EXEC azure.desktop_virtualization.user_sessions.disconnect 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@hostPoolName='{{ hostPoolName }}' --required, 
@sessionHostName='{{ sessionHostName }}' --required, 
@userSessionId='{{ userSessionId }}' --required
;

send_message

Send a message to a user.

EXEC azure.desktop_virtualization.user_sessions.send_message 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@hostPoolName='{{ hostPoolName }}' --required, 
@sessionHostName='{{ sessionHostName }}' --required, 
@userSessionId='{{ userSessionId }}' --required 
@@json=
'{
"messageTitle": "{{ messageTitle }}", 
"messageBody": "{{ messageBody }}"
}'
;