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

Successfully retrieved application group.

Name	Datatype	Description
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.
identity	object	Identity for the resource.
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. (pattern: ^[-\w._,()]+$)
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.
plan	object	Plan for the resource.
properties	object	Detailed properties for ApplicationGroup
sku	object	The resource model definition representing SKU

list_by_resource_group

Successfully retrieved application groups in resource group.

Name	Datatype	Description
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.
identity	object	Identity for the resource.
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. (pattern: ^[-\w._,()]+$)
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.
plan	object	Plan for the resource.
properties	object	Detailed properties for ApplicationGroup
sku	object	The resource model definition representing SKU

list_by_subscription

Successfully retrieved application groups in subscription.

Name	Datatype	Description
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.
identity	object	Identity for the resource.
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. (pattern: ^[-\w._,()]+$)
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.
plan	object	Plan for the resource.
properties	object	Detailed properties for ApplicationGroup
sku	object	The resource model definition representing SKU

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, applicationGroupName		Get an application group.
list_by_resource_group	select	subscriptionId, resourceGroupName	$filter, pageSize, isDescending, initialSkip	List applicationGroups.
list_by_subscription	select	subscriptionId	$filter	List applicationGroups in subscription.
create_or_update	insert	subscriptionId, resourceGroupName, applicationGroupName, data__properties		Create or update an applicationGroup.
update	update	subscriptionId, resourceGroupName, applicationGroupName		Update an applicationGroup.
delete	delete	subscriptionId, resourceGroupName, applicationGroupName		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
applicationGroupName	string	The name of the 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.
$filter	string	OData filter expression. Valid properties for filtering are applicationGroupType.
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 group.

SELECT
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.desktop_virtualization.application_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND applicationGroupName = '{{ applicationGroupName }}' -- required
;

list_by_resource_group

List applicationGroups.

SELECT
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.desktop_virtualization.application_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $filter = '{{ $filter }}'
AND pageSize = '{{ pageSize }}'
AND isDescending = '{{ isDescending }}'
AND initialSkip = '{{ initialSkip }}'
;

list_by_subscription

List applicationGroups in subscription.

SELECT
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
FROM azure.desktop_virtualization.application_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Create or update an applicationGroup.

INSERT INTO azure.desktop_virtualization.application_groups (
data__managedBy,
data__kind,
data__identity,
data__sku,
data__plan,
data__properties,
subscriptionId,
resourceGroupName,
applicationGroupName
)
SELECT 
'{{ managedBy }}',
'{{ kind }}',
'{{ identity }}',
'{{ sku }}',
'{{ plan }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ applicationGroupName }}'
RETURNING
etag,
identity,
kind,
managedBy,
plan,
properties,
sku
;

Manifest

# Description fields are for documentation purposes
- name: application_groups
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the application_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the application_groups resource.
    - name: applicationGroupName
      value: string
      description: Required parameter for the application_groups resource.
    - name: managedBy
      value: string
      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: string
      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
      value: object
      description: |
        Identity for the resource.
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: plan
      value: object
      description: |
        Plan for the resource.
    - name: properties
      value: object
      description: |
        Detailed properties for ApplicationGroup

UPDATE examples

update

Update an applicationGroup.

UPDATE azure.desktop_virtualization.application_groups
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND applicationGroupName = '{{ applicationGroupName }}' --required
RETURNING
etag,
identity,
kind,
managedBy,
plan,
properties,
sku;

DELETE examples

delete

Remove an applicationGroup.

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