Monday, May 19, 2025

🧹 Clean Up SharePoint Online File Versions: Keep Only the Latest 5 in a Specific Folder Using PnP PowerShell

 Versioning in SharePoint Online is a powerful feature that allows teams to maintain historical copies of documents. However, over time, these versions can accumulate and consume significant storage space—especially in document libraries with frequent updates.

This article provides a step-by-step PowerShell script using the SharePointPnPPowerShellOnline module to clean up old versions of files in a specific folder within a document library—retaining only the latest 5 versions of each file.


🔧 Why This Is Useful

  • Storage Optimization: SharePoint libraries with thousands of old file versions can significantly inflate site storage.

  • Performance: Reducing version history helps improve performance in large libraries.

  • Targeted Cleanup: Instead of affecting the entire document library, you can limit cleanup to a specific folder.


🛠️ Prerequisites

Install-Module -Name SharePointPnPPowerShellOnline -Force
  • SharePoint Online site URL and access permissions to the library/folder.

  • PowerShell with administrative rights.

📜 Script Overview

This script:

  1. Connects to the SharePoint Online site.

  2. Targets a specific folder in a document library.

  3. Retrieves all files in that folder (recursively).

  4. Keeps only the latest 5 versions of each file and deletes the rest.


🔍 PowerShell Script

# Install and Import the Module (if not already done)
Install-Module -Name SharePointPnPPowerShellOnline -Force
Import-Module SharePointPnPPowerShellOnline

# Variables
$SiteURL = "https://gks.sharepoint.com/sites/yoursite"
$ListName = "TestVersionsDocLib"
$FolderServerRelativeUrl = "/sites/yoursite/TestVersionsDocLib/TargetFolder"  # Change as needed

# Connect to SharePoint
Connect-PnPOnline -Url $SiteURL -UseWebLogin  # Use -Interactive if using modern auth

# Get PnP Context
$Ctx = Get-PnPContext

# Get all files in the specified folder recursively
$ListItems = Get-PnPListItem -List $ListName -PageSize 2000 -Query "<View Scope='RecursiveAll'><Query><Where><BeginsWith><FieldRef Name='FileRef'/><Value Type='Text'>$FolderServerRelativeUrl</Value></BeginsWith></Where></Query></View>" | Where { $_.FileSystemObjectType -eq "File" }

foreach ($Item in $ListItems) {
    $File = $Item.File
    $Versions = $File.Versions

    $Ctx.Load($File)
    $Ctx.Load($Versions)
    $Ctx.ExecuteQuery()

    Write-Host "Scanning File: $($File.Name) with $($Versions.Count) versions"

    if ($Versions.Count -gt 5) {
        # Keep latest 5, delete the rest
        $VersionsToDelete = $Versions | Sort-Object -Property Created -Descending | Select-Object -Skip 5
        foreach ($version in $VersionsToDelete) {
            $version.DeleteObject()
        }

        $Ctx.ExecuteQuery()
        Write-Host "Deleted $($VersionsToDelete.Count) older versions of the file: $($File.Name)"
    }
}

📁 Example Folder Path

If your document library is called TestVersionsDocLib and the target folder is Invoices/2025, the relative URL should be:

/sites/yoursite/TestVersionsDocLib/Invoices/2025

✅ Output

The script will:

  • Display each file being scanned.

  • Show how many versions were found.

  • Confirm deletion of versions beyond the latest 5.

⚠️ Important Considerations

  • This script only affects a specific folder—not the whole document library.

  • Always test in a development or QA site before using in production.

  • Deleting versions is irreversible—ensure you retain what’s necessary.


$SiteURL = "https://tc.sharepoint.com/teams/GK/ms"
$FolderSiteRelativeUrl = "Shared Documents/TargetTest"
 Connect-PnPOnline -Url $SiteURL -UseWebLogin
 # Test folder access
$Folder = Get-PnPFolder -Url $FolderSiteRelativeUrl
Write-Host "Folder found: $($Folder.Name)"
# Get files
$Files = Get-PnPFolderItem -FolderSiteRelativeUrl $FolderSiteRelativeUrl -ItemType File -Recursive
Write-Host "Found $($Files.Count) files in the folder"

You can test if the folder exists using this:

Get-PnPFolder -FolderSiteRelativeUrl "Shared Documents"
Get-PnPFolder -FolderSiteRelativeUrl "Shared Documents/4. Projects - WIP"
Get-PnPFolder -FolderSiteRelativeUrl "Shared Documents/4. Projects - WIP/FY'24"

 Get-PnPFolder -FolderSiteRelativeUrl "Shared%20Documents%2F04%2E%20Projects%20%2D%20WIP"

Get-PnPFolder -FolderSiteRelativeUrl "Shared%20Documents%2F04%2E%20Projects%20%2D%20WIP%2FFY%2724%2FFY%2724%20%2D%20Cancellation%20Reason%20%26%20Subreason"

 This helps isolate where the path is breaking.

📝 Final Thoughts

Keeping version history under control is a best practice for maintaining a clean and efficient SharePoint environment. Automating this process with PowerShell ensures consistency and saves valuable administrator time.

If you need to scale this to multiple folders or automate it on a schedule, consider integrating it into an Azure Automation Runbook or a task scheduler.

No comments:

🏢 Monitoring and Optimizing Microsoft 365 SharePoint Sites for Efficiency and Governance

  📌 Introduction As organizations increasingly rely on Microsoft 365 for collaboration and content management, SharePoint Online has become...