Skip to content

Latest commit

 

History

History
127 lines (95 loc) · 2.7 KB

Find-PnPFile.md

File metadata and controls

127 lines (95 loc) · 2.7 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Find-PnPFile

SYNOPSIS

Finds a file in the virtual file system of the web.

SYNTAX

Web

Find-PnPFile -Match <String>
             [-Web <WebPipeBind>]
             [-Connection <SPOnlineConnection>]

List

Find-PnPFile -List <ListPipeBind>
             -Match <String>
             [-Web <WebPipeBind>]
             [-Connection <SPOnlineConnection>]

Folder

Find-PnPFile -Folder <FolderPipeBind>
             -Match <String>
             [-Web <WebPipeBind>]
             [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> Find-PnPFile -Match *.master

Will return all masterpages located in the current web.

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

PS:> Find-PnPFile -List "Documents" -Match *.pdf

Will return all pdf files located in given list.

------------------EXAMPLE 3------------------

PS:> Find-PnPFile -Folder "Shared Documents/Sub Folder" -Match *.docx

Will return all docx files located in given folder.

PARAMETERS

-Folder

Folder object or relative url of a folder to query

Type: FolderPipeBind
Parameter Sets: Folder

Required: True
Position: Named
Accept pipeline input: False

-List

List title, url or an actual List object to query

Type: ListPipeBind
Parameter Sets: List

Required: True
Position: Named
Accept pipeline input: False

-Match

Wildcard query

Type: String
Parameter Sets: Web

Required: True
Position: 0
Accept pipeline input: True

-Connection

Optional 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: 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
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

OUTPUTS

RELATED LINKS

SharePoint Developer Patterns and Practices