msix_packages

Creates, updates, deletes, gets or lists a msix_packages resource.

Overview

Name	msix_packages
Type	Resource
Id	azure.desktop_virtualization.msix_packages

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.
displayName	string	User friendly Name to be displayed in the portal.
imagePath	string	VHD/CIM image path on Network Share.
isActive	boolean	Make this version of the package the active one across the hostpool.
isRegularRegistration	boolean	Specifies how to register Package in feed.
lastUpdated	string (date-time)	Date Package was last updated, found in the appxmanifest.xml.
packageApplications	array	List of package applications.
packageDependencies	array	List of package dependencies.
packageFamilyName	string	Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.
packageName	string	Package Name from appxmanifest.xml.
packageRelativePath	string	Relative Path to the package inside the image.
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".
version	string	Package version found in the appxmanifest.xml.

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.
displayName	string	User friendly Name to be displayed in the portal.
imagePath	string	VHD/CIM image path on Network Share.
isActive	boolean	Make this version of the package the active one across the hostpool.
isRegularRegistration	boolean	Specifies how to register Package in feed.
lastUpdated	string (date-time)	Date Package was last updated, found in the appxmanifest.xml.
packageApplications	array	List of package applications.
packageDependencies	array	List of package dependencies.
packageFamilyName	string	Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.
packageName	string	Package Name from appxmanifest.xml.
packageRelativePath	string	Relative Path to the package inside the image.
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".
version	string	Package version found in the appxmanifest.xml.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, host_pool_name, msix_package_full_name, subscription_id		Get a msixpackage.
list	select	resource_group_name, host_pool_name, subscription_id	pageSize, isDescending, initialSkip	List MSIX packages in hostpool.
create_or_update	insert	resource_group_name, host_pool_name, msix_package_full_name, subscription_id		Create or update a MSIX package.
update	update	resource_group_name, host_pool_name, msix_package_full_name, subscription_id		Update an MSIX Package.
create_or_update	replace	resource_group_name, host_pool_name, msix_package_full_name, subscription_id		Create or update a MSIX package.
delete	delete	resource_group_name, host_pool_name, msix_package_full_name, subscription_id		Remove an MSIX 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
host_pool_name	string	The name of the host pool within the specified resource group. Required.
msix_package_full_name	string	The version specific package full name of the MSIX package within specified hostpool. 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 a msixpackage.

SELECT
id,
name,
displayName,
imagePath,
isActive,
isRegularRegistration,
lastUpdated,
packageApplications,
packageDependencies,
packageFamilyName,
packageName,
packageRelativePath,
systemData,
type,
version
FROM azure.desktop_virtualization.msix_packages
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND host_pool_name = '{{ host_pool_name }}' -- required
AND msix_package_full_name = '{{ msix_package_full_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List MSIX packages in hostpool.

SELECT
id,
name,
displayName,
imagePath,
isActive,
isRegularRegistration,
lastUpdated,
packageApplications,
packageDependencies,
packageFamilyName,
packageName,
packageRelativePath,
systemData,
type,
version
FROM azure.desktop_virtualization.msix_packages
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND host_pool_name = '{{ host_pool_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 a MSIX package.

INSERT INTO azure.desktop_virtualization.msix_packages (
properties,
resource_group_name,
host_pool_name,
msix_package_full_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ host_pool_name }}',
'{{ msix_package_full_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: msix_packages
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the msix_packages resource.
  - name: host_pool_name
    value: "{{ host_pool_name }}"
    description: Required parameter for the msix_packages resource.
  - name: msix_package_full_name
    value: "{{ msix_package_full_name }}"
    description: Required parameter for the msix_packages resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the msix_packages resource.
  - name: properties
    value:
      imagePath: "{{ imagePath }}"
      packageName: "{{ packageName }}"
      packageFamilyName: "{{ packageFamilyName }}"
      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 }}"

UPDATE examples

update

Update an MSIX Package.

UPDATE azure.desktop_virtualization.msix_packages
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND host_pool_name = '{{ host_pool_name }}' --required
AND msix_package_full_name = '{{ msix_package_full_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update a MSIX package.

REPLACE azure.desktop_virtualization.msix_packages
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND host_pool_name = '{{ host_pool_name }}' --required
AND msix_package_full_name = '{{ msix_package_full_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Remove an MSIX Package.

DELETE FROM azure.desktop_virtualization.msix_packages
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND host_pool_name = '{{ host_pool_name }}' --required
AND msix_package_full_name = '{{ msix_package_full_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;