Document Library Folder Operations User Guide

Document Library Folder Operations User Guide
Table of Contents
Introduction:................................................................................................................................ 2
Initial Browser Settings: ................................................................................................................ 2
Initial Set Up:................................................................................................................................ 4
Initial Login:.................................................................................................................................5
Create Dummy Files:..................................................................................................................... 5
Running Environments:................................................................................................................. 6
Invoking/Calling another PS Script: ................................................................................................ 6
Create Folder:.............................................................................................................................. 8
Create Multiple Folders:................................................................................................................ 9
Create Multiple Folders on Multiple Libraries:.............................................................................. 11
Create Sub Folder:...................................................................................................................... 14
Rename Folder:.......................................................................................................................... 15
Rename Library:......................................................................................................................... 16
Rename File:.............................................................................................................................. 17
Rename File with Extension:........................................................................................................ 18
Rename Multiple Files:................................................................................................................ 19
Download a File by a Specific Path:.............................................................................................. 20
Download Multiple Files by a Specific Folder:............................................................................... 21
Get Folder Permissions Report: ................................................................................................... 22
Assign Folder Permissions:.......................................................................................................... 24
Assign Folder Permissions via Restrictions:................................................................................... 25
Un Assign Folder Permissions via Restrictions:.............................................................................. 26
Assign Folder Permissions via SP Group:....................................................................................... 27
Delete a Large Folder:................................................................................................................. 27
Delete a File by it’s Path:............................................................................................................. 28
Assign Multi Folder Permissions via CSV:...................................................................................... 29
Simple Upload:........................................................................................................................... 31
Simple Upload Files into a Folder:................................................................................................ 33
Simple Download:....................................................................................................................... 34
External User Authentication:...................................................................................................... 36
Login Included:........................................................................................................................... 37
Using CSV:.................................................................................................................................. 37
Using Arguments:....................................................................................................................... 37
Total Scripts:.............................................................................................................................. 37

Summary:.................................................................................................................................. 38
Introduction:
Through this User Guide we are trying to cover most of the major areas of Folder
collaboration with related Files management of the given SPO Libraries.
We are using Patterns and Practices module PnP PowerShell libraries to have a smart
experience and generating the related outputs for all kinds of business needs.
For more reference please refer here: https://docs.microsoft.com/en-
us/powershell/module/sharepoint-pnp/?view=sharepoint-ps
Initial Browser Settings:
Please open the Primary/Parent Browser in your machine >> Click the Top Right corner Cog
>> Go To Internet Options >> Security Tab >> Custom Level >> Enable the below options as
highlighted >> Click Ok >> Restart the Machine for all Settings to get reflected.

Initial Set Up:
Please run the below set of PS code lines before working with all our PnP scripts.
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
Install-PackageProvider -Name NuGet
Install-Module -Name SharePointPnPPowerShellOnline

Initial Login:
Please run the below set of PS code lines by replacing the highlighted details before working
with all our PnP scripts that covers the Login process and stores the credentials and re-uses
it whenever you run next set of PnP PowerShell scripts.
$SharePointSiteURL = "<Site URL>"
Connect-PnPOnline -Url $SharePointSiteURL -UseWebLogin
Create Dummy Files:
Please run the below set of CMD script lines for creating all kinds of dummy files with
required extensions by making and changing it to the directory.
md <FilePath>
cd <FilePath>
Fsutil file createnew dummyfile1.pdf 2000000

Fsutil file createnew dummyfile2.doc 2000000
Fsutil file createnew dummyfile3.ppt 2000000
Fsutil file createnew dummyfile4.dat 2000000
Note: Only run in the CMD prompt
Above CMD lines create dummy files with above titles and mentioned extensions each with
20 MB sizes.
We can use the above concept for all kinds of testing, validation, uploading, downloading of
dummy files via PnP PS scripting on a given SPO Library’s Folders or Sub-Folders etc.
Running Environments:
Suggested Environment to run all the below PnP PowerShell scripts are using Windows
PowerShell ISE only Right Click as Admin as shown below:
Invoking/Calling another PS Script:
We can also use Command Line Prompt Tool to run below PnP scripts as an alternative as
shown in the below illustrated example:
Write-Host "Hello World!";
Write-Host "Invoking or Calling another PnP PS Script";

