Skip to content

AppSharedPackageContainer Documentation #2915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 26 commits into from
Mar 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
755b293
SharedPackage Doc
huzaifa-msft Mar 17, 2022
0808d2b
Update docset/winserver2022-ps/appx/Reset-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
d75bb5f
Update docset/winserver2022-ps/appx/Reset-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
109f586
Update docset/winserver2022-ps/appx/Add-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
b11684f
Update docset/winserver2022-ps/appx/Reset-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
403dd75
Update docset/winserver2022-ps/appx/Reset-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
b8b9809
Update docset/winserver2022-ps/appx/Add-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
9d33b17
Update docset/winserver2022-ps/appx/Add-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
98aa2d6
Update docset/winserver2022-ps/appx/Reset-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
743d970
Update docset/winserver2022-ps/appx/Remove-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
9e81d6d
Update docset/winserver2022-ps/appx/Get-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
6c3e789
Update docset/winserver2022-ps/appx/Add-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
e15c6f0
Update docset/winserver2022-ps/appx/Get-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
29e8b45
Update docset/winserver2022-ps/appx/Add-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
ff226d8
Update docset/winserver2022-ps/appx/Get-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
1a54273
Update docset/winserver2022-ps/appx/Get-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
932f277
Update docset/winserver2022-ps/appx/Remove-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
2253978
Update docset/winserver2022-ps/appx/Remove-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
dad61c7
Update docset/winserver2022-ps/appx/Remove-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
1432545
Update docset/winserver2022-ps/appx/Add-AppSharedPackageContainer.md
huzaifa-d Mar 18, 2022
db80bb7
Apply suggestions from code review
huzaifa-d Mar 18, 2022
10b18f5
Removed Get/Set-NonRemovableAppsPolicy
huzaifa-msft Mar 18, 2022
7a0f59f
Revert "Removed Get/Set-NonRemovableAppsPolicy"
huzaifa-msft Mar 18, 2022
c9d3b1e
Removed Get/Set-NonRemovableAppsPolicy from Appx
huzaifa-msft Mar 18, 2022
c752a3d
Add markdown for Remove-AppxPackageAutoUpdateSettings
sdwheeler Mar 18, 2022
35d2c24
Update module landing page
sdwheeler Mar 18, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 110 additions & 0 deletions docset/winserver2022-ps/appx/Add-AppSharedPackageContainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml
Module Name: appx
online version: https://docs.microsoft.com/powershell/module/appx/add-appsharedpackagecontainer?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
---

# Add-AppSharedPackageContainer

## SYNOPSIS
Deploys the shared package container definiton.

## SYNTAX

```
Add-AppSharedPackageContainer [-Path] <String> [-ForceApplicationShutdown] [-Merge] [-Force]
[<CommonParameters>]
```

## DESCRIPTION
The Add-AppSharedPackageContainer cmdlet deploys the shared package container definiton for the particular user.

## EXAMPLES

### Example 1
```powershell
PS C:\> Add-AppSharedPackageContainer -Path C:\MyFolder\ContosoTestContainer.xml
```

This command deploys the definition described in the ContosoTestContainer file.

## PARAMETERS

### -Force
Replaces an existing container of the same name with the newly created
container's definition for the target user(s).


```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -ForceApplicationShutdown
Closes all packages currently running in the Shared Package Container.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Merge
Merges a new container's definition into an existing container
definition of the same name for target user(s).


```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Path
Path to the XML definition file.

