applications

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

Overview

Name	applications
Type	Resource
Id	azure.desktop_virtualization.applications

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved application.

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 Application
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 applications 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 Application
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, applicationName		Get an application.
list	select	subscriptionId, resourceGroupName, applicationGroupName	pageSize, isDescending, initialSkip	List applications.
create_or_update	insert	subscriptionId, resourceGroupName, applicationGroupName, applicationName, data__properties		Create or update an application.
update	update	subscriptionId, resourceGroupName, applicationGroupName, applicationName		Update an application.
delete	delete	subscriptionId, resourceGroupName, applicationGroupName, applicationName		Remove an application.

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
applicationName	string	The name of the application within the specified application 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 an application.

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

list

List applications.

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

INSERT examples

create_or_update

Create or update an application.

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

Manifest

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

UPDATE examples

update

Update an application.

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

DELETE examples

delete

Remove an application.

DELETE FROM azure.desktop_virtualization.applications
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND applicationGroupName = '{{ applicationGroupName }}' --required
AND applicationName = '{{ applicationName }}' --required
;