UniversalAppInstall (reference)

Article
02/05/2024

Use UniversalAppInstall settings to install Windows apps from the Microsoft Store or a hosted location.

Note

You can only use the Windows provisioning settings and provisioning packages for apps where you have the available installation files, namely with sideloaded apps that have an offline license. Learn more about offline app distribution.

Applies to

Setting	Windows client	Surface Hub	IoT Core
DeviceContextApp	✅	✅
DeviceContextAppLicense	✅	✅
StoreInstall	✅	✅	✅
UserContextApp	✅	✅	✅
UserContextAppLicense	✅	✅	✅

DeviceContextApp

Enter an app package family name to install an app for all device users. You can use the Get-AppxPackage cmdlet to get the package family name for an installed app.

Note

For XAP files, enter the product ID.

For each app that you add to the package, configure the settings in the following table.

Setting	Value	Description
ApplicationFile	`.appx` or `.appxbundle`	Set the value to the app file that you want to install on the device. Also enable the AllowAllTrustedApps setting and add a root certificate or license file.
DependencyAppxFiles	Any required frameworks	In Microsoft Store for Business, any dependencies for the app are listed in the Required frameworks section of the download page.
DeploymentOptions	- None -Force application shutdown: If this package, or any package that depends on this package is currently in use, then the processes associated with the package are forcibly shut down. The registration can continue. - Development mode: Don't use. - Install all resources: When you set this option, the app is instructed to skip resource applicability checks. - Force target application shutdown: If this package is currently in use, the processes associated with the package are shut down forcibly so that registration can continue	Select a deployment option.
LaunchAppAtLogin	- Don't launch app - Launch app	Set the value for app behavior when a user signs in.
OptionalPackageFiles	Additional files required by the package	Browse to, select, and add the optional package files.

For more information on deployment options, see DeploymentOptions Enum.

DeviceContextAppLicense

Use to specify the license file for the provisioned app.

Specify a LicenseProductId for the app. You can find the license ID in the root header of the license file. For example, enter LicenseID="aaaaaaaa-dddd-8848-f8d0-7d6a93dfcccc". Enter it in the LicenseProductId field, and select Add.
Select the LicenseProductId in the Available Customizations pane, and then browse to and select the app license file.

StoreInstall

Use to install an app from the Microsoft Store for Business.

Enter a package family name, and then select Add.
Configure the following required settings for the app package.

Setting	Description
Flags	Description not available at this time.
ProductID	Enter the product ID. Learn how to find the product ID.
SkuID	Enter the SKU ID. Learn how to find the SKU ID.

UserContextApp

Use to add a new user context app.

Specify a PackageFamilyName for the app, and then select Add.
Select the PackageFamilyName in the Available Customizations pane, and then configure the following settings.

Setting	Value	Description
ApplicationFile	App file	Browse to, select, and add the application file,
DependencyAppxFiles	Additional files required by the app	Browse to, select, and add dependency files.
DeploymentOptions	- None - Force application shutdown - Development mode - Install all resources - Force target application shutdown	Select a deployment option.
LaunchAppAtLogin	- Don't launch app - Launch app	Select whether the app should be started when a user signs in.

UserContextAppLicense

Use to specify the license file for the user context app.

Specify a LicenseProductId for the app. You can find the license ID in the root header of the license file. For example, enter LicenseID="aaaaaaaa-dddd-8848-f8d0-7d6a93dfcccc". Enter it in the LicenseProductId field, and select Add.
Select the LicenseProductId in the Available Customizations pane, and then browse to and select the app license file.