Migrate MSIX packages from MSIX app attach to app attach

App attach improves the administrative and user experiences over MSIX app attach. If you use MSIX app attach, you can migrate your MSIX packages to app attach using a PowerShell script.

The migration script can perform the following actions:

• Creates a new app attach package object and can delete the original MSIX package object, if necessary.

• Copy permissions from application groups associated with the host pool and MSIX package.

• Copy the location and resource group of the host pool and MSIX package.

• Log migration activity.

Prerequisites

To use the migration script, you need:

• A host pool configured as a validation environment, with at least one MSIX package added with MSIX app attach.

• An Azure account with the Desktop Virtualization Contributor Azure role-based access control (RBAC) role assigned on the host pool.

• A local device with PowerShell. Make sure you have the latest versions of Az PowerShell and Microsoft Graph PowerShell SDK installed. Specifically, the following modules are required:

  • Az.DesktopVirtualization
  • Az.Accounts
  • Az.Resources
  • Microsoft.Graph.Authentication

Parameters

Here are the parameters you can use with the migration script:

Download and run the migration script

Here's how to migrate MSIX packages from MSIX app attach to app attach.

1. Open a PowerShell prompt on your local device.

2. Download the PowerShell script Migrate-MsixPackagesToAppAttach.ps1 and unblock it by running the following commands:

   $url = "https://raw.githubusercontent.com/Azure/RDS-Templates/master/msix-app-attach/MigrationScript/Migrate-MsixPackagesToAppAttach.ps1"
   $filename = $url.Split('/')[-1]
   
   Invoke-WebRequest -Uri $url -OutFile $filename | Unblock-File
   

3. Import the required modules by running the following commands:

   Import-Module Az.DesktopVirtualization
   Import-Module Az.Accounts
   Import-Module Az.Resources
   Import-Module Microsoft.Graph.Authentication
   

4. Connect to Azure by running the following command and following the prompts to sign in to your Azure account:

   Connect-AzAccount -AzureEnvironmentName AzureChinaCloud
   

5. Connect to Microsoft Graph by running the following command:

   Connect-MgGraph -Scopes "Group.Read.All"
   

The following subsections contain some examples of how to use the migration script. Refer to the parameters section for all the available parameters and a description of each parameter.

Migrate a specific MSIX package added to a host pool and application group

Here's an example to migrate a specific MSIX package added to a host pool from MSIX app attach to app attach. This example:

• Migrates the MSIX package to the same resource group and location as the host pool.
• Assigns the MSIX package in app attach to the same host pool and the same users as the RemoteApp application group source.
• Leaves the existing MSIX package configuration in MSIX app attach active on the host pool. If you want to disable the MSIX package immediately, use the -DeactivateOrigin parameter.
• Sets the new MSIX package configuration in app attach inactive. If you want to enable the MSIX package immediately, use the -IsActive parameter.
• Writes log information to the default file path and format.

1. From the same PowerShell prompt, get a list of MSIX packages added to a host pool by running the following commands:

   $parameters = @{
       HostPoolName = '<HostPoolName>'
       ResourceGroupName = '<ResourceGroupName>'
   }
   
   Get-AzWvdMsixPackage @parameters | Select-Object DisplayName, Name
   

   The output is similar to the following output:

   DisplayName Name
   ----------- ----
   MyApp       hp01/MyApp_1.0.0.0_neutral__abcdef123ghij
   

2. Find the MSIX package you want to migrate and use the value from the Name parameter in the previous output:

   $parameters = @{
       HostPoolName = '<HostPoolName>'
       ResourceGroupName = '<ResourceGroupName>'
   }
   
   $msixPackage = Get-AzWvdMsixPackage @parameters | ? Name -Match '<MSIXPackageName>'
   $hostPoolId = (Get-AzWvdHostPool @parameters).Id
   

3. Migrate the MSIX package by running the following commands:

   $parameters = @{
       PermissionSource = 'RAG'
       HostPoolsForNewPackage = $hostPoolId
       PassThru = $true
   }
   
   $msixPackage | .\Migrate-MsixPackagesToAppAttach.ps1 @parameters
   

Migrate all MSIX packages added to a host pool

Here's an example to migrate all MSIX packages added to a host pool from MSIX app attach to app attach. This example:

• Migrates MSIX packages to the same resource group and location.
• Adds the new app attach packages to the same host pool.
• Sets all app attach packages to active.
• Sets all MSIX packages to inactive.
• Copies permissions from the associated desktop application group.
• Writes log information to a custom file path at C:\MsixToAppAttach.log in JSON format.

1. From the same PowerShell prompt, get all MSIX packages added to a host pool and store them in a variable by running the following commands:

   $parameters = @{
       HostPoolName = '<HostPoolName>'
       ResourceGroupName = '<ResourceGroupName>'
   }
   
   $msixPackages = Get-AzWvdMsixPackage @parameters
   $hostPoolId = (Get-AzWvdHostPool @parameters).Id   
   

2. Migrate the MSIX package by running the following commands:

   $logFilePath = "C:\Temp\MsixToAppAttach.log"
   
   $parameters = @{
       IsActive = $true
       DeactivateOrigin = $true
       PermissionSource = 'DAG'
       HostPoolsForNewPackage = $hostPoolId
       PassThru = $true
       LogInJSON = $true
       LogFilePath = $LogFilePath
   }
   
   $msixPackages | .\Migrate-MsixPackagesToAppAttach.ps1 @parameters