Edit

Create an MSIX image to use with app attach in Azure Virtual Desktop

  • Article

To use MSIX packages with MSIX app attach and app attach in Azure Virtual Desktop, you need to expand an MSIX package application into an MSIX image. This article shows you how to create an MSIX image.

Prerequisites

Before you can create an MSIX image, you need the following things:

  • Download the MSIXMGR tool and extract it to a folder.

  • Administrative permissions on a Windows 10 or Windows 11 device to create the MSIX image.

  • An MSIX-packaged application (.msix file) you want to use with Azure Virtual Desktop. To learn how to convert a desktop installer to an MSIX package, see Create an MSIX package from any desktop installer (MSI, EXE, ClickOnce, or App-V).

    Tip

    You can download an application that is already available as an MSIX package from several software vendors. Microsoft XML Notepad is available to download as an MSIX package. You can get the latest release from GitHub by downloading the file with the .msixbundle file extension.

    Note

    If you're using packages from the Microsoft Store for Business or Education on your network or on devices not connected to the internet, you'll need to download and install package licenses from the Microsoft Store to run the apps. To get the licenses, see Use packages offline.

Create an app attach disk image

When creating an MSIX image, you convert an MSIX package to a VHD, VHDX, or CIM disk image using the MSIXMGR tool. We recommend using CIM for best performance, particularly with Windows 11, as it consumes less CPU and memory, with improved mounting and unmounting times. We don't recommend using VHD; use VHDX instead.

Select the relevant tab for your scenario.

Here are example commands to create a CIM disk image from an MSIX package. You'll need to change the example values for your own.

You should create a new folder for the destination because a CIM disk image is made up of multiple files and this helps differentiate between the images.

Important

To guarantee compatibility, make sure the CIM files storing your MSIX images are generated on a version of Windows that is lower than or equal to the version of Windows where you are planning to run the MSIX packages. For example, CIM files generated on Windows 11 may not work on Windows 10.

  1. Open command prompt as an administrator and change to the directory you extracted the MSIXMGR tool.

  2. Make sure the folder you use for the destination exists before you run MSIXMGR. Create a new folder if necessary.

  3. To create the CIM disk image, run the following command:

    msixmgr.exe -Unpack -packagePath "C:\msix\myapp.msix" -destination "C:\msix\myapp\myapp.cim" -applyACLs -create -fileType cim -rootDirectory apps

    The output should be as follows:

    Successfully created the CIM file: C:\msix\myapp\myapp.cim

Next steps

After you've created the MSIX package, you need to store it on a file share and add the MSIX package to Azure Virtual Desktop.

Here are some other articles you might find helpful: