SharePoint Online：使用 PnP PowerShell 删除版本历史记录

要求：删除 SharePoint Online 中的版本历史记录。

如何删除 SharePoint Online 中的版本？

如果您一直在管理 SharePoint Online，您就会知道保持环境整洁有序至关重要。清理它的一种方法是删除旧版本的文档和文件，因为旧版本可能会占用大量存储空间。这篇博文将向您展示如何使用 PowerShell 删除 SharePoint Online 中旧版本的文档并自动执行清理过程。

要删除 SharePoint Online 中文件的早期版本，请执行以下步骤：

1. 导航到 SharePoint Online 文档库，选择文件，然后单击工具栏中的“版本历史记录”。 （或从文档的上下文菜单中选择“版本历史记录”）

2. 在版本历史记录页面上，您可以从特定版本的上下文菜单中选择“删除”。要删除文档或列表项的所有版本，请单击“版本历史记录”页面上的“删除所有版本”链接，然后确认提示。
   

   

使用 PnP PowerShell 删除文件的所有版本

SharePoint Online 版本历史记录有助于跟踪对文档所做的更改。但是，有时可能需要删除版本历史记录以释放存储空间或出于合规性目的。让我们看看如何使用 PowerShell 删除 SharePoint Online 中的版本历史记录。

以下是如何使用 PowerShell 删除 SharePoint Online 文档库中文件的所有版本：

#Parameters
$SiteURL = "https://crescent.sharepoint.com/sites/marketing"
$FileURL= "/sites/marketing/Branding/Invoice.xlsx"
 
#Connect to PnP Online
Connect-PnPOnline -Url $SiteURL -Interactive
 
#Get all versions of the File
$Versions = Get-PnPFileVersion -Url $FileURL

#Delete all versions of the File
$Versions.DeleteAll()
Invoke-PnPQuery

SharePoint Online：使用 PnP PowerShell 删除版本历史记录

让我们使用 PowerShell 删除列表或库中所有项目的所有版本。

#Config Variables
$SiteURL = "https://Crescent.sharepoint.com/sites/marketing"
$ListName="Documents"

#Connect to PnP Online
Connect-PnPOnline -Url $SiteURL -Credentials (Get-Credential)

#Get the Context
$Ctx= Get-PnPContext

#Get All Items from the List - Exclude 'Folder' List Items
$ListItems = Get-PnPListItem -List $ListName -PageSize 2000 | Where {$_.FileSystemObjectType -eq "File"}

ForEach ($Item in $ListItems)
{
    #Get File Versions
    $File = $Item.File
    $Versions = $File.Versions
    $Ctx.Load($File)
    $Ctx.Load($Versions)
    $Ctx.ExecuteQuery()
    Write-host -f Yellow "Scanning File:"$File.Name
    
    If($Versions.Count -gt 0)
    {
        #Delete all versions
        $Versions.DeleteAll()
        $Ctx.ExecuteQuery()
        Write-Host -f Green "Deleted All Previous Versions of the File:"$File.Name
    }
}

我们可以使用 PnP PowerShell 清除 SharePoint Online 文档库中所有文件的所有早期版本，如下所示：

#Parameters
$SiteURL = "https://crescent.sharepoint.com/sites/IC"
$LibraryName = "Energy"
 
Try {
    #Connect to PnP Online
    Connect-PnPOnline -Url $SiteURL -Interactive

    #Get the Library
    $Library = Get-PnPList -Identity $LibraryName 
    $global:counter=0

    #Get All Items from the List - Get 'Files
    $ListItems = Get-PnPListItem -List $Library -Fields FileLeafRef,FileRef -PageSize 2000 -ScriptBlock { Param($items) $global:counter += $items.Count; Write-Progress `
                    -PercentComplete ($global:Counter / ($Library.ItemCount) * 100) -Activity "Getting Files of '$($Library.Title)'" `
                       -Status "Processing Files $global:Counter of $($Library.ItemCount)";} | Where {($_.FileSystemObjectType -eq "File")} 
    Write-Progress -Activity "Completed Retrieving Files!" -Completed

    #Loop through each file
    $global:counter=1
    ForEach ($Item in $ListItems)
    {
        #Get File and File Versions
        $Versions = Get-PnPFileVersion -Url $Item.FieldValues.FileRef
        Write-host -f Yellow "Scanning File ($global:counter of $($Library.ItemCount)) : $($Item.FieldValues.FileRef)"
      
        If($Versions.Count -gt 0)
        {
            #Delete all versions
            $Versions.DeleteAll()
            Invoke-PnPQuery
            Write-Host -f Green "`tDeleted All Previous Versions of the File!" #"$Item.FieldValues.FileRef
        }
        $global:counter++
    }
}
Catch {
    write-host -f Red "Error Cleaning up Version History!" $_.Exception.Message
}

