Export (0) Print
Expand All

Set-AppXProvisionedDataFile

Windows Server 2012 R2 and Windows 8.1

Updated: June 4, 2014

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Set-AppXProvisionedDataFile

Adds custom data into the specified app (.appx) package that has been provisioned in a Windows image.

Syntax

Parameter Set: Offline
Set-AppXProvisionedDataFile -CustomDataPath <String> -PackageName <String> -Path <String> [-LogLevel <LogLevel> ] [-LogPath <String> ] [-ScratchDirectory <String> ] [-SystemDrive <String> ] [-WindowsDirectory <String> ] [ <CommonParameters>]

Parameter Set: Online
Set-AppXProvisionedDataFile -CustomDataPath <String> -Online -PackageName <String> [-LogLevel <LogLevel> ] [-LogPath <String> ] [-ScratchDirectory <String> ] [-SystemDrive <String> ] [-WindowsDirectory <String> ] [ <CommonParameters>]




Detailed Description

The Set-AppXProvisionedDataFile cmdlet adds custom data into the specified app (.appx) package that has been provisioned in a Windows image. The specified app (.appx) package must already be added to the image prior to adding custom data.

You cannot install an app package (.appx) on an operating system that does not support apps for at least Windows® 8. Apps are not supported on Server Core installations of Windows Server, Windows PE, or on any versions of Windows older than Windows 8 and Windows Server 2012.

To install and run apps on Windows Server, you must install the 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.

Parameters

-CustomDataPath<String>

Specifies an optional custom data file for an app. You can specify any file name. The file will be renamed to Custom.dat when it is added to the image. If a Custom.dat file already exists, it will be overwritten.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-LogLevel<LogLevel>

Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows:1 = Errors only2 = Errors and warnings3 = Errors, warnings, and information4 = All of the information listed previously, plus debug output


Aliases

LL

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-LogPath<String>

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.


Aliases

LP

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PackageName<String>

Specifies the name of a package in the Windows image.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Path<String>

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.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-ScratchDirectory<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-SystemDrive<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-WindowsDirectory<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String[]
  • Microsoft.Dism.Commands.ImageObject
  • Microsoft.Dism.Commands.AppxPackageObject

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Dism.Commands.ImageObject

Examples

Example 1

This command adds the custom data file, c:\Appx\myCustomData.dat, into the app package, MyAppxPkg, that has been added to the running Windows operating system.


PS C:\> Set-AppXProvisionedDataFile -Online -PackageName MyAppxPkg -CustomDataPath c:\Appx\myCustomData.dat

Example 2

This command adds the custom data file, c:\Appx\myCustomData.dat, into the app package, MyAppxPkg, that has been added to the Windows image mounted to c:\offline.


PS C:\> Set-AppxProvisionedDataFile -Path c:\offline -PackageName MyAppxPkg -CustomDataPath c:\Appx\myCustomData.dat

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft