Install-SPApp
Published: July 16, 2012
Applies to: SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise
Installs an instance of an app.
Install-SPApp -Identity <SPApp> -Web <SPWebPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]]
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.Administration.SPApp | Specifies the app to install. The App object is created by using the Import-SPAppPackage cmdlet. | ||
| Site | Required | Microsoft.SharePoint.PowerShell.SPWebPipeBind | Specifies the web, either as an ID or URL, in which the app will be installed. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
Detailed Description
Use the Install-SPApp cmdlet to install an instance of an app within a web application.
Input Types
Return Types
------------EXAMPLE------------
$spapp = Import-SPAppPackage -Path .\feature-upgrade-v1.spapp -Site http://localhost -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel)
$instance = Install-SPApp -Web http://localhost -Identity $spapp
This example installs an app by first importing the app package, and then installing it.
Change History
| Date | Description |
|---|---|
| July 16, 2012 | Initial publication |

Note: