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

The following fields are returned by SELECT queries:

get

Successfully retrieved 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 SessionHost
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 session hosts 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 SessionHost
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		Get a session host.
list	select	subscriptionId, resourceGroupName, hostPoolName	pageSize, isDescending, initialSkip, vmPath	List sessionHosts.
update	update	subscriptionId, resourceGroupName, hostPoolName, sessionHostName	force	Update a session host.
delete	delete	subscriptionId, resourceGroupName, hostPoolName, sessionHostName	force	Remove a SessionHost.
retry_provisioning	exec	subscriptionId, resourceGroupName, hostPoolName, sessionHostName		Retry provisioning on a SessionHost.

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.
force	boolean	Force flag to force sessionHost deletion even when userSession exists.
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.
vmPath	string	The path to the VM.

SELECT examples

get

Get a session host.

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

list

List sessionHosts.

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

UPDATE examples

update

Update a session host.

UPDATE azure.desktop_virtualization.session_hosts
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND hostPoolName = '{{ hostPoolName }}' --required
AND sessionHostName = '{{ sessionHostName }}' --required
AND force = {{ force}}
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Remove a SessionHost.

DELETE FROM azure.desktop_virtualization.session_hosts
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND hostPoolName = '{{ hostPoolName }}' --required
AND sessionHostName = '{{ sessionHostName }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

retry_provisioning

Retry provisioning on a SessionHost.

EXEC azure.desktop_virtualization.session_hosts.retry_provisioning 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@hostPoolName='{{ hostPoolName }}' --required, 
@sessionHostName='{{ sessionHostName }}' --required
;