Search Results for

    Show / Hide Table of Contents

    Get-PnPPage

    SYNOPSIS

    Returns a specific or all modern pages (Site Pages) in a SharePoint site.

    SYNTAX

    Specific page

    Get-PnPPage -Identity <PagePipeBind> [-Connection <PnPConnection>]
    

    All pages

    Get-PnPPage [-Connection <PnPConnection>]
    

    DESCRIPTION

    This command allows the retrieval of a modern sitepage along with its properties and contents on it. Note that for a newly created modern site, the Columns and Sections of the Home.aspx page will not be filled according to the actual site page contents. This is because the underlying CanvasContent1 will not be populated until the homepage has been edited and published. The reason for this behavior is to allow for the default homepage to be able to be updated by Microsoft as long as it hasn't been modified. For any other site page or after editing and publishing the homepage, this command will return the correct columns and sections as they are positioned on the site page.

    Also note that if you want to retrieve all site pages in a site by omitting the -Identity parameter, the command will return all pages in the Site Pages library, but with less details and will require SharePoint Online Administrator permissions to do so. This is how it has been designed on the server side. If you want the full details on all pages, you can do it as follows Get-PnPPage | % { Get-PnPPage -Identity $_.Name }. Be aware that this causes a lot of server calls and is much slower than the first command.

    EXAMPLES

    EXAMPLE 1

    Get-PnPPage -Identity "MyPage.aspx"
    

    Gets the page named 'MyPage.aspx' in the current SharePoint site

    EXAMPLE 2

    Get-PnPPage "MyPage"
    

    Gets the page named 'MyPage.aspx' in the current SharePoint site

    EXAMPLE 3

    Get-PnPPage "Templates/MyPageTemplate"
    

    Gets the page named 'MyPageTemplate.aspx' from the templates folder of the Page Library in the current SharePoint site

    EXAMPLE 4

    Get-PnPPage -Identity "MyPage.aspx" -Web (Get-PnPWeb -Identity "Subsite1")
    

    Gets the page named 'MyPage.aspx' from the subsite named 'Subsite1'

    EXAMPLE 5

    Get-PnPPage
    

    Returns all site pages in the current SharePoint site. Note that this will return less details than when using the -Identity parameter and requires SharePoint Online Administrator permissions to do so.

    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
    

    -Identity

    The name of the page to retrieve

    Type: PagePipeBind
    Parameter Sets: Specific page
    
    Required: True
    Position: 0
    Default value: None
    Accept pipeline input: True (ByValue)
    Accept wildcard characters: False
    

    RELATED LINKS

    Microsoft 365 Patterns and Practices

    Back to top Generated by DocFX spacer