Skip to content

Commit 956aabe

Browse files
dknappettmsftdknappettmsft
committed
Updates and fixes
1 parent 9e85211 commit 956aabe

File tree

2 files changed

+96
-90
lines changed

2 files changed

+96
-90
lines changed

‎articles/virtual-desktop/TOC.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -209,9 +209,8 @@
209209
href: app-attach-file-share.md
210210
- name: Set up the MSIXMGR tool
211211
href: app-attach-msixmgr.md
212-
- name: MSIXMGR Tool parameters
212+
- name: MSIXMGR tool parameters
213213
href: msixmgr-tool-syntax-description.md
214-
displayName: MSIXMGR Tool Parameters, Syntax
215214
- name: Use Microsoft Teams
216215
href: teams-on-avd.md
217216
- name: Set up Windows Sandbox

‎articles/virtual-desktop/msixmgr-tool-syntax-description.md

Lines changed: 95 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,15 @@
11
---
2-
# Required metadata
3-
# For more information, see https://review.learn.microsoft.com/en-us/help/platform/learn-editor-add-metadata?branch=main
4-
# For valid values of ms.service, ms.prod, and ms.topic, see https://review.learn.microsoft.com/en-us/help/platform/metadata-taxonomies?branch=main
5-
6-
title: MSIXMGR tool parameters
7-
titleSuffix: Azure
8-
description: This article contains an overview of the command-line syntax to help you understand and get the most from the MSIXMGR Tool. In this documentation, we’ll expand the syntax of all the parameters used by the MSIXMGR tool.
9-
author: fiza-microsoft # GitHub alias
10-
ms.author: fizaazmi # Microsoft alias
11-
#ms.prod: windows #ms.prod
12-
ms.topic: concept-article
13-
ms.date: 03/21/2023
2+
title: MSIXMGR tool parameters - Azure Virtual Desktop
3+
description: This article contains the command line syntax to help you understand and get the most from the MSIXMGR tool. In this article, we'll show you the syntax of all the parameters used by the MSIXMGR tool.
4+
author: fiza-microsoft
5+
ms.author: fizaazmi
6+
ms.topic: concept-article
7+
ms.date: 03/21/2023
148
---
159

1610
# MSIXMGR Tool parameters
1711

18-
19-
This article contains an overview of the command-line syntax to help you understand and get the most from the MSIXMGR Tool. In this documentation, we expand the syntax of all the parameters used by the MSIXMGR tool.
12+
This article contains the command line syntax to help you understand and get the most from the MSIXMGR tool. In this article, we'll show you the syntax of all the parameters used by the MSIXMGR tool.
2013

2114
## Prerequisites:
2215

@@ -27,124 +20,146 @@ Before you can follow the instructions in this article, you'll need to do the fo
2720
- Get administrative permissions on the machine where you'll create the MSIX image
2821
- [Set up MSIXMGR tool](/azure/virtual-desktop/app-attach-msixmgr)
2922

30-
## Syntax
23+
## Parameters
24+
25+
### -AddPackage or -p
3126

32-
27+
Add the package at specified file path.
3328

34-
**-AddPackage or -p**
35-
Adds package at specified file path
36-
Example:
37-
-AddPackage [path to the MSIX package] [optional arguments]
3829
```
39-
msixmgr.exe -AddPackage C:\SomeDirectory\notepadplus.msix
30+
-AddPackage [Path to the MSIX package]
4031
```
4132

42-
|Optional parameters|Description|Example|
43-
| -------- | -------- | -------- |
44-
|-QuietUX|Installs MSIX package silently, without any user interaction|`msixmgr.exe -AddPackage C:\SomeDirectory\notepadplus.msix -QuietUX`  |
33+
#### Example
34+
35+
```
36+
msixmgr.exe -AddPackage "C:\SomeDirectory\myapp.msix"
37+
```
4538

46-
**-RemovePackage or -x**
47-
Removes package with specified package full name
48-
Example:
49-
-RemovePackage [Package Name] [optional arguments]
39+
### -RemovePackage or -x
40+
41+
Remove the package with specified package full name.
5042