Powershell .CreateFolder_PnP

Note
All the below PnP Scripts support MFA [multi factor authentication] which will be very
helpful for the end user to enter his password at the run time only for once and rest of the
times will login automatically with the same login details if he has permissions on the site
collections which are referred in the PnP PowerShell scripts.
Below Scripts can be used across a Modern as well as ClassicSPO Libraries.
Create Folder:
Here is a simple way to create a folder on a given SPO library using PnP PowerShell.
Here's the PnP PowerShell code to execute on a Windows PowerShell ISE .
#Config Variables
$SharePointSiteURL = "#########################"
$FolderName= "FolderName"
$RelativeURL= "/LibName"
Try {
#Connect to PnP Online
#sharepoint online create folder powershell
Add-PnPFolder -Name $FolderName -Folder $RelativeURL -ErrorAction Stop
Write-host -f Green "New Folder '$FolderName' Added!"
}
catch {
write-host "Error: $($_.Exception.Message)" -foregroundcolor Red
}
Please configure above highlighted points to have your own folder created via PnP
PowerShell programmatically.

Here is the snapshot after a successful running of the script,
Create Multiple Folders:
Here is a simple way to create multiple folders on a given SPO library using PnP PowerShell.
Here's the PnP PowerShell code to execute on a Windows PowerShell.
#Config Variables
$SiteURL = "#########################"
$CSVFilePath = "D:PnPInputFolders_SameLib.csv"
Try {
Connect-PnPOnline -Url $SiteURL -UseWebLogin
#Get the CSV file
$CSVFile = Import-Csv $CSVFilePath
#Read CSV file and create document document library
ForEach($Row in $CSVFile)
{
#Create Folder if it doesn't exist
Resolve-PnPFolder -SiteRelativePath $Row.FolderSiteRelativeURL | Out-Null
Write-host "Ensured Folder:"$Row.FolderSiteRelativeURL -f Green
}
}
catch {
}

Above csv file mentioned in the script should look like this with column, values, sheet name
same as file name saved etc. as shown below:
Here is the snapshot after a successful running of the script,

Create Multiple Folders on Multiple Libraries:
Here is a simple way to create multiple folders on a given multiple SPO libraries using PnP
PowerShell.
Here's the PnP PowerShell code to execute on a windows PowerShell.
#Config Variables
$SiteURL = "#########################”
$CSVFilePath = "D:PnPInputFolders_MultipleLibs.csv"
Try {
#Get the CSV file
$CSVFile = Import-Csv $CSVFilePath

#Read CSV file and create document document library
ForEach($Row in $CSVFile)
{
#Create Folder if it doesn't exist
Resolve-PnPFolder -SiteRelativePath $Row.FolderSiteRelativeURL | Out-Null
Write-host "Ensured Folder:"$Row.FolderSiteRelativeURL -f Green
}
}
catch {
}

Above csv file should look like this with column, values, sheet name same as file name saved
etc. as shown below:
Here is the snapshot after a successful running of the script:

Above concept can be used across a Modern as well as Classic SPO Libraries.
Create Sub Folder:
Here is a simple way to create a sub-folder on a given SPO library using PnP PowerShell.
#Config Variables
$SiteURL = "##############################"
$FolderName= "SubFolderName"
$RelativeURL= "/LibName/FolderName"

Try {
#sharepoint online create folder powershell
Add-PnPFolder -Name $FolderName -Folder $RelativeURL -ErrorAction Stop
Write-host -f Green "New Sub Folder '$FolderName' Added!"
}
catch {
}
Here is the snapshot(s) after a successful running of the script:
Rename Folder:
Here is a simple way to Rename a Folder on a given SPO library using PnP PowerShell.

#Config Variables
$SiteURL = "################"
$FolderURL= "LibName/TestABC"
#Site Relative URL
$FolderNewName ="LibName"
#Rename the Folder
Rename-PnPFolder -Folder $FolderURL -TargetFolderName $FolderNewName
Rename Library:
Here is a simple way to Rename a given SPO library using PnP PowerShell.
#Config Variables
$SiteURL = "##################"
$LibURL= "LibName/"
#Site Relative URL
$FolderNewName ="Reports Updated"
#Rename the Folder
Rename-PnPFolder -Folder $LibURL -TargetFolderName $FolderNewName

