Install-PnPApp

Installs an available app from the app catalog

Syntax

Install-PnPApp
       -Identity <AppMetadataPipeBind>
                     [-Scope <AppCatalogScope>]
                     [-Wait [<SwitchParameter>]]
                     [-Connection <SPOnlineConnection>]

Examples

------------------EXAMPLE 1------------------

Install-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe

This will install an app that is available in the tenant scoped app catalog, specified by the id, to the current site.

------------------EXAMPLE 2------------------

Install-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site

This will install an app that is available in the site collection scoped app catalog, specified by the id, to the current site.

------------------EXAMPLE 3------------------

Get-PnPAvailableApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe | Install-PnPApp

This will install the given app from the tenant scoped app catalog into the site.

------------------EXAMPLE 4------------------

Get-PnPAvailableApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site | Install-PnPApp

This will install the given app from the site collection scoped app catalog into the site.

Parameters

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Only applicable to: SharePoint Online, SharePoint Server 2019

Type:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Identity

Specifies the Id or an actual app metadata instance

Only applicable to: SharePoint Online, SharePoint Server 2019

Type:AppMetadataPipeBind
Position:0
Accept pipeline input:True
Accept wildcard characters:False
-Scope

Defines which app catalog to use. Defaults to Tenant

Only applicable to: SharePoint Online, SharePoint Server 2019

Type:AppCatalogScope
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Wait

If specified the execution will pause until the app has been installed in the site.

Only applicable to: SharePoint Online, SharePoint Server 2019

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False