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

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.
applicationType	string	Resource Type of Application. Known values are: "InBuilt" and "MsixApplication".
commandLineArguments	string	Command Line Arguments for Application.
commandLineSetting	string	Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. Required. Known values are: "DoNotAllow", "Allow", and "Require".
description	string	Description of Application.
filePath	string	Specifies a path for the executable file for the application.
friendlyName	string	Friendly name of Application.
iconContent	string (byte)	the icon a 64 bit string as a byte array.
iconHash	string	Hash of the icon.
iconIndex	integer	Index of the icon.
iconPath	string	Path to icon.
msixPackageApplicationId	string	Specifies the package application Id for MSIX applications.
msixPackageFamilyName	string	Specifies the package family name for MSIX applications.
objectId	string	ObjectId of Application. (internal use).
showInPortal	boolean	Specifies whether to show the RemoteApp program in the RD Web Access server.
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.
applicationType	string	Resource Type of Application. Known values are: "InBuilt" and "MsixApplication".
commandLineArguments	string	Command Line Arguments for Application.
commandLineSetting	string	Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all. Required. Known values are: "DoNotAllow", "Allow", and "Require".
description	string	Description of Application.
filePath	string	Specifies a path for the executable file for the application.
friendlyName	string	Friendly name of Application.
iconContent	string (byte)	the icon a 64 bit string as a byte array.
iconHash	string	Hash of the icon.
iconIndex	integer	Index of the icon.
iconPath	string	Path to icon.
msixPackageApplicationId	string	Specifies the package application Id for MSIX applications.
msixPackageFamilyName	string	Specifies the package family name for MSIX applications.
objectId	string	ObjectId of Application. (internal use).
showInPortal	boolean	Specifies whether to show the RemoteApp program in the RD Web Access server.
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, application_name, subscription_id		Get an application.
list	select	resource_group_name, application_group_name, subscription_id	pageSize, isDescending, initialSkip	List applications.
create_or_update	insert	resource_group_name, application_group_name, application_name, subscription_id, properties		Create or update an application.
update	update	resource_group_name, application_group_name, application_name, subscription_id		Update an application.
create_or_update	replace	resource_group_name, application_group_name, application_name, subscription_id, properties		Create or update an application.
delete	delete	resource_group_name, application_group_name, application_name, subscription_id		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
application_group_name	string	The name of the application group. Required.
application_name	string	The name of the application within the specified application 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 an application.

SELECT
id,
name,
applicationType,
commandLineArguments,
commandLineSetting,
description,
filePath,
friendlyName,
iconContent,
iconHash,
iconIndex,
iconPath,
msixPackageApplicationId,
msixPackageFamilyName,
objectId,
showInPortal,
systemData,
type
FROM azure.desktop_virtualization.applications
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND application_group_name = '{{ application_group_name }}' -- required
AND application_name = '{{ application_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List applications.

SELECT
id,
name,
applicationType,
commandLineArguments,
commandLineSetting,
description,
filePath,
friendlyName,
iconContent,
iconHash,
iconIndex,
iconPath,
msixPackageApplicationId,
msixPackageFamilyName,
objectId,
showInPortal,
systemData,
type
FROM azure.desktop_virtualization.applications
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 }}'
;

INSERT examples

create_or_update

Create or update an application.

INSERT INTO azure.desktop_virtualization.applications (
properties,
resource_group_name,
application_group_name,
application_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ application_group_name }}',
'{{ application_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the applications resource.
  - name: application_group_name
    value: "{{ application_group_name }}"
    description: Required parameter for the applications resource.
  - name: application_name
    value: "{{ application_name }}"
    description: Required parameter for the applications resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the applications resource.
  - name: properties
    value:
      description: "{{ description }}"
      friendlyName: "{{ friendlyName }}"
      filePath: "{{ filePath }}"
      msixPackageFamilyName: "{{ msixPackageFamilyName }}"
      msixPackageApplicationId: "{{ msixPackageApplicationId }}"
      applicationType: "{{ applicationType }}"
      commandLineSetting: "{{ commandLineSetting }}"
      commandLineArguments: "{{ commandLineArguments }}"
      showInPortal: {{ showInPortal }}
      iconPath: "{{ iconPath }}"
      iconIndex: {{ iconIndex }}

UPDATE examples

update

Update an application.

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

REPLACE examples

create_or_update

Create or update an application.

REPLACE azure.desktop_virtualization.applications
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND application_group_name = '{{ application_group_name }}' --required
AND application_name = '{{ application_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Remove an application.

DELETE FROM azure.desktop_virtualization.applications
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND application_group_name = '{{ application_group_name }}' --required
AND application_name = '{{ application_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;