Rename File:
Here is simple way to rename file in a given SPO library using PnP PowerShell.
#Config Variables
$SiteURL = "#######################"
$FileURL= "LibName/FolderName/xxx.txt"
$NewFileName ="yyyy.txt"
#Rename the File
Rename-PnPFile -SiteRelativeUrl $FileURL -TargetFileName $NewFileName -Force
Please configure above highlighted points to have above requirement implemented via PnP

Rename File with Extension:
Here is simple way to Rename file along with Extension in a given SPO library using PnP
PowerShell.
#Config Variables
$SiteURL = "###############"
$FileURL= "LibName/FolderName/xxx.txt"
#Always include file extension
$NewFileName ="Topdf.pdf"
#Rename the File
Rename-PnPFile -SiteRelativeUrl $FileURL -TargetFileName $NewFileName -Force

Rename Multiple Files:
Here is a simple way to rename multiple files in a given SPO library using PnP powershell.
#Config Variables
$SiteURL = "######################”
$LibraryName = "LibName"
#Get All Files from the document library
$Files = Get-PnPListItem -List $LibraryName -PageSize 1000 | Where
{$_["FileLeafRef"] -like "*dummy*"}
#Loop through each File
Write-host -f Green "Number of Files Found:"$Files.Count
ForEach($File in $Files)
{
Write-Host ("Renaming File '{0}' at {1}" -f $File["FileLeafRef"],
$File["FileRef"])
#Rename File
Rename-PnPFile -ServerRelativeUrl $File["FileRef"] -TargetFileName
"SpecialDemo_$($File['FileLeafRef'])" -OverwriteIfAlreadyExists -Force
}

Download a File by a Specific Path:
Here is a simple way to download a file by path specification in a given SPO library using PnP
PowerShell.
#Config Variables
$SiteURL = "##########################”