PowerShell逐个文件夹清除以前的版本

这是一种不同的方法，用于清除项目数少于 5000 的库中所有文件的先前版本。

#Parameters
$SiteURL = "https://crescent.sharepoint.com/sites/marketing"
$LibraryName ="Documents"

#Function to Clear all File versions in a Folder
Function Cleanup-Versions([Microsoft.SharePoint.Client.Folder]$Folder)
{
    Write-host "Processing Folder:"$Folder.ServerRelativeUrl -f Yellow
    #Get the Site Relative URL of the folder
    $FolderSiteRelativeURL = $Folder.ServerRelativeURL.Replace($Web.ServerRelativeURL,[string]::Empty)

    #Get All Files from the folder    
    $Files = Get-PnPFolderItem -FolderSiteRelativeUrl $FolderSiteRelativeURL -ItemType File
    
    #Iterate through each file
    ForEach ($File in $Files)
    {
        #Get File Versions
        $Versions = Get-PnPProperty -ClientObject $File -Property Versions 
        Write-host -f Yellow "`tScanning File:"$File.Name
     
        If($Versions.Count -gt 0)
        {
            #Delete all versions
            $Versions.DeleteAll()
            Invoke-PnPQuery
            Write-Host -f Green "`t`tDeleted All Previous Versions of the File:"$File.Name
        }
    }

    #Get Sub-folders from the folder - Exclude "Forms" and Hidden folders
    $SubFolders = Get-PnPFolderItem -FolderSiteRelativeUrl $FolderSiteRelativeURL -ItemType Folder | Where {($_.Name -ne "Forms") -and (-Not($_.Name.StartsWith("_")))}
    Foreach($SubFolder in $SubFolders)
    {
        #Call the function recursively
        Cleanup-Versions -Folder $SubFolder     
    }
}
 
#Connect to PnP Online
Connect-PnPOnline -Url $SiteURL -Interactive
$Web = Get-PnPWeb

#Get the Root Folder of the Library
$RootFolder = Get-PnPList -Identity $LibraryName -Includes RootFolder | Select -ExpandProperty RootFolder

#Call the function with Root Folder of the Library
Cleanup-Versions -Folder $RootFolder

您可以通过将第 45 行替换为“$RootFolder=Get-PnPFolder -Url $FolderServerRelativeURL”来清理文件夹中所有文件的早期版本。

保留最后五个版本并删除其余版本：

翻阅版本历史页面并一一删除，很麻烦。这是 PnP PowerShell，用于保留最后的“N”个版本并删除所有其他版本。

#Parameters
$SiteURL = "https://crescent.sharepoint.com/sites/Funds"
$ListName = "Documents"
$VersionsToKeep = 5
 
#Connect to PnP Online
Connect-PnPOnline -Url $SiteURL -UseWebLogin

#Get the Document Library
$List = Get-PnPList -Identity $ListName
 
#Get the Context
$Ctx= Get-PnPContext

$global:counter=0 
#Get All Items from the List - Get 'Files
$ListItems = Get-PnPListItem -List $ListName -Fields FileLeafRef -PageSize 2000 -ScriptBlock { Param($items) $global:counter += $items.Count; Write-Progress `
                -PercentComplete ($global:Counter / ($List.ItemCount) * 100) -Activity "Getting Files of '$($List.Title)'" `
                    -Status "Processing Files $global:Counter of $($List.ItemCount)";} | Where {($_.FileSystemObjectType -eq "File")}
Write-Progress -Activity "Completed Retrieving Files!" -Completed

