Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2026-01-01-preview
- 2025-11-01-preview
- 2025-10-10
- 2025-09-01-preview
- 2025-08-01-preview
- 2025-04-01-preview
- 2025-03-01-preview
- 2024-11-01-preview
- 2024-08-08-preview
- 2024-04-08-preview
- 2024-04-03
- 2024-03-06-preview
- 2024-01-16-preview
- 2023-11-01-preview
- 2023-10-04-preview
- 2023-09-05
- 2022-10-14-preview
- 2022-09-09
- 2022-04-01-preview
- 2022-02-10-preview
- 2021-09-03-preview
- 2021-07-12
- 2021-04-01-preview
- 2021-03-09-preview
- 2021-02-01-preview
- 2021-01-14-preview
- 2020-11-10-preview
- 2020-11-02-preview
- 2020-10-19-preview
- 2020-09-21-preview
Bicep resource definition
The hostPools/msixPackages resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DesktopVirtualization/hostPools/msixPackages resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DesktopVirtualization/hostPools/msixPackages@2026-01-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
displayName: 'string'
imagePath: 'string'
isActive: bool
isRegularRegistration: bool
lastUpdated: 'string'
packageApplications: [
{
appId: 'string'
appUserModelID: 'string'
description: 'string'
friendlyName: 'string'
iconImageName: 'string'
rawIcon: any(...)
rawPng: any(...)
}
]
packageDependencies: [
{
dependencyName: 'string'
minVersion: 'string'
publisher: 'string'
}
]
packageFamilyName: 'string'
packageName: 'string'
packageRelativePath: 'string'
version: 'string'
}
}
Property Values
Microsoft.DesktopVirtualization/hostPools/msixPackages
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 3 Max length = 100 Pattern = ^[A-Za-z0-9@.\-_ ]*$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: hostPools |
| properties | Detailed properties for MSIX Package | MsixPackageProperties (required) |
MsixPackageApplications
| Name | Description | Value |
|---|---|---|
| appId | Package Application Id, found in appxmanifest.xml. | string |
| appUserModelID | Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. | string |
| description | Description of Package Application. | string |
| friendlyName | User friendly name. | string |
| iconImageName | User friendly name. | string |
| rawIcon | the icon a 64 bit string as a byte array. | any |
| rawPng | the icon a 64 bit string as a byte array. | any |
MsixPackageDependencies
| Name | Description | Value |
|---|---|---|
| dependencyName | Name of package dependency. | string |
| minVersion | Dependency version required. | string |
| publisher | Name of dependency publisher. | string |
MsixPackageProperties
| Name | Description | Value |
|---|---|---|
| displayName | User friendly Name to be displayed in the portal. | string |
| imagePath | VHD/CIM image path on Network Share. | string |
| isActive | Make this version of the package the active one across the hostpool. | bool |
| isRegularRegistration | Specifies how to register Package in feed. | bool |
| lastUpdated | Date Package was last updated, found in the appxmanifest.xml. | string |
| packageApplications | List of package applications. | MsixPackageApplications[] |
| packageDependencies | List of package dependencies. | MsixPackageDependencies[] |
| packageFamilyName | Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. | string |
| packageName | Package Name from appxmanifest.xml. | string |
| packageRelativePath | Relative Path to the package inside the image. | string |
| version | Package version found in the appxmanifest.xml. | string |
ARM template resource definition
The hostPools/msixPackages resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DesktopVirtualization/hostPools/msixPackages resource, add the following JSON to your template.
{
"type": "Microsoft.DesktopVirtualization/hostPools/msixPackages",
"apiVersion": "2026-01-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"imagePath": "string",
"isActive": "bool",
"isRegularRegistration": "bool",
"lastUpdated": "string",
"packageApplications": [
{
"appId": "string",
"appUserModelID": "string",
"description": "string",
"friendlyName": "string",
"iconImageName": "string",
"rawIcon": {},
"rawPng": {}
}
],
"packageDependencies": [
{
"dependencyName": "string",
"minVersion": "string",
"publisher": "string"
}
],
"packageFamilyName": "string",
"packageName": "string",
"packageRelativePath": "string",
"version": "string"
}
}
Property Values
Microsoft.DesktopVirtualization/hostPools/msixPackages
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-01-01-preview' |
| name | The resource name | string Constraints: Min length = 3 Max length = 100 Pattern = ^[A-Za-z0-9@.\-_ ]*$ (required) |
| properties | Detailed properties for MSIX Package | MsixPackageProperties (required) |
| type | The resource type | 'Microsoft.DesktopVirtualization/hostPools/msixPackages' |
MsixPackageApplications
| Name | Description | Value |
|---|---|---|
| appId | Package Application Id, found in appxmanifest.xml. | string |
| appUserModelID | Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. | string |
| description | Description of Package Application. | string |
| friendlyName | User friendly name. | string |
| iconImageName | User friendly name. | string |
| rawIcon | the icon a 64 bit string as a byte array. | any |
| rawPng | the icon a 64 bit string as a byte array. | any |
MsixPackageDependencies
| Name | Description | Value |
|---|---|---|
| dependencyName | Name of package dependency. | string |
| minVersion | Dependency version required. | string |
| publisher | Name of dependency publisher. | string |
MsixPackageProperties
| Name | Description | Value |
|---|---|---|
| displayName | User friendly Name to be displayed in the portal. | string |
| imagePath | VHD/CIM image path on Network Share. | string |
| isActive | Make this version of the package the active one across the hostpool. | bool |
| isRegularRegistration | Specifies how to register Package in feed. | bool |
| lastUpdated | Date Package was last updated, found in the appxmanifest.xml. | string |
| packageApplications | List of package applications. | MsixPackageApplications[] |
| packageDependencies | List of package dependencies. | MsixPackageDependencies[] |
| packageFamilyName | Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. | string |
| packageName | Package Name from appxmanifest.xml. | string |
| packageRelativePath | Relative Path to the package inside the image. | string |
| version | Package version found in the appxmanifest.xml. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The hostPools/msixPackages resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DesktopVirtualization/hostPools/msixPackages resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DesktopVirtualization/hostPools/msixPackages@2026-01-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
displayName = "string"
imagePath = "string"
isActive = bool
isRegularRegistration = bool
lastUpdated = "string"
packageApplications = [
{
appId = "string"
appUserModelID = "string"
description = "string"
friendlyName = "string"
iconImageName = "string"
rawIcon = ?
rawPng = ?
}
]
packageDependencies = [
{
dependencyName = "string"
minVersion = "string"
publisher = "string"
}
]
packageFamilyName = "string"
packageName = "string"
packageRelativePath = "string"
version = "string"
}
}
}
Property Values
Microsoft.DesktopVirtualization/hostPools/msixPackages
| Name | Description | Value |
|---|---|---|
| name | The resource name | string Constraints: Min length = 3 Max length = 100 Pattern = ^[A-Za-z0-9@.\-_ ]*$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: hostPools |
| properties | Detailed properties for MSIX Package | MsixPackageProperties (required) |
| type | The resource type | "Microsoft.DesktopVirtualization/hostPools/msixPackages@2026-01-01-preview" |
MsixPackageApplications
| Name | Description | Value |
|---|---|---|
| appId | Package Application Id, found in appxmanifest.xml. | string |
| appUserModelID | Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. | string |
| description | Description of Package Application. | string |
| friendlyName | User friendly name. | string |
| iconImageName | User friendly name. | string |
| rawIcon | the icon a 64 bit string as a byte array. | any |
| rawPng | the icon a 64 bit string as a byte array. | any |
MsixPackageDependencies
| Name | Description | Value |
|---|---|---|
| dependencyName | Name of package dependency. | string |
| minVersion | Dependency version required. | string |
| publisher | Name of dependency publisher. | string |
MsixPackageProperties
| Name | Description | Value |
|---|---|---|
| displayName | User friendly Name to be displayed in the portal. | string |
| imagePath | VHD/CIM image path on Network Share. | string |
| isActive | Make this version of the package the active one across the hostpool. | bool |
| isRegularRegistration | Specifies how to register Package in feed. | bool |
| lastUpdated | Date Package was last updated, found in the appxmanifest.xml. | string |
| packageApplications | List of package applications. | MsixPackageApplications[] |
| packageDependencies | List of package dependencies. | MsixPackageDependencies[] |
| packageFamilyName | Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. | string |
| packageName | Package Name from appxmanifest.xml. | string |
| packageRelativePath | Relative Path to the package inside the image. | string |
| version | Package version found in the appxmanifest.xml. | string |