Set-PnPHomePage.md

external help file	applicable	schema
	SharePoint Server 2013, SharePoint Server 2016, SharePoint Online	2.0.0

Set-PnPHomePage

SYNOPSIS

Sets the home page of the current web.

SYNTAX

Set-PnPHomePage -RootFolderRelativeUrl <String>
                [-Web <WebPipeBind>]
                [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> Set-PnPHomePage -RootFolderRelativeUrl SitePages/Home.aspx

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

PARAMETERS

-RootFolderRelativeUrl

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

Type: String
Parameter Sets: (All)
Aliases: Path

Required: True
Position: 0
Accept pipeline input: True

-Connection

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

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type: WebPipeBind
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

RELATED LINKS

SharePoint Developer Patterns and Practices