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

Successfully retrieved desktop.

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 Desktop
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 desktops in application group.

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 Desktop
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, applicationGroupName, desktopName		Get a desktop.
list	select	subscriptionId, resourceGroupName, applicationGroupName	pageSize, isDescending, initialSkip	List desktops.
update	update	subscriptionId, resourceGroupName, applicationGroupName, desktopName		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
applicationGroupName	string	The name of the application group
desktopName	string	The name of the desktop within the specified desktop 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.
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 desktop.

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

list

List desktops.

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

UPDATE examples

update

Update a desktop.

UPDATE azure.desktop_virtualization.desktops
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND applicationGroupName = '{{ applicationGroupName }}' --required
AND desktopName = '{{ desktopName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;