active_session_host_configurations

Creates, updates, deletes, gets or lists an active_session_host_configurations resource.

Overview

Name	active_session_host_configurations
Type	Resource
Id	azure.desktop_virtualization.active_session_host_configurations

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved activeSessionHostConfiguration.

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 SessionHostConfiguration
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 activeSessionHostConfigurations in HostPool.

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 SessionHostConfiguration
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		Get the ActiveSessionHostConfiguration for the hostPool that is currently being used for update operations.
list_by_host_pool	select	subscriptionId, resourceGroupName, hostPoolName		List activeSessionHostConfigurations.

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.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get the ActiveSessionHostConfiguration for the hostPool that is currently being used for update operations.

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

list_by_host_pool

List activeSessionHostConfigurations.

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