application_groups

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

Overview

Name	application_groups
Type	Resource
Id	azure.desktop_virtualization.application_groups

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.
applicationGroupType	string	Resource Type of ApplicationGroup. Required. Known values are: "RemoteApp" and "Desktop".
cloudPcResource	boolean	Is cloud pc resource.
description	string	Description of ApplicationGroup.
etag	string	The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
friendlyName	string	Friendly name of ApplicationGroup.
hostPoolArmPath	string	HostPool arm path of ApplicationGroup. Required.
identity	object	:vartype identity: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetIdentity
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	The geo-location where the resource lives. Required.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
objectId	string	ObjectId of ApplicationGroup. (internal use).
plan	object	:vartype plan: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetPlan
showInFeed	boolean	Boolean representing whether the applicationGroup is show in the feed.
sku	object	:vartype sku: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetSku
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workspaceArmPath	string	Workspace arm path of ApplicationGroup.

list_by_resource_group

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.
applicationGroupType	string	Resource Type of ApplicationGroup. Required. Known values are: "RemoteApp" and "Desktop".
cloudPcResource	boolean	Is cloud pc resource.
description	string	Description of ApplicationGroup.
etag	string	The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
friendlyName	string	Friendly name of ApplicationGroup.
hostPoolArmPath	string	HostPool arm path of ApplicationGroup. Required.
identity	object	:vartype identity: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetIdentity
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	The geo-location where the resource lives. Required.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
objectId	string	ObjectId of ApplicationGroup. (internal use).
plan	object	:vartype plan: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetPlan
showInFeed	boolean	Boolean representing whether the applicationGroup is show in the feed.
sku	object	:vartype sku: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetSku
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workspaceArmPath	string	Workspace arm path of ApplicationGroup.

list_by_subscription

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.
applicationGroupType	string	Resource Type of ApplicationGroup. Required. Known values are: "RemoteApp" and "Desktop".
cloudPcResource	boolean	Is cloud pc resource.
description	string	Description of ApplicationGroup.
etag	string	The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
friendlyName	string	Friendly name of ApplicationGroup.
hostPoolArmPath	string	HostPool arm path of ApplicationGroup. Required.
identity	object	:vartype identity: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetIdentity
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	The geo-location where the resource lives. Required.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
objectId	string	ObjectId of ApplicationGroup. (internal use).
plan	object	:vartype plan: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetPlan
showInFeed	boolean	Boolean representing whether the applicationGroup is show in the feed.
sku	object	:vartype sku: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetSku
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workspaceArmPath	string	Workspace arm path of ApplicationGroup.

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, subscription_id		Get an application group.
list_by_resource_group	select	resource_group_name, subscription_id	$filter, pageSize, isDescending, initialSkip	List applicationGroups.
list_by_subscription	select	subscription_id	$filter	List applicationGroups in subscription.
create_or_update	insert	resource_group_name, application_group_name, subscription_id, location, properties		Create or update an applicationGroup.
update	update	resource_group_name, application_group_name, subscription_id		Update an applicationGroup.
create_or_update	replace	resource_group_name, application_group_name, subscription_id, location, properties		Create or update an applicationGroup.
delete	delete	resource_group_name, application_group_name, subscription_id		Remove an applicationGroup.

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.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	OData filter expression. Valid properties for filtering are applicationGroupType. Default value is None.
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 group.

SELECT
id,
name,
applicationGroupType,
cloudPcResource,
description,
etag,
friendlyName,
hostPoolArmPath,
identity,
kind,
location,
managedBy,
objectId,
plan,
showInFeed,
sku,
systemData,
tags,
type,
workspaceArmPath
FROM azure.desktop_virtualization.application_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND application_group_name = '{{ application_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List applicationGroups.

SELECT
id,
name,
applicationGroupType,
cloudPcResource,
description,
etag,
friendlyName,
hostPoolArmPath,
identity,
kind,
location,
managedBy,
objectId,
plan,
showInFeed,
sku,
systemData,
tags,
type,
workspaceArmPath
FROM azure.desktop_virtualization.application_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

list_by_subscription

List applicationGroups in subscription.

SELECT
id,
name,
applicationGroupType,
cloudPcResource,
description,
etag,
friendlyName,
hostPoolArmPath,
identity,
kind,
location,
managedBy,
objectId,
plan,
showInFeed,
sku,
systemData,
tags,
type,
workspaceArmPath
FROM azure.desktop_virtualization.application_groups
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Create or update an applicationGroup.

INSERT INTO azure.desktop_virtualization.application_groups (
tags,
location,
managedBy,
kind,
identity,
sku,
plan,
properties,
resource_group_name,
application_group_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ managedBy }}',
'{{ kind }}',
'{{ identity }}',
'{{ sku }}',
'{{ plan }}',
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ application_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: application_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the application_groups resource.
  - name: application_group_name
    value: "{{ application_group_name }}"
    description: Required parameter for the application_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the application_groups resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: managedBy
    value: "{{ managedBy }}"
    description: |
      The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
  - name: identity
    description: |
      :vartype identity: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetIdentity
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
  - name: sku
    description: |
      :vartype sku: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetSku
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}
  - name: plan
    description: |
      :vartype plan: ~azure.mgmt.desktopvirtualization.models.ResourceModelWithAllowedPropertySetPlan
    value:
      name: "{{ name }}"
      publisher: "{{ publisher }}"
      product: "{{ product }}"
      promotionCode: "{{ promotionCode }}"
      version: "{{ version }}"
  - name: properties
    value:
      description: "{{ description }}"
      friendlyName: "{{ friendlyName }}"
      hostPoolArmPath: "{{ hostPoolArmPath }}"
      applicationGroupType: "{{ applicationGroupType }}"
      showInFeed: {{ showInFeed }}

UPDATE examples

update

Update an applicationGroup.

UPDATE azure.desktop_virtualization.application_groups
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND application_group_name = '{{ application_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update an applicationGroup.

REPLACE azure.desktop_virtualization.application_groups
SET 
tags = '{{ tags }}',
location = '{{ location }}',
managedBy = '{{ managedBy }}',
kind = '{{ kind }}',
identity = '{{ identity }}',
sku = '{{ sku }}',
plan = '{{ plan }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND application_group_name = '{{ application_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Remove an applicationGroup.

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