5143
```
52-
msixmgr.exe -RemovePackage notepadplus_0.0.0.1_x64__8wekyb3d8bbwe
44+
-RemovePackage [Package name]
5345
```
5446

55-
|Optional parameters|Description|Example|
56-
| -------- | -------- | -------- |
57-
|-QuietUX|Uninstalls MSIX package silently, without any user interaction|`msixmgr.exe -RemovePackage notepadplus_0.0.0.1_x64__8wekyb3d8bbwe msix `-QuietUX  |
47+
#### Example
5848

49+
```
50+
msixmgr.exe -RemovePackage myapp_0.0.0.1_x64__8wekyb3d8bbwe
51+
```
5952

53+
### -FindPackage
6054

55+
Find a package with specific package full name.
6156

57+
```
58+
-FindPackage [Package name]
59+
```
6260

63-
**- FindPackage**
64-
Finds package with specific package full name
65-
Example:
61+
#### Example
6662

6763
```
68-
msixmgr.exe -FindPackage notepadplus_0.0.0.1_x64__8wekyb3d8bbwe
64+
msixmgr.exe -FindPackage myapp_0.0.0.1_x64__8wekyb3d8bbwe
6965
```
7066

71-
 
67+
### -ApplyACLs
7268

73-
**-applyacls**
74-
Applies ACLs to a package folder (an unpacked package)
75-
Example:
69+
Applies ACLs to a package folder (an unpacked package).
7670

7771
```
78-
msixmgr.exe -applyacls
72+
-ApplyACLs -packagePath [Path to the package folder]
7973
```
8074

81-
|Optional parameters|Description|Example|
82-
| -------- | -------- | -------- |
83-
|-packagePath|Specifies path to folder to apply ACLs to  |`msixmgr.exe -applyacls -packagePath C:\name_version_arch_pub` |
75+
#### Example:
76+
77+
```
78+
msixmgr.exe -ApplyACLs -packagePath "C:\SomeDirectory\name_version_arch_pub"
79+
```
8480

85-
 
81+
### -MountImage
8682

87-
**-MountImage**
88-
Mounts VHD, VHDX, or CIM image
89-
Example:
83+
Mounts the VHD, VHDX, or CIM image.
9084

9185
```
92-
msixmgr.exe -MountImage
86+
-MountImage -imagePath [Path to the MSIX image] -fileType [VHD | VHDX | CIM]
87+
```
88+
89+
#### Example
90+
91+
```
92+
msixmgr.exe -MountImage -imagePath "C:\SomeDirectory\myapp.cim" -fileType CIM
9393
```
9494

9595
|Optional parameters|Description|Example|
9696
| -------- | -------- | -------- |
97-
|-imagePath|Specifies path to image file to mount or unmount|`msixmgr.exe -MountImage -imagePath "C:\Users\User\abc\xyz.cim"`|
98-
|-filetype |Specifies type of file to mount or unmount. The following file types are currently supported: {VHD, VHDX, CIM}|`msixmgr.exe -MountImage -imagePath "C:\Users\User\abc\xyz.cim" -filetype "cim" `|
99-
|-readOnly|Boolean (true of false) indicating whether a VHD(X) should be mounted as read only. If not specified, the image is mounted as read-only by default  |`msixmgr.exe -MountImage -imagePath "C:\Users\User\abc\xyz.cim" -filetype "cim" -readOnly false`|
97+
|-readOnly|Boolean (true of false) indicating whether a VHD(X) should be mounted as read only. If not specified, the image is mounted as read-only by default. |`msixmgr.exe -MountImage -imagePath "C:\SomeDirectory\myapp.cim" -filetype CIM -readOnly false`|
10098

99+
### -quietUX
101100

101+
Quiet mode, no user interaction. Use in conjunction with other parameters.
102102

103+
```
104+
-quietUX
105+
```
103106

107+
#### Example
104108

109+
```
110+
msixmgr.exe -AddPackage "C:\SomeDirectory\myapp.msix" -quietUX
111+
```
105112

113+
### -UnmountImage
106114

115+
Unmounts the VHD, VHDX, or CIM image.
107116

