Microsoft.DesktopVirtualization appAttachPackages

Bicep resource definition

The appAttachPackages 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/appAttachPackages resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DesktopVirtualization/appAttachPackages@2025-11-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    customData: 'string'
    deploymentScope: 'string'
    failHealthCheckOnStagingFailure: 'string'
    hostPoolReferences: [
      'string'
    ]
    image: {
      certificateExpiry: 'string'
      certificateName: 'string'
      displayName: 'string'
      imagePath: 'string'
      isActive: bool
      isPackageTimestamped: 'string'
      isRegularRegistration: bool
      lastUpdated: 'string'
      packageAlias: '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'
      packageFullName: 'string'
      packageName: 'string'
      packageRelativePath: 'string'
      version: 'string'
    }
    keyVaultURL: 'string'
    packageLookbackUrl: 'string'
    packageOwnerName: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DesktopVirtualization/appAttachPackages

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 100 Pattern = `^[a-z0-9]([a-z0-9]\|(-(?!-))){1,61}[a-z0-9]$` (required)
properties	Detailed properties for App Attach Package	AppAttachPackageProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

AppAttachPackageInfoProperties

Name	Description	Value
certificateExpiry	Date certificate expires, found in the appxmanifest.xml.	string
certificateName	Certificate name found in the appxmanifest.xml.	string
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
isPackageTimestamped	Is package timestamped so it can ignore the certificate expiry date	'NotTimestamped' 'Timestamped'
isRegularRegistration	Specifies how to register Package in feed.	bool
lastUpdated	Date Package was last updated, found in the appxmanifest.xml.	string
packageAlias	Alias of App Attach Package. Assigned at import time	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
packageFullName	Package Full Name from appxmanifest.xml.	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

AppAttachPackageProperties

Name	Description	Value
customData	Field that can be populated with custom data and filtered on in list GET calls	string
deploymentScope	DeploymentScope type for AppAttachPackage.	'Geographical' 'Regional'
failHealthCheckOnStagingFailure	Parameter indicating how the health check should behave if this package fails staging	'DoNotFail' 'NeedsAssistance' 'Unhealthy'
hostPoolReferences	List of Hostpool resource Ids.	string[]
image	Detailed properties for App Attach Package	AppAttachPackageInfoProperties
keyVaultURL	URL path to certificate name located in keyVault	string
packageLookbackUrl	Lookback url to third party control plane, is null for native app attach packages	string
packageOwnerName	Specific name of package owner, is "AppAttach" for native app attach packages	string

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

TrackedResourceTags

Name	Description	Value

ARM template resource definition

The appAttachPackages 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/appAttachPackages resource, add the following JSON to your template.

{
  "type": "Microsoft.DesktopVirtualization/appAttachPackages",
  "apiVersion": "2025-11-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "customData": "string",
    "deploymentScope": "string",
    "failHealthCheckOnStagingFailure": "string",
    "hostPoolReferences": [ "string" ],
    "image": {
      "certificateExpiry": "string",
      "certificateName": "string",
      "displayName": "string",
      "imagePath": "string",
      "isActive": "bool",
      "isPackageTimestamped": "string",
      "isRegularRegistration": "bool",
      "lastUpdated": "string",
      "packageAlias": "string",
      "packageApplications": [
        {
          "appId": "string",
          "appUserModelID": "string",
          "description": "string",
          "friendlyName": "string",
          "iconImageName": "string",
          "rawIcon": {},
          "rawPng": {}
        }
      ],
      "packageDependencies": [
        {
          "dependencyName": "string",
          "minVersion": "string",
          "publisher": "string"
        }
      ],
      "packageFamilyName": "string",
      "packageFullName": "string",
      "packageName": "string",
      "packageRelativePath": "string",
      "version": "string"
    },
    "keyVaultURL": "string",
    "packageLookbackUrl": "string",
    "packageOwnerName": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DesktopVirtualization/appAttachPackages

Name	Description	Value
apiVersion	The api version	'2025-11-01-preview'
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 100 Pattern = `^[a-z0-9]([a-z0-9]\|(-(?!-))){1,61}[a-z0-9]$` (required)
properties	Detailed properties for App Attach Package	AppAttachPackageProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.DesktopVirtualization/appAttachPackages'

AppAttachPackageInfoProperties

Name	Description	Value
certificateExpiry	Date certificate expires, found in the appxmanifest.xml.	string
certificateName	Certificate name found in the appxmanifest.xml.	string
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
isPackageTimestamped	Is package timestamped so it can ignore the certificate expiry date	'NotTimestamped' 'Timestamped'
isRegularRegistration	Specifies how to register Package in feed.	bool
lastUpdated	Date Package was last updated, found in the appxmanifest.xml.	string
packageAlias	Alias of App Attach Package. Assigned at import time	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
packageFullName	Package Full Name from appxmanifest.xml.	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

AppAttachPackageProperties

Name	Description	Value
customData	Field that can be populated with custom data and filtered on in list GET calls	string
deploymentScope	DeploymentScope type for AppAttachPackage.	'Geographical' 'Regional'
failHealthCheckOnStagingFailure	Parameter indicating how the health check should behave if this package fails staging	'DoNotFail' 'NeedsAssistance' 'Unhealthy'
hostPoolReferences	List of Hostpool resource Ids.	string[]
image	Detailed properties for App Attach Package	AppAttachPackageInfoProperties
keyVaultURL	URL path to certificate name located in keyVault	string
packageLookbackUrl	Lookback url to third party control plane, is null for native app attach packages	string
packageOwnerName	Specific name of package owner, is "AppAttach" for native app attach packages	string

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

TrackedResourceTags

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The appAttachPackages 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/appAttachPackages resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DesktopVirtualization/appAttachPackages@2025-11-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      customData = "string"
      deploymentScope = "string"
      failHealthCheckOnStagingFailure = "string"
      hostPoolReferences = [
        "string"
      ]
      image = {
        certificateExpiry = "string"
        certificateName = "string"
        displayName = "string"
        imagePath = "string"
        isActive = bool
        isPackageTimestamped = "string"
        isRegularRegistration = bool
        lastUpdated = "string"
        packageAlias = "string"
        packageApplications = [
          {
            appId = "string"
            appUserModelID = "string"
            description = "string"
            friendlyName = "string"
            iconImageName = "string"
            rawIcon = ?
            rawPng = ?
          }
        ]
        packageDependencies = [
          {
            dependencyName = "string"
            minVersion = "string"
            publisher = "string"
          }
        ]
        packageFamilyName = "string"
        packageFullName = "string"
        packageName = "string"
        packageRelativePath = "string"
        version = "string"
      }
      keyVaultURL = "string"
      packageLookbackUrl = "string"
      packageOwnerName = "string"
    }
  }
}

