desktops

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

Overview

Name	desktops
Type	Resource
Id	azure.desktop_virtualization.desktops

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.
description	string	Description of Desktop.
friendlyName	string	Friendly name of Desktop.
iconContent	string (byte)	The icon a 64 bit string as a byte array.
iconHash	string	Hash of the icon.
objectId	string	ObjectId of Desktop. (internal use).
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

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.
description	string	Description of Desktop.
friendlyName	string	Friendly name of Desktop.
iconContent	string (byte)	The icon a 64 bit string as a byte array.
iconHash	string	Hash of the icon.
objectId	string	ObjectId of Desktop. (internal use).
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	resource_group_name, application_group_name, desktop_name, subscription_id		Get a desktop.
list	select	resource_group_name, application_group_name, subscription_id	pageSize, isDescending, initialSkip	List desktops.
update	update	resource_group_name, application_group_name, desktop_name, subscription_id		Update a desktop.

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
application_group_name	string	The name of the application group. Required.
desktop_name	string	The name of the desktop within the specified desktop group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
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 desktop.

SELECT
id,
name,
description,
friendlyName,
iconContent,
iconHash,
objectId,
systemData,
type
FROM azure.desktop_virtualization.desktops
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND application_group_name = '{{ application_group_name }}' -- required
AND desktop_name = '{{ desktop_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List desktops.

SELECT
id,
name,
description,
friendlyName,
iconContent,
iconHash,
objectId,
systemData,
type
FROM azure.desktop_virtualization.desktops
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND application_group_name = '{{ application_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

UPDATE examples

update

Update a desktop.

UPDATE azure.desktop_virtualization.desktops
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND application_group_name = '{{ application_group_name }}' --required
AND desktop_name = '{{ desktop_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;