Install-SPApp

Module:

sharepoint-server

Applies to:

SharePoint Server Subscription Edition

Installs an instance of an app.

Syntax

Install-SPApp
       -Identity <SPApp>
       [-AssignmentCollection <SPAssignmentCollection>]
       [-Confirm]
       [-WhatIf]
       -Web <SPWebPipeBind>
       [<CommonParameters>]

Description

Use the Install-SPApp cmdlet to install an instance of an app within a web application.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

Examples

------------EXAMPLE------------

$spapp = Import-SPAppPackage -Path .\feature-upgrade-v1.spapp -Site https://site_url -Source ([microsoft.sharepoint.administration.spappsource]::ObjectModel)
Install-SPApp -Web https://site_url -Identity $spapp

This example installs an app by first importing the app package, and then installing it.

Parameters

-AssignmentCollection

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.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Type:	SPAssignmentCollection
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Confirm

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Identity

Specifies the app to install. The App object is created by using the Import-SPAppPackage cmdlet.

Type:	SPApp
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-Web

Specifies the SPWeb object of the app.

Type:	SPWebPipeBind
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	SharePoint Server Subscription Edition

Related Links

• Import-SPAppPackage