Add-AppxProvisionedPackage
Adds an app package (.appx) that will install for each new user to a Windows image.
Syntax
Add-AppxProvisionedPackage
[-FolderPath <String>]
[-PackagePath <String>]
[-DependencyPackagePath <String[]>]
[-OptionalPackagePath <String[]>]
[-LicensePath <String[]>]
[-SkipLicense]
[-CustomDataPath <String>]
[-Regions <String>]
[-StubPackageOption <StubPackageOption>]
-Path <String>
[-WindowsDirectory <String>]
[-SystemDrive <String>]
[-LogPath <String>]
[-ScratchDirectory <String>]
[-LogLevel <LogLevel>]
[<CommonParameters>] Add-AppxProvisionedPackage
[-FolderPath <String>]
[-PackagePath <String>]
[-DependencyPackagePath <String[]>]
[-OptionalPackagePath <String[]>]
[-LicensePath <String[]>]
[-SkipLicense]
[-CustomDataPath <String>]
[-Regions <String>]
[-StubPackageOption <StubPackageOption>]
[-Online]
[-WindowsDirectory <String>]
[-SystemDrive <String>]
[-LogPath <String>]
[-ScratchDirectory <String>]
[-LogLevel <LogLevel>]
[<CommonParameters>] Description
The Add-AppxProvisionedPackage cmdlet adds an app package (.appx) that will install for each new user to a Windows image. If the package has dependencies that are architecture-specific, you must install the applicable architectures for the dependency on the target image. For example, you must install the x86 dependency on the x86 image.
You cannot install an app package (.appx) on an operating system that does not support Windows 8 apps. Apps are not supported on Server Core installations of Windows Server 2012, Windows Preinstallation Environment (Windows PE) 4.0, or on any versions of Windows older than Windows 8 and Windows Server 2012.
To install and run apps on Windows Server 2016, you must install the Install Server with Desktop Experience.
Use the Online parameter to specify the running operating system on your local computer, or use the Path parameter to specify the location of a mounted Windows image.
Use the PackagePath, DependencyPackagePath, and LicensePath parameters to specify the location of all the files that are needed to add the provisioned app package (.appx). Use these parameters to provision line-of-business apps.
Use the FolderPath parameter to specify the location of a folder of unpacked app package (.appx) files that includes any dependency packages and a license file.
To add an app package (.appx) for a particular user, or to test a package while developing your app, use the Add-AppxPackage cmdlet instead.
For more information, including requirements for app package provisioning, see Sideload Apps with DISM and How to develop an OEM app that uses a custom file in MicrosoftDocs.
Examples
Example 1: Add an app package to the running operating system
PS C:\> Add-AppxProvisionedPackage -Online -FolderPath "c:\Appx"This command adds the app package, dependency packages, and license file from the c:\Appx folder to the running Windows operating system. The package will be installed for the current user and any new user account created on the computer.
Example 2: Add an app package an operating system image
PS C:\> Add-AppxProvisionedPackage -Path c:\offline -PackagePath c:\Appx\myPackage.appx -DependencyPackagePath c:\Appx\dependency1\dependencyPackage.appx -LicensePath c:\Appx\myLicense.xmlThis command adds the app package, myPackage.appx, to the Windows image mounted to c:\offline.
Parameters
-CustomDataPath
Specifies the location of a custom data file. The custom data file will be renamed custom.data and saved in the app data store.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DependencyPackagePath
Specifies the location of a dependency package.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-FolderPath
Specifies a folder of unpacked app package files containing a main package and any dependency packages. This folder must also contain your application license.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LicensePath
Specifies the location of the .xml file containing your application license.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LogLevel
Specifies the maximum output level shown in the logs.
| Type: | LogLevel |
| Aliases: | LL |
| Accepted values: | Errors, Warnings, WarningsInfo |
| Position: | Named |
| Default value: | WarningsInfo |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LogPath
Specifies the full path and file name to log to.
If not set, the default is %WINDIR%\Logs\Dism\dism.log.
In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB.
The log file will automatically be archived.
The archived log file will be saved with .bak appended to the file name and a new log file will be generated.
Each time the log file is archived the .bak file will be overwritten.
When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log.
| Type: | String |
| Aliases: | LP |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Online
Specifies that the action is to be taken on the operating system that is currently running on the local computer.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-OptionalPackagePath
Specifies the path to an optional package that will also be provisioned. For more information on optional packages, see Optional packages and related set authoring.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PackagePath
Specifies the location of the app package (.appx) to add to the Windows image. This package will be added for every new user account. To add an app package (.appx) for a particular user or to test a package while developing your app, use the Add-AppxPackage cmdlet instead.
The PackagePath parameter is only supported for offline servicing when the technician computer is running a version of Windows that supports Windows 8 apps.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Path
Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a subdirectory of the root directory, WindowsDirectory must be specified.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Regions
Specifies what regions an app package (.appx or .appxbundle) must be provisioned in. The region argument can either be "all", indicating that the app should be provisioned for all regions, or it can be a semi-colon delimited list of regions. The regions will be in the form of ISO 3166-1 Alpha-2 or ISO 3166-1 Alpha-3 codes. For example, the United States can be specified as either "US" or "USA" (case-insensitive). When a list of regions is not specified, the package will be provisioned only if it is pinned to start layout.
Note: Option is available on client OS.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ScratchDirectory
Specifies a temporary directory that will be used when extracting files for use during servicing.
The directory must exist locally.
If not specified, the \Windows\%Temp% directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM.
Items in the scratch directory are deleted after each operation.
You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation.
The directory used for extracting files for temporary usage during servicing should be a local directory.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SkipLicense
Adds an app package without a license file.
Only use SkipLicense with apps that do not require a license on Enterprise or Server versions of the operating system. Using SkipLicense in other scenarios can compromise an image.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-StubPackageOption
Specifies the stub preference of the package. If no stub package option is specified then the provisioned package version is set to the predefined stub preferences.
| Type: | StubPackageOption |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SystemDrive
Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WindowsDirectory
Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a relative path. If not specified, the default is the Windows directory in the root of the offline image directory.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
String[]
Microsoft.Dism.Commands.ImageObject
Microsoft.Dism.Commands.AppxPackageObject
Outputs
Microsoft.Dism.Commands.ImageObject