108-
**-UnmountImage**
109-
Unmounts VHD, VHDX, or CIM image
110-
Example:
117+
```
118+
-UnmountImage -imagePath [Path to the MSIX image] -fileType [VHD | VHDX | CIM]
119+
```
120+
121+
#### Example:
111122

112123
```
113-
msixmgr.exe -UnmountImage
124+
msixmgr.exe -UnmountImage -imagePath "C:\SomeDirectory\myapp.vhdx" -fileType VHDX
114125
```
115126

116127
|Optional parameters|Description|Example|
117128
| -------- | -------- | -------- |
118-
|-imagePath|Specifies path to image file to mount or unmount  |`msixmgr.exe -UnmountImage -imagePath C:\Users\User\abc\xyz.cim`|
119-
|-filetype  |Specifies type of file to mount or unmount. The following file types are currently supported: {VHD, VHDX, CIM}  |`msixmgr.exe -UnmountImage -imagePath C:\Users\User\abc\xyz.cim -filetype “cim”` ` `|
120-
|-volumeid|Specifies GUID (specified without curly braces) associated with image to unmount. -volumeid is an optional parameter only for CIM files|`msixmgr.exe -UnmountImage -volumeid 0ea000fe-0021-465a-887b-6dc94f15e86e -filetype “cim”`|
129+
|-volumeId|Specifies GUID (specified without curly braces) associated with image to unmount. This is an optional parameter only for CIM files. |`msixmgr.exe -UnmountImage -volumeId 0ea000fe-0021-465a-887b-6dc94f15e86e -filetype CIM`|
121130

122-
 
131+
### -Unpack
132+
133+
Unpacks package (`.appx`, `.msix`, `.appxbundle`, `.msixbundle`) and extract its contents to a folder.
134+
135+
```
136+
-Unpack -packagePath [Path to package to unpack OR path to a directory containing multiple packages to unpack] -destination [Directory to place the resulting package folder(s) in]
137+
```
123138

124-
**-Unpack**
125-
Unpacks package (.appx, .msix, .appxbundle, .msixbundle) and extract its contents to a folder.  
126139
> [!NOTE]
127-
> VHD Size is recommended to be four times the size of MSIX package
140+
> If you're using VHD or VHDX, we recommend the size is four times the size of MSIX package.
128141
129-
Unpacks package (.appx, .msix, .appxbundle, .msixbundle) and extract its contents to a folder.   Note: VHD Size is recommended to be four times the size of MSIX package
130-
Example:
142+
#### Example
131143

132144
```
133-
msixmgr.exe -Unpack -packagePath "C:\Users\ssa\Desktop\FileZillaChanged_3.51.1.0_x64__81q6ced8g4aa0.msix" -destination "c:\temp\FileZillaChanged.cim" -applyacls -create -vhdSize 200 -filetype "cim" -rootDirectory apps
134-
msixmgr.exe -Unpack -packagePath "C:\Users\ssa\Desktop\FileZillaChanged_3.51.1.0_x64__81q6ced8g4aa0.msix" -destination "c:\temp\FileZillaChanged.vhdx" -applyacls -create -vhdSize 200 -filetype "vhdx" -rootDirectory apps
145+
msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp"
135146
```
136147

