Get-PnPFileInFolder
SYNOPSIS
List files in a folder
SYNTAX
Folder via url
Get-PnPFileInFolder [-FolderSiteRelativeUrl <String>] [-ItemName <String>] [-Recurse] [-Includes <String[]>] [-ExcludeSystemFolders] [-Verbose] [-Connection <PnPConnection>]
Folder via pipebind
Get-PnPFileInFolder [-Identity <FolderPipeBind>] [-ItemName <String>] [-Recurse] [-Includes <String[]>] [-ExcludeSystemFolders] [-Verbose] [-Connection <PnPConnection>]
Folder via list pipebind
Get-PnPFileInFolder [-List <ListPipeBind>] [-ItemType <String>] [-ItemName <String>] [-Includes <String[]>] [-Verbose] [-Connection <PnPConnection>]
DESCRIPTION
This cmdlet allows listing of all the files in a folder. It can optionally also list all files in the underlying subfolders.
When working with a document library containing over 5,000 items in it, you will need to use the -List parameter to specify the document library in order to be able to retrieve the files in it. It will always recursively retrieve all files in the document library. You can also use -Includes to fetch additional properties of the files.
EXAMPLES
EXAMPLE 1
Get-PnPFileInFolder
Returns all the files in the root of the current web
EXAMPLE 2
Get-PnPFileInFolder -Recurse
Returns all the files in the entire site. This will take a while to complete and will cause a lot of calls to be made towards SharePoint Online. Use it wisely.
EXAMPLE 3
Get-PnPFileInFolder -Identity "Shared Documents"
Returns the files located in the 'Shared Documents' folder located in the root of the current web
EXAMPLE 4
Get-PnPFileInFolder -FolderSiteRelativeUrl "SitePages" -ItemName "Default.aspx"
Returns the file 'Default.aspx' which is located in the folder SitePages which is located in the root of the current web
EXAMPLE 5
Get-PnPFolder -Identity "Shared Documents" | Get-PnPFileInFolder
Returns all files in the "Shared Documents" folder which is located in the root of the current web
EXAMPLE 6
Get-PnPFileInFolder -FolderSiteRelativeUrl "SitePages" -Recurse
Returns all files, including those located in any subfolders, in the folder SitePages which is located in the root of the current web
EXAMPLE 7
Get-PnPFolder -List "Documents" | Get-PnPFileInFolder -Recurse -ExcludeSystemFolders
Returns all files, including those located in any subfolders, located in the Documents document library where the files in system folders are excluded
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
-ExcludeSystemFolders
When provided, all files in system folders will be excluded from the output. This parameter is not supported when not providing a folder through -Identity or -FolderSiteRelativeUrl.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FolderSiteRelativeUrl
The site relative URL of the folder to retrieve
Type: String
Parameter Sets: Folder via url
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identity
A folder instance to the folder to retrieve
Type: FolderPipeBind
Parameter Sets: Folder via pipebind
Required: False
Position: 0
Default value: None
Accept pipeline input: True
Accept wildcard characters: False
-Includes
Optionally allows properties to be retrieved for the returned files which are not included in the response by default
Type: String[]
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ItemName
Name of the file to retrieve (not case sensitive)
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-List
The document library to retrieve the files from. This parameter is required when working with document libraries containing over 5,000 items.
Type: ListPipeBind
Parameter Sets: Folder via list pipebind
Required: False
Position: 0
Default value: None
Accept pipeline input: True
Accept wildcard characters: False
-Recurse
A switch parameter to include files of all subfolders in the specified folder
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Verbose
When provided, additional debug statements will be shown while executing the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False