Add-PnPApp

Tip

We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Add-PnPApp.md to change this file.

Add/uploads an available app to the app catalog

Syntax

Add-PnPApp
   [-Path] <String>
   [-Scope <AppCatalogScope>]
   [-Overwrite]
   [-Timeout <Int32>]
   [-Publish
   [-SkipFeatureDeployment]]
   [-Connection <PnPConnection>]
   [<CommonParameters>]

Examples

EXAMPLE 1

Add-PnPApp -Path ./myapp.sppkg

This will upload the specified app package to the app catalog

EXAMPLE 2

Add-PnPApp -Path ./myapp.sppkg -Publish

This will upload the specified app package to the app catalog and deploy/trust it at the same time.

EXAMPLE 3

Add-PnPApp -Path ./myapp.sppkg -Scope Site -Publish

This will upload the specified app package to the site collection app catalog and deploy/trust it at the same time.

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.

Type:PnPConnection
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Overwrite

Overwrites the existing app package if it already exists

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Path

Specifies the Id or an actual app metadata instance

Type:String
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Publish

This will deploy/trust an app into the app catalog

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Scope

Defines which app catalog to use. Defaults to Tenant

Type:AppCatalogScope
Accepted values:Tenant, Site
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SkipFeatureDeployment
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Timeout

Specifies the timeout in seconds. Defaults to 200.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False