$TotalFiles = $ListItems.count
$Counter = 1 
ForEach ($Item in $ListItems)
{
    #Get File Versions
    $File = $Item.File
    $Versions = $File.Versions
    $Ctx.Load($File)
    $Ctx.Load($Versions)
    $Ctx.ExecuteQuery()
 
    Write-host -f Yellow "Scanning File ($Counter of $TotalFiles):"$Item.FieldValues.FileRef
    $VersionsCount = $Versions.Count
    $VersionsToDelete = $VersionsCount - $VersionsToKeep
    If($VersionsToDelete -gt 0)
    {
        write-host -f Cyan "`t Total Number of Versions of the File:" $VersionsCount
        $VersionCounter= 0
        #Delete versions
        For($i=0; $i -lt $VersionsToDelete; $i++)
        {
            If($Versions[$VersionCounter].IsCurrentVersion)
            {
                $VersionCounter++
                Write-host -f Magenta "`t`t Retaining Current Major Version:" $Versions[$VersionCounter].VersionLabel
                Continue
            }
            Write-host -f Cyan "`t Deleting Version:" $Versions[$VersionCounter].VersionLabel
            $Versions[$VersionCounter].DeleteObject()
        }
        $Ctx.ExecuteQuery()
        Write-Host -f Green "`t Version History is cleaned for the File:"$File.Name
    }
    $Counter++
}

如何清理站点上所有文档库的版本历史记录？

#Config Parameters
$SiteURL = "https://crescent.sharepoint.com/sites/marketing"
$VersionsToKeep = 5

Try { 
    #Connect to PnP Online
    Connect-PnPOnline -Url $SiteURL -Interactive

    #Get the Context
    $Ctx= Get-PnPContext

    #Exclude certain libraries
    $ExcludedLists = @("Form Templates", "Preservation Hold Library","Site Assets", "Pages", "Site Pages", "Images",
                            "Site Collection Documents", "Site Collection Images","Style Library")

    #Get All document libraries
    $DocumentLibraries = Get-PnPList | Where-Object {$_.BaseType -eq "DocumentLibrary" -and $_.Title -notin $ExcludedLists -and $_.Hidden -eq $false}

    #Iterate through each document library
    ForEach($Library in $DocumentLibraries)
    {
        Write-host "Processing Document Library:"$Library.Title -f Magenta

        #Get All Items from the List - Exclude 'Folder' List Items
        $ListItems = Get-PnPListItem -List $Library -PageSize 2000 | Where {$_.FileSystemObjectType -eq "File"}

        #Loop through each file
        ForEach ($Item in $ListItems)
        {
            #Get File Versions
            $File = $Item.File
            $Versions = $File.Versions
            $Ctx.Load($File)
            $Ctx.Load($Versions)
            $Ctx.ExecuteQuery()
 
            Write-host -f Yellow "`tScanning File:"$File.Name
            $VersionsCount = $Versions.Count
            $VersionsToDelete = $VersionsCount - $VersionsToKeep
            If($VersionsToDelete -gt 0)
            {
                write-host -f Cyan "`t Total Number of Versions of the File:" $VersionsCount
                $VersionCounter= 0
                #Delete versions
                For($i=0; $i -lt $VersionsToDelete; $i++)
                {
                    If($Versions[$VersionCounter].IsCurrentVersion)
                    {
                       $VersionCounter++
                       Write-host -f Magenta "`t`t Retaining Current Major Version:"$Versions[$VersionCounter].VersionLabel
                       Continue
                    }
                    Write-host -f Cyan "`t Deleting Version:" $Versions[$VersionCounter].VersionLabel
                    $Versions[$VersionCounter].DeleteObject()
                }
                $Ctx.ExecuteQuery()
                Write-Host -f Green "`t Version History is cleaned for the File:"$File.Name
            }
        }
    }
}
Catch {
    write-host -f Red "Error Cleaning up Version History!" $_.Exception.Message
}

您可以通过以下方式将此清理应用于特定文件夹或子文件夹中的所有文件：

$ListItems = Get-PnPListItem -List $ListName -FolderServerRelativeUrl $FolderServerRelativeURL -PageSize 2000

该脚本保留最近的“N”个版本，并删除文档的所有先前版本。要使用 PowerShell CSOM 清理 SharePoint Online 中的旧版本，请参阅：SharePoint Online：使用 PowerShell CSOM 删除版本历史记录

结论：

总之，出于各种原因，可能需要删除 SharePoint Online 中的版本历史记录，包括释放存储空间和合规性目的。虽然可以手动删除版本历史记录，但这可能是一个耗时的过程，特别是当您有大量文档时。然而，使用 PowerShell 可以使这个过程更加高效和直接。使用本指南中提供的脚本，您只需几个步骤即可轻松删除 SharePoint Online 中的版本历史记录。通过自动执行此任务，您可以节省宝贵的时间，并确保您的 SharePoint Online 环境保持井井有条并根据您的需求进行优化。