app_attach_package

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

Overview

Name	app_attach_package
Type	Resource
Id	azure.desktop_virtualization.app_attach_package

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.
failHealthCheckOnStagingFailure	string	Parameter indicating how the health check should behave if this package fails staging. Known values are: "Unhealthy", "NeedsAssistance", and "DoNotFail".
hostPoolReferences	array	List of Hostpool resource Ids.
image	object	Detailed properties for App Attach Package.
keyVaultURL	string	URL path to certificate name located in keyVault.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the App Attach Package. Known values are: "Succeeded", "Provisioning", "Failed", and "Canceled".
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".

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.
failHealthCheckOnStagingFailure	string	Parameter indicating how the health check should behave if this package fails staging. Known values are: "Unhealthy", "NeedsAssistance", and "DoNotFail".
hostPoolReferences	array	List of Hostpool resource Ids.
image	object	Detailed properties for App Attach Package.
keyVaultURL	string	URL path to certificate name located in keyVault.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the App Attach Package. Known values are: "Succeeded", "Provisioning", "Failed", and "Canceled".
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".

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.
failHealthCheckOnStagingFailure	string	Parameter indicating how the health check should behave if this package fails staging. Known values are: "Unhealthy", "NeedsAssistance", and "DoNotFail".
hostPoolReferences	array	List of Hostpool resource Ids.
image	object	Detailed properties for App Attach Package.
keyVaultURL	string	URL path to certificate name located in keyVault.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the App Attach Package. Known values are: "Succeeded", "Provisioning", "Failed", and "Canceled".
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, app_attach_package_name, subscription_id		Get an app attach package.
list_by_resource_group	select	resource_group_name, subscription_id	$filter	List App Attach packages in resource group.
list_by_subscription	select	subscription_id	$filter	List App Attach packages in subscription.
create_or_update	insert	resource_group_name, app_attach_package_name, subscription_id, location, properties		Create or update an App Attach package.
update	update	resource_group_name, app_attach_package_name, subscription_id		Update an App Attach Package.
create_or_update	replace	resource_group_name, app_attach_package_name, subscription_id, location, properties		Create or update an App Attach package.
delete	delete	resource_group_name, app_attach_package_name, subscription_id		Remove an App Attach 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
app_attach_package_name	string	The name of the App Attach package. 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 package name, host pool, and resource group. Default value is None.

SELECT examples

get

Get an app attach package.

SELECT
id,
name,
failHealthCheckOnStagingFailure,
hostPoolReferences,
image,
keyVaultURL,
location,
provisioningState,
systemData,
tags,
type
FROM azure.desktop_virtualization.app_attach_package
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND app_attach_package_name = '{{ app_attach_package_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List App Attach packages in resource group.

SELECT
id,
name,
failHealthCheckOnStagingFailure,
hostPoolReferences,
image,
keyVaultURL,
location,
provisioningState,
systemData,
tags,
type
FROM azure.desktop_virtualization.app_attach_package
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

list_by_subscription

List App Attach packages in subscription.

SELECT
id,
name,
failHealthCheckOnStagingFailure,
hostPoolReferences,
image,
keyVaultURL,
location,
provisioningState,
systemData,
tags,
type
FROM azure.desktop_virtualization.app_attach_package
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Create or update an App Attach package.

INSERT INTO azure.desktop_virtualization.app_attach_package (
tags,
location,
properties,
resource_group_name,
app_attach_package_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ app_attach_package_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: app_attach_package
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the app_attach_package resource.
  - name: app_attach_package_name
    value: "{{ app_attach_package_name }}"
    description: Required parameter for the app_attach_package resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the app_attach_package resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Detailed properties for App Attach Package. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      image:
        packageAlias: "{{ packageAlias }}"
        imagePath: "{{ imagePath }}"
        packageName: "{{ packageName }}"
        packageFamilyName: "{{ packageFamilyName }}"
        packageFullName: "{{ packageFullName }}"
        displayName: "{{ displayName }}"
        packageRelativePath: "{{ packageRelativePath }}"
        isRegularRegistration: {{ isRegularRegistration }}
        isActive: {{ isActive }}
        packageDependencies:
          - dependencyName: "{{ dependencyName }}"
            publisher: "{{ publisher }}"
            minVersion: "{{ minVersion }}"
        version: "{{ version }}"
        lastUpdated: "{{ lastUpdated }}"
        packageApplications:
          - appId: "{{ appId }}"
            description: "{{ description }}"
            appUserModelID: "{{ appUserModelID }}"
            friendlyName: "{{ friendlyName }}"
            iconImageName: "{{ iconImageName }}"
            rawIcon: "{{ rawIcon }}"
            rawPng: "{{ rawPng }}"
        certificateName: "{{ certificateName }}"
        certificateExpiry: "{{ certificateExpiry }}"
        isPackageTimestamped: "{{ isPackageTimestamped }}"
      hostPoolReferences:
        - "{{ hostPoolReferences }}"
      keyVaultURL: "{{ keyVaultURL }}"
      failHealthCheckOnStagingFailure: "{{ failHealthCheckOnStagingFailure }}"

UPDATE examples

update

Update an App Attach Package.

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

REPLACE examples

create_or_update

Create or update an App Attach package.

REPLACE azure.desktop_virtualization.app_attach_package
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND app_attach_package_name = '{{ app_attach_package_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Remove an App Attach Package.

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