```yaml
Type: String
Parameter Sets: (All)
Aliases: PSPath

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### System.Object
## NOTES

## RELATED LINKS
36 changes: 28 additions & 8 deletions docset/winserver2022-ps/appx/Appx.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Help Version: 5.0.6.4
Locale: en-US
Module Guid: aeef2bef-eba9-4a1d-a3d2-d0b52df76deb
Module Name: Appx
ms.date: 05/19/2017
ms.date: 03/18/2022
title: Appx
---

Expand All @@ -14,6 +14,10 @@ title: Appx
The Windows PowerShell cmdlets for AppX are designed to streamline the administration of MSIX or AppX package management.

## Appx Cmdlets

### [Add-AppSharedPackageContainer](Add-AppSharedPackageContainer.md)
Deploys the shared package container definiton.

### [Add-AppxPackage](Add-AppxPackage.md)
Adds a signed app package to a user account.

Expand All @@ -23,6 +27,9 @@ Adds an appx volume to the Package Manager.
### [Dismount-AppxVolume](Dismount-AppxVolume.md)
Dismounts an appx volume.

### [Get-AppSharedPackageContainer](Get-AppSharedPackageContainer.md)
Gets information about the shared package container.

### [Get-AppxDefaultVolume](Get-AppxDefaultVolume.md)
Gets the default appx volume.

Expand All @@ -35,31 +42,44 @@ Gets an app package installation log.
### [Get-AppxPackage](Get-AppxPackage.md)
Gets a list of the app packages that are installed in a user profile.

### [Get-AppxPackageAutoUpdateSettings](Get-AppxPackageAutoUpdateSettings.md)
Provides visibility to the settings configured on a Windows 10 client device for a particular Windows App.

### [Get-AppxPackageManifest](Get-AppxPackageManifest.md)
Gets the manifest of an app package.

### [Get-AppxVolume](Get-AppxVolume.md)
Gets appx volumes for the computer.

### [Get-NonRemovableAppsPolicy](Get-NonRemovableAppsPolicy.md)
Returns the a list of the app packages that are installed and configured as non-removable apps.
### [Invoke-CommandInDesktopPackage](Invoke-CommandInDesktopPackage.md)
Runs a command in the context of a specified app package.

### [Mount-AppxVolume](Mount-AppxVolume.md)
Mounts an appx volume.

### [Move-AppxPackage](Move-AppxPackage.md)
Moves a package from its current location to another appx volume.

### [Remove-AppSharedPackageContainer](Remove-AppSharedPackageContainer.md)
Removes the shared package container.

### [Remove-AppxPackage](Remove-AppxPackage.md)
Removes an app package from a user account.
Removes an app package from one or more user accounts.

### [Remove-AppxPackageAutoUpdateSettings](Remove-AppxPackageAutoUpdateSettings.md)
{{ Fill in the Synopsis }}

### [Remove-AppxVolume](Remove-AppxVolume.md)
Removes an appx volume.

### [Set-AppxDefaultVolume](Set-AppxDefaultVolume.md)
Specifies a default appx volume.
### [Reset-AppSharedPackageContainer](Reset-AppSharedPackageContainer.md)
Destroys all the application data of the container.

### [Set-NonRemovableAppsPolicy](Set-NonRemovableAppsPolicy.md)
Sets an app packages as non-removable (can not be uninstalled).
### [Reset-AppxPackage](Reset-AppxPackage.md)
Use to reset your installed Windows Apps. Restores the Windows app to its initial configuration.

### [Set-AppxDefaultVolume](Set-AppxDefaultVolume.md)
Specifies a default appx volume.

### [Set-AppxPackageAutoUpdateSettings](Set-AppxPackageAutoUpdateSettings.md)
Provides access to configure a specific Windows App's Auto Update and Repair settings. Including pausing update checks.
100 changes: 100 additions & 0 deletions docset/winserver2022-ps/appx/Get-AppSharedPackageContainer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
---
external help file: Microsoft.Windows.Appx.PackageManager.Commands.dll-Help.xml
Module Name: appx
online version: https://docs.microsoft.com/powershell/module/appx/get-appsharedpackagecontainer?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
schema: 2.0.0
---

# Get-AppSharedPackageContainer

## SYNOPSIS
Gets information about the shared package container.

## SYNTAX

```
Get-AppSharedPackageContainer [[-Name] <String>] [[-Id] <String>] [-AllUsers] [<CommonParameters>]
```

## DESCRIPTION
The cmdlet shows information about any shared package container.
In particular, it will show what packages are inside the shared package container.

## EXAMPLES

### Example 1
```powershell
PS C:\> Get-AppSharedPackageContainer -Name Contoso*


Name : ContosoTestContainer
Id : ContosoTestContainer_1
PackageFamilyNames : {Contoso.SpellCheckPlugin.1.0.0.0_7pneu3d8sswe, Notepad++.2.0.0.1_ohjis898f1}

Name : ContosoTestContainer
Id : ContosoTestContainer_2
PackageFamilyNames : {Contoso.SpellCheckPlugin2.1.0.0.0_7pneu3d8sswe, Notepad++.2.0.0.1_ohjis898f1}
```

This command shows the packages in any shared package container that has a prefix of Contoso.

## PARAMETERS

### -AllUsers
Get matching packages that are either deployed to any user or are provisioned to the machine.

```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Id
Id of the container. Can be acquired by running `Get-AppSharedPackageContainer`.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### -Name
The name of the container.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```

### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### System.String

## OUTPUTS

### System.Object
## NOTES

## RELATED LINKS
Loading