Search Results for

    Show / Hide Table of Contents

    Get-PnPWebPartProperty

    SYNOPSIS

    Returns a web part property

    SYNTAX

    Get-PnPWebPartProperty -ServerRelativePageUrl <String> -Identity <Guid> [-Key <String>]
     [-Connection <PnPConnection>] 
    

    DESCRIPTION

    Allows to retrieve web part property.

    EXAMPLES

    EXAMPLE 1

    Get-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914
    

    Returns all properties of the web part.

    EXAMPLE 2

    Get-PnPWebPartProperty -ServerRelativePageUrl /sites/demo/sitepages/home.aspx -Identity ccd2c98a-c9ae-483b-ae72-19992d583914 -Key "Title"
    

    Returns the title property of the web part.

    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 id of the web part

    Type: Guid
    Parameter Sets: (All)
    
    Required: True
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Key

    Name of a single property to be returned

    Type: String
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -ServerRelativePageUrl

    Full server relative URL of the web part page, e.g. /sites/mysite/sitepages/home.aspx

    Type: String
    Parameter Sets: (All)
    Aliases: PageUrl
    
    Required: True
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    RELATED LINKS

    Microsoft 365 Patterns and Practices

    Back to top Generated by DocFX spacer