$ListName="LibName"
$FileRelativeURL = "/###/#########/#######/LibName/FolderName/Topdf.pdf"
$DownloadPath ="D:PnPInput"
Try {
#Connect to PNP Online
Connect-PnPOnline -Url $SiteURL -Useweblogin
#powershell download file from sharepoint online
Get-PnPFile -Url $FileRelativeURL -Path $DownloadPath -AsFile
}
catch {
}
Download Multiple Files by a Specific Folder:
Here is a simple way to download all files by a specified path folder in a given SPO
library using PnP PowerShell.
#Config Variables
$SiteURL = "##########################”
$ListName="LibName"
$FileRelativeURL = "/###/#########/#######/LibName/FolderName/"
$DownloadPath ="D:PnPInput"
Try {
#powershell download file from sharepoint online
Get-PnPFile -Url $FileRelativeURL -Path $DownloadPath -AsFile

}
catch {
}
Get Folder Permissions Report:
Here is a simple way to get the total Permissions report for a given Folder on a given SPO
Function Get-PnPPermissions([Microsoft.SharePoint.Client.SecurableObject]$Object)
{
Try {
#Get permissions assigned to the Folder
Get-PnPProperty -ClientObject $Object -Property HasUniqueRoleAssignments,
RoleAssignments
#Check if Object has unique permissions
$HasUniquePermissions = $Object.HasUniqueRoleAssignments
#Loop through each permission assigned and extract details
$PermissionCollection = @()
Foreach($RoleAssignment in $Object.RoleAssignments)
{
#Get the Permission Levels assigned and Member
Get-PnPProperty -ClientObject $RoleAssignment -Property
RoleDefinitionBindings, Member
#Get the Principal Type: User, SP Group, AD Group
$PermissionType = $RoleAssignment.Member.PrincipalType
$PermissionLevels = $RoleAssignment.RoleDefinitionBindings | Select -
ExpandProperty Name
#Remove Limited Access
$PermissionLevels = ($PermissionLevels | Where { $_ –ne "Limited
Access"}) -join ","
If($PermissionLevels.Length -eq 0) {Continue}
#Get SharePoint group members
If($PermissionType -eq "SharePointGroup")
{
#Get Group Members
$GroupMembers = Get-PnPGroupMembers -Identity
$RoleAssignment.Member.LoginName
#Leave Empty Groups
If($GroupMembers.count -eq 0){Continue}
ForEach($User in $GroupMembers)
{
#Add the Data to Object
$Permissions = New-Object PSObject
$Permissions | Add-Member NoteProperty User($User.Title)
$Permissions | Add-Member NoteProperty Type($PermissionType)
$Permissions | Add-Member NoteProperty
Permissions($PermissionLevels)
GrantedThrough("SharePoint Group: $($RoleAssignment.Member.LoginName)")
$PermissionCollection += $Permissions
}
}

Else
{
#Add the Data to Object
$Permissions = New-Object PSObject
User($RoleAssignment.Member.Title)
$Permissions | Add-Member NoteProperty Type($PermissionType)
Permissions($PermissionLevels)
$Permissions | Add-Member NoteProperty GrantedThrough("Direct
Permissions")
$PermissionCollection += $Permissions
}
}
#Export Permissions to CSV File
$PermissionCollection | Export-CSV $ReportFile -NoTypeInformation
Write-host -f Green "`n*** Folder Permission Report Generated
Successfully!***"
}
Catch {
write-host -f Red "Error Generating Folder Permission Report!"
$_.Exception.Message
}
}
#region ***Parameters***
$SiteURL="#########################"
$ReportFile="D:PnPInputFolderPermissionRpt.csv"
$FolderRelativeURL = "/###/#########/#######/LibName/Project Champ"
#endregion
#Connect to the Site collection
Connect-PnPOnline -URL $SiteURL -UseWebLogin
#Get the Folder from URL
$Folder = Get-PnPFolder -Url $FolderRelativeURL
#Call the function to generate permission report
Get-PnPPermissions $Folder.ListItemAllFields
Here are the snapshots after a successful running of the script:

Assign Folder Permissions:
Here is a simple way to assign a Folder permissions in a given SPO library using PnP
PowerShell.
Here's the PnP PowerShell code to execute on a windows PowerShell.
#Config Variables
$SiteURL = "###################"

$ListName="LibName"
$FolderServerRelativeURL = "/###/#########/#######/LibName/FolderName"
$UserAccount = "user@xxx.com"
#Get the Folder from URL
$Folder = Get-PnPFolder -Url $FolderServerRelativeURL
#Set Permission to Folder
Set-PnPListItemPermission -List $ListName -Identity $Folder.ListItemAllFields -User
$UserAccount -AddRole 'Contribute'
Assign Folder Permissions via Restrictions:
Here is a simple way to assign a Folder permissions via restrictions in a given SPO
#Config Variables
$SiteURL = "###########################"
$ListName="LibName"
#Set folder permissions - Add User
Set-PnPfolderPermission -List $ListName -identity $FolderServerRelativeURL -User
"suresh.gade@sony.com" -AddRole "Full Control"

Un Assign Folder Permissions via Restrictions:
Here is a simple way to unassign/remove Folder permissions via restrictions in a given SPO
#Config Variables
$SiteURL = "######################"
$ListName="LibName"
#To remove user, use:- -RemoveRole
Set-PnPfolderPermission -List $ListName -identity $FolderServerRelativeURL -User
"suresh.gade@sony.com" -RemoveRole "Full Control"
You can check manually by going to that respective folder if the permissions have been
removed or not.

Assign Folder Permissions via SP Group:
Here is a simple way to assign a Folder permissions via a SP group in a given SPO
#Config Variables
$SiteURL = "##################”
$ListName="LibName"
#Grant folder permissions to SharePoint Group which should exist!
Set-PnPfolderPermission -List $ListName -identity $FolderServerRelativeURL -AddRole
"Read" -Group "Box Migration Members"
Prerequisites:
Above mentioned SP group is expected to exist before either created by default or to be
created separately in order to configure in the above script.
Above mentioned Folder is also expected to exist before or need to be created
separately in order to configure in the above script.
Delete a Large Folder:
Here is a simple way to delete a Folder/Large Folder in a given SPO library using PnP
PowerShell.
#Config Variables
$SiteURL = "################"
$ListName="LibName"
Try {
#Get All Items from Folder in Batch
$ListItems = Get-PnPListItem -List $ListName -FolderServerRelativeUrl
$FolderServerRelativeURL -PageSize 2000 | Sort-Object ID -Descending
#Powershell to delete all files from folder
ForEach ($Item in $ListItems)
{
Remove-PnPListItem -List $ListName -Identity $Item.Id -Recycle -Force
Write-host "Removed File:"$Item.FieldValues.FileRef
}
}
Catch {
}

Prerequisites:
Above mentioned Folder is also expected to exist before or need to be created separately in
order to configure in the above script. Above value 2000 is mentioned for removing/deleting
a large library & set it to 1000 for a normal library.
Here is the output after running the above script using your Windows PowerShell ISE tool.
Delete a File by it’s Path:
Here is a simple way to delete a File by it's path on a given SPO library using PnP PowerShell.
#Config Variables
$SiteURL = "################"
$FileRelativeURL ="/###/#########/#######/LibName/xxxx.pdf"
Try {
#Try to Get File
$File = Get-PnPFile -Url $FileRelativeURL -ErrorAction SilentlyContinue
If($File)
{
#Delete the File
Remove-PnPFile -ServerRelativeUrl $FileRelativeURL -Force
Write-Host -f Green "File $FileRelativeURL deleted successfully!"

}
Else
{
Write-Host -f Yellow "Could not Find File at $FileRelativeURL"
}
}
catch {
}
Prerequisites:
Above mentioned Folder/File/File Path is also expected to exist before or need to be created
separately in order to configure in the above script.
Output: Here is the output after running the above script using your Windows PowerShell
ISE tool.
Assign Multi Folder Permissions via CSV:
Here is a simple way to assign multiple Folder permissions via a CSV file in a given SPO
#Variables
$CSVPath ="D:PnPInputusers.csv"

#Get data from CSV
$CSVData = Import-Csv $CSVPath
#Iterate through each row in CSV
ForEach($Row in $CSVData)
{
Try {
#Connect to SharePoint Online Site
Write-host "Connecting to Site: "$Row.SiteURL
Connect-PnPOnline -Url $Row.SiteURL -UseWebLogin
#Get the group
$Group = Get-PnPGroup -Identity $Row.GroupName
#Add Each user to the Group
Add-PnPUserToGroup -LoginName $Row.UserAccount -Identity $Group
Write-host -f Green "`tAdded User $($Row.UserAccount) to $($Group.Title)"
DisConnect-PnPOnline
}
Catch {
write-host -f Red "Error Adding User to Group:" $_.Exception.Message
}
}
Users csv file should look like this:

Simple Upload:
Let’stry to upload all the files present from your local desktop path to a SharePoint online
library.
Here is uploading the PnP script to run. You need to do the configurations accordingly.
$SiteURL = "##############################"
$FilesPath = "D:PnPInputDummy Files"
$SiteRelativePath = "/LibName"
#Get All Files from a Local Folder
$Files = Get-ChildItem -Path $FilesPath -Force -Recurse
#Upload All files from the directory
ForEach ($File in $Files)
{
Write-host "Uploading $($File.Directory)$($File.Name)"
#upload a file to sharepoint online using powershell - Upload File and Set
Metadata
Add-PnPFile -Path "$($File.Directory)$($File.Name)" -Folder $SiteRelativePath
-Values @{"Title" = $($File.Name)}
}
Note
It can only upload files but not folders from the given folder path, as explained in the above
script.

Here is the output, as shown below.

Upload Speed for 1k Dummy Files: 1.86 GB/19 Mins = 0.09 GB/Min
I would also suggest go for the direct drag and drop modern upload option on any
Document Library, which completes faster + includes Folders/Subfolders too!!
Note
The above speeds can vary w.r.t to the LAN/Wi-Fi Connection too!!
We've come to know the above PnP script for our business requirements. It can be
programmed to be automated by calling it into another program or via Azure Web
Jobs/Azure Functions etc.
Simple Upload Files into a Folder:
Here is a simple way to upload all the files present in your local desktop path into a
SharePoint online Library’s Folder.
It’s the same process as above but with a small change.
$SiteURL = "##############################"
$FilesPath = "D:PnPInputDummy Files"
$SiteRelativePath = "/LibName/FolderName"
{
Metadata
}

Here is the Output reflected after running above script:
Simple Download:
Here is a simple way to download all the files present into your local desktop path from a
given SharePoint online library/folder.
Here is the downloading PnP script to run. You need to do the configurations accordingly.
$SharePointSiteURL = "######################"
# Change this SharePoint Site URL
$SharedDriveFolderPath = "D:PnPInputDemoLibFiles"
# Change this Network Folder path
$SharePointFolderPath = "/LibName/FolderName"
#Connecting to SharePoint site
$Files = Get-PnPFolderItem -FolderSiteRelativeUrl $SharePointFolderPath -ItemType
File
foreach($File in $Files) {
Get-PnPFile -Url $File.ServerRelativeUrl -Path $SharedDriveFolderPath -FileName
$File.Name -AsFile
}
Here is the output, as shown below.

Download Speed for 1k Dummy Files: 1.86 GB/9 Mins = 0.18 GB/Min
Note
The above speeds can vary with the LAN/Wi-Fi Connection too!!
The above PnP script is useful for our business requirement and can be programmed to be
automated by calling it into other programs, or via Azure web jobs/Azure functions, etc.

External User Authentication:
Here is a simple waytorun yourPnPFilesUploadingscript toa Library byhard codingthe External
User Credentialsprovidedithasbeenalreadysharedexternal tothatspecificSPSite collection.
$FilesPath = "D:PnPInputDemoLibFiles"
$SiteRelativePath = "/LibName/FolderName"
$Username = "##################"
$Password = ‘##################’
$SiteCollection = "https://#######/###/#########/#######"
[SecureString]$SecurePass = ConvertTo-SecureString $Password -AsPlainText -Force
[System.Management.Automation.PSCredential]$PSCredentials = New-Object
System.Management.Automation.PSCredential($Username, $SecurePass)
Connect-PnPOnline -Url $SiteCollection -Credentials $PSCredentials
{
Metadata
}
Here is the Outputafterrunningthe above script:
Important Note: Above External UserAccountLogindetailshardcodingwill helpustoseamlessly
run the scriptsfor External Usersprovidedtheyare sharedaccesspermissionstothatspecificSPSite
Collection.We canalsoleverage the same conceptforInternal UserAccountthatavoidsentering
the passwordduringthe scriptsrunning.
Use onlyapplicationaccountdetailslike some RegisteredService Accounts.

Login Included:
There isa special foldernamedWith LoginIncludedinside Scriptsfolderwhichhas twosample
scriptsthat can be easilyrun withoutmanual entryof logindetailsasexplainedinthe above section.
Using CSV:
There isa special foldernamed WithCSVinside Scriptsfolderwhichhasall scriptsthatcan easilyrun
by passingthe inputsforbulkitemsviaaCSV file.
Thisapproach can be usedto run themon a CMD tool for bulknumberof items.
Using Arguments:
There isa special foldernamed ArgumentsinsideScriptsfolderwhichhasall scriptsthatcan be
easilyrunbypassingthe Argumentsexternallywithoutconfiguringthe scriptsindetail.
Thisapproach can be usedto run themon a CMD tool for bulknumberof items.
Please referMasterArgumentsScripting.ps1fileforaquicktemplate.
Example withrelatedscreenshot
Total Scripts:
Here are the Zippedfilesof all the above scriptsalongwithCSV files&screenshots foryourquick
reference and usage.
Total Scripts.zip

Summary:
All the above conceptscan be completelyutilisedforanendProgrammerto call/invoke the above
PnPscriptsaccordinglyas pertheirneedandalsoautomate themas scheduledjobsintheir
solutionsbyproperconfiguringanddevelopmentwiththeirrespectiveProgramminglanguagesand
it’sassociatedenvironment.
From: Veera Bharat Bhushan Kaveri
Audience: All the Developers and Admins
Environment: SharePoint Online
Entities: Document Libraries, Folders, Files etc.

Document Library Folder Operations User Guide

More Related Content

What's hot (20)

Similar to Document Library Folder Operations User Guide (12)

More from IT Industry (12)

Recently uploaded (20)

Document Library Folder Operations User Guide