app_attach_packages

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

Overview

Name	app_attach_packages
Type	Resource
Id	azure.desktop_virtualization.app_attach_packages

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved App Attach Package.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Detailed properties for App Attach Package
tags	object	Resource tags.

list_by_resource_group

Successfully retrieved App Attach Packages in resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Detailed properties for App Attach Package
tags	object	Resource tags.

list_by_subscription

Successfully retrieved App Attach Packages in subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Detailed properties for App Attach Package
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, appAttachPackageName		Get an app attach package.
list_by_resource_group	select	subscriptionId, resourceGroupName	$filter	List App Attach packages in resource group.
list_by_subscription	select	subscriptionId	$filter	List App Attach packages in subscription.
create_or_update	insert	subscriptionId, resourceGroupName, appAttachPackageName, data__properties		Create or update an App Attach package.
update	update	subscriptionId, resourceGroupName, appAttachPackageName		Update an App Attach Package
delete	delete	subscriptionId, resourceGroupName, appAttachPackageName	force	Remove an App Attach Package.
import_info	exec	subscriptionId, resourceGroupName, hostPoolName		Gets information from a package given the path to the package.

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
appAttachPackageName	string	The name of the App Attach package arm object
hostPoolName	string	The name of the host pool within the specified resource 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 package name, resource group, host pool, package owner name, and custom data.
force	boolean	Force flag to delete App Attach package.

SELECT examples

get

Get an app attach package.

SELECT
location,
properties,
tags
FROM azure.desktop_virtualization.app_attach_packages
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND appAttachPackageName = '{{ appAttachPackageName }}' -- required
;

list_by_resource_group

List App Attach packages in resource group.

SELECT
location,
properties,
tags
FROM azure.desktop_virtualization.app_attach_packages
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $filter = '{{ $filter }}'
;

list_by_subscription

List App Attach packages in subscription.

SELECT
location,
properties,
tags
FROM azure.desktop_virtualization.app_attach_packages
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Create or update an App Attach package.

INSERT INTO azure.desktop_virtualization.app_attach_packages (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
appAttachPackageName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ appAttachPackageName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: app_attach_packages
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the app_attach_packages resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the app_attach_packages resource.
    - name: appAttachPackageName
      value: string
      description: Required parameter for the app_attach_packages resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Detailed properties for App Attach Package

UPDATE examples

update

Update an App Attach Package

UPDATE azure.desktop_virtualization.app_attach_packages
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND appAttachPackageName = '{{ appAttachPackageName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Remove an App Attach Package.

DELETE FROM azure.desktop_virtualization.app_attach_packages
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND appAttachPackageName = '{{ appAttachPackageName }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

import_info

Gets information from a package given the path to the package.

EXEC azure.desktop_virtualization.app_attach_packages.import_info 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@hostPoolName='{{ hostPoolName }}' --required 
@@json=
'{
"path": "{{ path }}", 
"packageArchitecture": "{{ packageArchitecture }}"
}'
;