148+
149+
-fileType [VHD | VHDX | CIM] -rootDirectory [Root directory on an image to unpack packages to. For CIM files only] -vhdSize [between 5 and 204000 MB. For VHD or VHDX files only]
150+
137151
|Optional parameters|Description|Example|
138152
| -------- | -------- | -------- |
139-
|-packagePath|Specifies path to package to unpack OR path to a directory containing multiple packages to unpack|`msixmgr.exe -Unpack -packagePath "C:\Users\ssa\Desktop\FileZillaChanged_3.51.1.0_x64__81q6ced8g4aa0.msix"`|
140-
|-destination|Specifies directory to place the resulting package folder(s) in|`msixmgr.exe -Unpack -packagePath "C:\Users\ssa\Desktop\FileZillaChanged_3.51.1.0_x64__81q6ced8g4aa0.msix" -destination "c:\temp\FileZillaChanged.vhdx"`|
141-
|-applyacls|Applies ACLs to the resulting package folder(s) and their parent folder  |`msixmgr.exe -Unpack -packagePath "C:\Users\ssa\Desktop\FileZillaChanged_3.51.1.0_x64__81q6ced8g4aa0.msix" -destination "c:\temp\FileZillaChanged.vhdx" -applyacls`|
142-
|-rootDirectory|Specifies root directory on image to unpack packages to. Required parameter for unpacking to new and existing CIM files  |`msixmgr.exe -Unpack -packagePath "C:\Users\ssa\Desktop\FileZillaChanged_3.51.1.0_x64__81q6ced8g4aa0.msix" -destination "c:\temp\FileZillaChanged.vhdx" -applyacls -create -vhdSize 200 -filetype "vhdx" -rootDirectory apps`|
143-
|-validateSignature|Validates a package's signature file before unpacking package. This parameter will require that the package's certificate is installed on the machine.||
144-
|Read more: (Certificate Stores) [https://learn.microsoft.com/windows-hardware/drivers/install/certificate-stores](/windows-hardware/drivers/install/certificate-stores)|`msixmgr.exe -Unpack -packagePath "C:\vlc.msix" -destination "D:\VLC" -validateSignature -applyacls`||
145-
146-
**-?**
147-
Display Help at the command prompt
153+
|-applyacls|Applies ACLs to the resulting package folder(s) and their parent folder. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs` |
154+
|-create|Creates a new image with the specified -filetype and unpacks the packages to that image. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs -create -fileType VHDX -vhdSize 200` |
155+
|-fileType|The type of file to unpack packages to. Valid file types include `VHD`, `VHDX`, `CIM`. This is a required parameter when unpacking to CIM files. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs -create -fileType CIM -rootDirectory apps` |
156+
|-rootDirectory|Specifies root directory on image to unpack packages to. Required parameter for unpacking to new and existing CIM files. |`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\myapp" -applyACLs -create -filetype CIM -rootDirectory apps` |
157+
|-validateSignature|Validates a package's signature file before unpacking package. This parameter will require that the package's certificate is installed on the machine.<br /><br />For more information, see [Certificate Stores](/windows-hardware/drivers/install/certificate-stores).|`msixmgr.exe -Unpack -packagePath "C:\SomeDirectory\myapp.msix" -destination "C:\Apps\Myapp" -validateSignature -applyACLs`|
158+
159+
### -?
160+
161+
Display help text at the command prompt.
162+
148163
Example:
149164

150165
```
@@ -153,21 +168,13 @@ msixmgr.exe -?
153168

154169
## Next steps
155170

156-
Learn more about MSIX app attach at [What is MSIX app attach?](/azure/virtual-desktop/what-is-app-attach)
157-
To learn how to set up app attach, check out these articles:
171+
To learn more about MSIX app attach, check out these articles:
158172

173+
- [What is MSIX app attach?](/azure/virtual-desktop/what-is-app-attach)
159174
- [Set up MSIX app attach with the Azure portal](/azure/virtual-desktop/app-attach-azure-portal)
160175
- [Set up MSIX app attach using PowerShell](/azure/virtual-desktop/app-attach-powershell)
161176
- [Create PowerShell scripts for MSIX app attach](/azure/virtual-desktop/app-attach)
162177
- [Prepare an MSIX image for Azure Virtual Desktop](/azure/virtual-desktop/app-attach-image-prep)
163-
- [Set up a file share for MSIX app attach](/azure/virtual-desktop/app-attach-file-share)
164-
165-
166-
167-
If you have questions about MSIX app attach, see our [App attach FAQ](/azure/virtual-desktop/app-attach-faq) and [App attach glossary](/azure/virtual-desktop/app-attach-glossary)
168-
169-
170-
171-
172-
178+
- [Set up a file share for MSIX app attach](/azure/virtual-desktop/app-attach-file-share)
173179

180+
If you have questions about MSIX app attach, see our [App attach FAQ](/azure/virtual-desktop/app-attach-faq) and [App attach glossary](/azure/virtual-desktop/app-attach-glossary).

0 commit comments

Comments
 (0)