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

Successfully retrieved MSIX Package.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Detailed properties for MSIX Package
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"

list

Successfully retrieved MSIX Packages in hostpool.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	Detailed properties for MSIX Package
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"

Methods

The following methods are available for this resource:

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.desktop_virtualization.msix_packages
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND hostPoolName = '{{ hostPoolName }}' -- required
AND msixPackageFullName = '{{ msixPackageFullName }}' -- required
;

list

List MSIX packages in hostpool.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.desktop_virtualization.msix_packages
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND hostPoolName = '{{ hostPoolName }}' -- 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 (
data__properties,
subscriptionId,
resourceGroupName,
hostPoolName,
msixPackageFullName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ hostPoolName }}',
'{{ msixPackageFullName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: msix_packages
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the msix_packages resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the msix_packages resource.
    - name: hostPoolName
      value: string
      description: Required parameter for the msix_packages resource.
    - name: msixPackageFullName
      value: string
      description: Required parameter for the msix_packages resource.
    - name: properties
      value: object
      description: |
        Detailed properties for MSIX Package

UPDATE examples

update

Update an MSIX Package.

UPDATE azure.desktop_virtualization.msix_packages
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND hostPoolName = '{{ hostPoolName }}' --required
AND msixPackageFullName = '{{ msixPackageFullName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Remove an MSIX Package.

DELETE FROM azure.desktop_virtualization.msix_packages
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND hostPoolName = '{{ hostPoolName }}' --required
AND msixPackageFullName = '{{ msixPackageFullName }}' --required
;