Get-PnPWebPartProperty

Returns a web part property

Syntax

Get-PnPWebPartProperty
   -ServerRelativePageUrl <String>
                         -Identity <GuidPipeBind>
                         [-Key <String>]
                         [-Web <WebPipeBind>]
                         [-Connection <SPOnlineConnection>]

Examples

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

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

Returns all properties of the webpart.

------------------EXAMPLE 2------------------

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

Returns the title property of the webpart.

Required Parameters

-Identity

The id of the webpart

Type:GuidPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-ServerRelativePageUrl

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

Type:String
Aliases:PageUrl
Position:Named
Accept pipeline input:False
Accept wildcard characters:False

Optional 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:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Key

Name of a single property to be returned

Type:String
Position:Named
Accept pipeline input:False
Accept wildcard characters: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
Position:Named
Accept pipeline input:False
Accept wildcard characters:False