| external help file | applicable | schema |
|---|---|---|
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online |
2.0.0 |
Returns a webpart definition object
Get-PnPWebPart -ServerRelativePageUrl <String>
[-Identity <WebPartPipeBind>]
[-Web <WebPipeBind>]
[-Connection <SPOnlineConnection>]PS:> Get-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx"Returns all webparts defined on the given page.
PS:> Get-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82Returns a specific webpart defined on the given page.
The identity of the webpart, this can be the webpart guid or an webpart object
Type: WebPartPipeBind
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: TrueFull server relative URL of the webpart page, e.g. /sites/mysite/sitepages/home.aspx
Type: String
Parameter Sets: (All)
Aliases: PageUrl
Required: True
Position: Named
Accept pipeline input: FalseOptional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: SPOnlineConnection
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: FalseThis 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
Parameter Sets: (All)
Required: False
Position: Named
Accept pipeline input: False