Table of Contents

Set-PnPHomePage

SYNOPSIS

Sets the home page of the current web.

SYNTAX

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

DESCRIPTION

Allows to set the home page of the current site.

EXAMPLES

EXAMPLE 1

Set-PnPHomePage -RootFolderRelativeUrl SitePages/Home.aspx

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

EXAMPLE 2

Set-PnPHomePage -RootFolderRelativeUrl Lists/Sample/AllItems.aspx

Sets the home page to be the Sample list.

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
Parameter Sets: (All)

Required: False
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'. Notice that the url is relative to the root folder of the web.

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

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Verbose

When provided, additional debug statements will be shown while executing the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)

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

Microsoft 365 Patterns and Practices