Property Values

Microsoft.DesktopVirtualization/appAttachPackages

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 3 Max length = 100 Pattern = `^[a-z0-9]([a-z0-9]\|(-(?!-))){1,61}[a-z0-9]$` (required)
properties	Detailed properties for App Attach Package	AppAttachPackageProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.DesktopVirtualization/appAttachPackages@2025-11-01-preview"

AppAttachPackageInfoProperties

Name	Description	Value
certificateExpiry	Date certificate expires, found in the appxmanifest.xml.	string
certificateName	Certificate name found in the appxmanifest.xml.	string
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
isPackageTimestamped	Is package timestamped so it can ignore the certificate expiry date	'NotTimestamped' 'Timestamped'
isRegularRegistration	Specifies how to register Package in feed.	bool
lastUpdated	Date Package was last updated, found in the appxmanifest.xml.	string
packageAlias	Alias of App Attach Package. Assigned at import time	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
packageFullName	Package Full Name from appxmanifest.xml.	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

AppAttachPackageProperties

Name	Description	Value
customData	Field that can be populated with custom data and filtered on in list GET calls	string
deploymentScope	DeploymentScope type for AppAttachPackage.	'Geographical' 'Regional'
failHealthCheckOnStagingFailure	Parameter indicating how the health check should behave if this package fails staging	'DoNotFail' 'NeedsAssistance' 'Unhealthy'
hostPoolReferences	List of Hostpool resource Ids.	string[]
image	Detailed properties for App Attach Package	AppAttachPackageInfoProperties
keyVaultURL	URL path to certificate name located in keyVault	string
packageLookbackUrl	Lookback url to third party control plane, is null for native app attach packages	string
packageOwnerName	Specific name of package owner, is "AppAttach" for native app attach packages	string

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

TrackedResourceTags

Name	Description	Value

Feedback

Was this page helpful?

Last updated on 2025-12-01

Share via

Microsoft.DesktopVirtualization appAttachPackages

Bicep resource definition

Resource format

Property Values

Microsoft.DesktopVirtualization/appAttachPackages

AppAttachPackageInfoProperties

AppAttachPackageProperties

MsixPackageApplications

MsixPackageDependencies

TrackedResourceTags

ARM template resource definition

Resource format

Property Values

Microsoft.DesktopVirtualization/appAttachPackages

AppAttachPackageInfoProperties

AppAttachPackageProperties

MsixPackageApplications

MsixPackageDependencies

TrackedResourceTags

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Microsoft.DesktopVirtualization/appAttachPackages

AppAttachPackageInfoProperties

AppAttachPackageProperties

MsixPackageApplications

MsixPackageDependencies

TrackedResourceTags

Feedback

Additional resources