Adds an app package (.appx) that will install for each new user to a Windows image. via Deployment Image Servicing and Management.
Syntax
Add-AppxProvisionedPackage {-Path String | [-Online]}
[-FolderPath String] [-PackagePath String] [-DependencyPackagePath String[]]
[-OptionalPackagePath String[]] [-LicensePath String[]] [-SkipLicense]
[-CustomDataPath String] [-Regions String] [-StubPackageOption StubPackageOption]
[-WindowsDirectory String] [-SystemDrive String] [-ScratchDirectory String]
[-LogPath String] [-LogLevel LogLevel] [CommonParameters]
Key
-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.
-DependencyPackagePath
Specifies the location of a dependency package.
-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.
-LicensePath
Specifies the location of the .xml file containing your application license.
-LogLevel
The maximum output level shown in the logs. The default log level is 3. Alias 'll'.
The accepted values are as follows:
1 = Errors only
2 = Errors and warnings
3 = Errors, warnings, and information
-LogPath
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.
-Online
Specifies that the action is to be taken on the Operating System that is currently
running on the local computer.
-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 Add-AppxPackage 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.
-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.
-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.
-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.
-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.
-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.
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.
This cmdlet was introduced in Windows PowerShell 5.0.
Add an app package to the running Operating System:
PS C:\> Add-AppxProvisionedPackage -Online -FolderPath "c:\ss64"
Add an app package an Operating System image:
PS C:\> Add-AppxProvisionedPackage -Path c:\offline -PackagePath c:\ss64\ss64Package.appx -DependencyPackagePath c:\ss64\dependency1\dependencyPackage.appx -LicensePath c:\ss64\ss64License.xml
“No law can give power to private persons; every law transfers power from private persons to government” ~ Isabel Paterson
Add-AppxPackage - Remove an app package from a user account.
Get-AppxProvisionedPackage - Get information about appx packages in an image via DISM.