Get-PnPWebPartXml

Returns the web part XML of a web part registered on a site

Syntax

Get-PnPWebPartXml
   -ServerRelativePageUrl <String>
                    -Identity <WebPartPipeBind>
                    [-Web <WebPipeBind>]
                    [-Connection <SPOnlineConnection>]

Examples

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

Get-PnPWebPartXml -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82

Returns the web part XML for a given web part on a page.

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
-Identity

Id or title of the web part. Use Get-PnPWebPart to retrieve all web part Ids

Type:WebPartPipeBind
Position:Named
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
Aliases:PageUrl
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

Outputs

System.String