|
| 1 | +--- |
| 2 | +title: Appx |
| 3 | +parent: Provider Catalog |
| 4 | +--- |
| 5 | + |
| 6 | +# Appx_Package_Provider |
| 7 | + |
| 8 | +## about_Appx_Package_Provider |
| 9 | + |
| 10 | +## Short Description |
| 11 | + |
| 12 | +Provides access to Appx. |
| 13 | + |
| 14 | +## Long Description |
| 15 | + |
| 16 | +The Appx package provider for `AnyPackage` module lets you use Appx using |
| 17 | +standardized commands. |
| 18 | + |
| 19 | +The Appx package provider supports the following cmdlets. |
| 20 | + |
| 21 | +- Find-Package |
| 22 | +- Get-Package |
| 23 | +- Install-Package |
| 24 | +- Uninstall-Package |
| 25 | + |
| 26 | +## Dynamic Parameters |
| 27 | + |
| 28 | +Dynamic parameters are cmdlet parameters that are added by a package provider |
| 29 | +and are available only when `-Provider Appx` parameter is used. |
| 30 | + |
| 31 | +### AllUsers \<System.Management.Automation.SwitchParameter\> |
| 32 | + |
| 33 | +Indicates that this cmdlet lists app packages for all user accounts on the |
| 34 | +computer. To use this parameter, you must run the command with administrator |
| 35 | +permissions. |
| 36 | + |
| 37 | +#### Cmdlets Supported |
| 38 | + |
| 39 | +- Get-Package |
| 40 | + |
| 41 | +### PackageTypeFilter \<Windows.Management.Deployment.PackageTypes\> |
| 42 | + |
| 43 | +Specifies one or more comma-separated types of packages that the cmdlet gets |
| 44 | +from the package repository. |
| 45 | + |
| 46 | +By default, this cmdlet returns only packages of types Main and Framework. |
| 47 | + |
| 48 | +PackageTypeFilter types supported are: |
| 49 | + |
| 50 | +- Main |
| 51 | +- Framework |
| 52 | +- Resource |
| 53 | +- Bundle |
| 54 | +- Xap |
| 55 | +- Optional |
| 56 | + |
| 57 | +#### Cmdlets Supported |
| 58 | + |
| 59 | +- Get-Package |
| 60 | + |
| 61 | +### Publisher \<System.String\> |
| 62 | + |
| 63 | +Specifies the publisher of a particular package. If you specify this parameter, |
| 64 | +the cmdlet returns results only for this publisher. Wildcards are permitted. |
| 65 | + |
| 66 | +#### Cmdlets Supported |
| 67 | + |
| 68 | +- Get-Package |
| 69 | + |
| 70 | +### Volume \<Microsoft.Windows.Appx.PackageManager.Commands.AppxVolume\> |
| 71 | + |
| 72 | +Specifies an AppxVolume object. If you specify this parameter, this cmdlet |
| 73 | +returns only packages that are relative to volume that this parameter specifies. |
| 74 | + |
| 75 | +#### Cmdlets Supported |
| 76 | + |
| 77 | +- Get-Package |
| 78 | + |
| 79 | +### User \<System.String\> |
| 80 | + |
| 81 | +Specifies a user. If you specify this parameter, the cmdlet returns a list of |
| 82 | +app packages that are installed for only the user that this cmdlet specifies. To |
| 83 | +get the list of packages for a user profile other than the profile for the |
| 84 | +current user, you must run this command with administrator permissions. The user |
| 85 | +name can be in one of these formats: |
| 86 | + |
| 87 | +- domain\user_name |
| 88 | +- user_name\@fqn.domain.tld |
| 89 | +- user_name |
| 90 | +- SID-string |
| 91 | + |
| 92 | +#### Cmdlets Supported |
| 93 | + |
| 94 | +- Get-Package |
| 95 | +- Uninstall-Package |
| 96 | + |
| 97 | +### PreserveRoamableApplicationData \<System.Management.Automation.SwitchParameter\> |
| 98 | + |
| 99 | +Preserves the roamable portion of the app's data when the package is removed. |
| 100 | +This parameter is incompatible with PreserveApplicationData. |
| 101 | + |
| 102 | +#### Cmdlets Supported |
| 103 | + |
| 104 | +- Uninstall-Package |
| 105 | + |
| 106 | +### PreserveApplicationData \<System.Management.Automation.SwitchParameter\> |
| 107 | + |
| 108 | +Specifies that the cmdlet preserves the application data during the package |
| 109 | +removal. The application data is available for later use. Note that this is only |
| 110 | +applicable for apps that are under development so this option can only be |
| 111 | +specified for apps that are registered from file layout (Loose file registered). |
| 112 | + |
| 113 | +#### Cmdlets Supported |
| 114 | + |
| 115 | +- Uninstall-Package |
| 116 | + |
| 117 | +## See Also |
| 118 | + |
| 119 | +- [about_Package_Providers](../../reference/about_Package_Providers.md) |
| 120 | +- [about_AnyPackage](../../reference/about_AnyPackage.md) |
0 commit comments