Get-PnPFolderItem
SYNOPSIS
List files and/or subfolders in a folder
SYNTAX
Folder via url
Get-PnPFolderItem [-FolderSiteRelativeUrl <String>] [-ItemType <String>] [-ItemName <String>] [-Recursive] [-Verbose] [-Connection <PnPConnection>]
Folder via pipebind
Get-PnPFolderItem [-Identity <FolderPipeBind>] [-ItemType <String>] [-ItemName <String>] [-Recursive] [-Verbose] [-Connection <PnPConnection>]
DESCRIPTION
This cmdlet allows listing of all the content in a folder. It can be used to list all files and folders in a folder and optionally all its subfolders.
Use Get-PnPFolderFile to retrieve only files and Get-PnPFolderFolder to retrieve only folders allowing additional properties of the returned items to be requested.
EXAMPLES
EXAMPLE 1
Get-PnPFolderItem
Returns all the files and folders in the root of the current web
EXAMPLE 2
Get-PnPFolderItem -Recurse
Returns all the files and folders 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-PnPFolderItem -Identity "Shared Documents"
Returns the files and folders located in the 'Shared Documents' folder located in the root of the current web
EXAMPLE 4
Get-PnPFolderItem -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-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -ItemType Folder
Returns all subfolders of the folder SitePages which is located in the root of the current web
EXAMPLE 6
Get-PnPFolder -Identity "Shared Documents" | Get-PnPFolderItem -ItemType File
Returns all files in the "Shared Documents" folder which is located in the root of the current web
EXAMPLE 7
Get-PnPFolderItem -FolderSiteRelativeUrl "SitePages" -Recursive
Returns all files and folders, including contents of any subfolders, in the folder SitePages which is located in the root of the current web
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
-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
-ItemName
Name of the item 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
-ItemType
The type of contents to retrieve, either File, Folder or All (default)
Type: String
Parameter Sets: (All)
Accepted values: Folder, File, All
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Recursive
A switch parameter to include contents 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