Set-PnPHomePage

  • Reference
Module:
PnP.Powershell
Applies to:
SharePoint Online

Tip

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

Sets the home page of the current web.

Syntax

Set-PnPHomePage
   [-RootFolderRelativeUrl] <String>
   [-Connection <PnPConnection>]
   [<CommonParameters>]

Examples

EXAMPLE 1

Set-PnPHomePage -RootFolderRelativeUrl SitePages/Home.aspx

Sets the home page to the home.aspx file which resides in the SitePages library

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
-RootFolderRelativeUrl

The root folder relative url of the homepage, e.g. 'sitepages/home.aspx'

Type:String
Aliases:Path
Position:0
Default value:None
Accept pipeline input:True
Accept wildcard characters:False