Skip to content

Commit d7a89d1

Browse files
fiza-azmifiza-azmi
committed
Learn Editor: Update msixmgr-tool-syntax-description.md
1 parent f429572 commit d7a89d1

File tree

1 file changed

+61
-40
lines changed

1 file changed

+61
-40
lines changed

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

Lines changed: 61 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -19,64 +19,77 @@ This article contains an overview of the command-line syntax to help you underst
1919

2020
## Prerequisites:
2121

22-
- [Requirements](/azure/virtual-desktop/app-attach-msixmgr#requirements)
23-
- [MSIX App Attach](/azure/virtual-desktop/app-attach-azure-portal)
24-
- [Using the MSIXMGR tool](/azure/virtual-desktop/app-attach-msixmgr)
22+
Before you can follow the instructions in this article, you'll need to do the following things:
2523

24+
- [Download the MSIXMGR tool](https://aka.ms/msixmgr)
25+
- Get an MSIX-packaged application (.MSIX file)
26+
- Get administrative permissions on the machine where you'll create the MSIX image
27+
- [Set up MSIXMGR tool](/azure/virtual-desktop/app-attach-msixmgr)
2628

2729
## Syntax
2830

2931

30-
**-AddPackage or -p**
3132

32-
|Description|Example|
33-
| -------- | -------- |
34-
|Adds package at specified file path|-AddPackage [path to the MSIX package] [optional arguments]|
35-
||`msixmgr.exe -AddPackage C:\SomeDirectory\notepadplus.msix`|
33+
**-AddPackage or -p
34+
**
35+
Adds package at specified file path
36+
Example:
37+
-AddPackage [path to the MSIX package] [optional arguments]
38+
39+
```
40+
msixmgr.exe -AddPackage C:\SomeDirectory\notepadplus.msix
41+
```
3642

3743
|Optional parameters|Description|Example|
3844
| -------- | -------- | -------- |
3945
|-QuietUX|Installs MSIX package silently, without any user interaction|`msixmgr.exe -AddPackage C:\SomeDirectory\notepadplus.msix -QuietUX`  |
4046

47+
**-RemovePackage or -x**
48+
Removes package with specified package full name
49+
Example:
50+
-RemovePackage [Package Name] [optional arguments]
4151

42-
**-RemovePackage or -x**
43-
44-
|Description|Example|
45-
| -------- | -------- |
46-
|Removes package with specified package full name|-RemovePackage [Package Name] [optional arguments]|
47-
||`msixmgr.exe -RemovePackage notepadplus_0.0.0.1_x64__8wekyb3d8bbwe`|
52+
```
53+
msixmgr.exe -RemovePackage notepadplus_0.0.0.1_x64__8wekyb3d8bbwe
54+
```
4855

4956
|Optional parameters|Description|Example|
5057
| -------- | -------- | -------- |
5158
|-QuietUX|Uninstalls MSIX package silently, without any user interaction|`msixmgr.exe -RemovePackage notepadplus_0.0.0.1_x64__8wekyb3d8bbwe msix `-QuietUX  |
5259

5360

5461

55-
**- FindPackage**
62+
**- FindPackage**
63+
Finds package with specific package full name
64+
Example:
5665

57-
|Description|Example|
58-
| -------- | -------- |
59-
|Finds package with specific package full name|`msixmgr.exe -FindPackage notepadplus_0.0.0.1_x64__8wekyb3d8bbwe`|
66+
```
67+
msixmgr.exe -FindPackage notepadplus_0.0.0.1_x64__8wekyb3d8bbwe
68+
```
6069

6170

6271

63-
**-applyacls**
72+
**-applyacls**
73+
Applies ACLs to a package folder (an unpacked package)
74+
Example:
6475

65-
|Description|Example|
66-
| -------- | -------- |
67-
|Applies ACLs to a package folder (an unpacked package)|`msixmgr.exe -applyacls`|
76+
```
77+
msixmgr.exe -applyacls
78+
```
6879

6980
|Optional parameters|Description|Example|
7081
| -------- | -------- | -------- |
7182
|-packagePath|Specifies path to folder to apply ACLs to  |`msixmgr.exe -applyacls -packagePath C:\name_version_arch_pub` |
7283

7384

7485

75-
**-MountImage**
86+
**-MountImage**
87+
Mounts VHD, VHDX, or CIM image
88+
Example:
7689

77-
|Description|Example|
78-
| -------- | -------- |
79-
|Mounts VHD, VHDX, or CIM image|`msixmgr.exe -MountImage`|
90+
```
91+
msixmgr.exe -MountImage
92+
```
8093

8194
|Optional parameters|Description|Example|
8295
| -------- | -------- | -------- |
@@ -87,11 +100,13 @@ This article contains an overview of the command-line syntax to help you underst
87100

88101

89102

90-
**-UnmountImage**
103+
**-UnmountImage**
104+
Unmounts VHD, VHDX, or CIM image
105+
Example:
91106

92-
|Description|Example|
93-
| -------- | -------- |
94-
|Unmounts VHD, VHDX, or CIM image|`msixmgr.exe -UnmountImage`|
107+
```
108+
msixmgr.exe -UnmountImage
109+
```
95110

96111
|Optional parameters|Description|Example|
97112
| -------- | -------- | -------- |
@@ -101,11 +116,14 @@ This article contains an overview of the command-line syntax to help you underst
101116

102117

103118

104-
**-Unpack**
119+
**-Unpack**
120+
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
121+
Example:
105122

106-
|Description|Example|
107-
| -------- | -------- |
108-
|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|CIM example `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`   VHDX example `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`  |
123+
```
124+
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
125+
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
126+
```
109127

110128
|Optional parameters|Description|Example|
111129
| -------- | -------- | -------- |
@@ -116,16 +134,17 @@ This article contains an overview of the command-line syntax to help you underst
116134
|-validateSignature|Validates a package's signature file before unpacking package. This parameter will require that the package's certificate is installed on the machine.||
117135
|Read more: [https://learn.microsoft.com/en-us/windows-hardware/drivers/install/certificate-stores](/windows-hardware/drivers/install/certificate-stores)|`msixmgr.exe -Unpack -packagePath "C:\vlc.msix" -destination "D:\VLC" -validateSignature -applyacls`||
118136

119-
**-?**
120-
121-
|Description|Example|
122-
| -------- | -------- |
123-
|Display Help at the command prompt|`msixmgr.exe -?`|
137+
**-?**
138+
Display Help at the command prompt
139+
Example:
124140

141+
```
142+
msixmgr.exe -?
143+
```
125144

126145
## Next steps
146+
127147
Learn more about MSIX app attach at [What is MSIX app attach?](/azure/virtual-desktop/what-is-app-attach)
128-
129148
To learn how to set up app attach, check out these articles:
130149

131150
- [Set up MSIX app attach with the Azure portal](/azure/virtual-desktop/app-attach-azure-portal)
@@ -135,6 +154,8 @@ To learn how to set up app attach, check out these articles:
135154
- [Set up a file share for MSIX app attach](/azure/virtual-desktop/app-attach-file-share)
136155

137156

157+
138158
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)
139159

140160

161+

0 commit comments

Comments
 (0)