session_host_configurations

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

Overview

Name	session_host_configurations
Type	Resource
Id	azure.desktop_virtualization.session_host_configurations

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved sessionHostConfiguration.

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 sessionHostConfigurations 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 a SessionHostConfiguration.
list_by_host_pool	select	subscriptionId, resourceGroupName, hostPoolName		List sessionHostConfigurations.
create_or_update	insert	subscriptionId, resourceGroupName, hostPoolName, data__properties		Create or update a SessionHostConfiguration.
update	update	subscriptionId, resourceGroupName, hostPoolName		Update a SessionHostConfiguration.

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 a SessionHostConfiguration.

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

list_by_host_pool

List sessionHostConfigurations.

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

INSERT examples

create_or_update

Create or update a SessionHostConfiguration.

INSERT INTO azure.desktop_virtualization.session_host_configurations (
data__properties,
subscriptionId,
resourceGroupName,
hostPoolName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ hostPoolName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: session_host_configurations
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the session_host_configurations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the session_host_configurations resource.
    - name: hostPoolName
      value: string
      description: Required parameter for the session_host_configurations resource.
    - name: properties
      value: object
      description: |
        Detailed properties for SessionHostConfiguration

UPDATE examples

update

Update a SessionHostConfiguration.

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