Edit

Share via

New-SPOSiteFileVersionBatchDeleteJob

  • Reference
Module:
Microsoft.Online.SharePoint.PowerShell
Applies to:
SharePoint Online

Queues a job to trim versions for all document libraries in a site collection.

Syntax

New-SPOSiteFileVersionBatchDeleteJob
   [-Identity] <SpoSitePipeBind>
   [-Automatic]
   [-DeleteBeforeDays <Int32>]
   [-MajorVersionLimit <Int32>]
   [-MajorWithMinorVersionsLimit <Int32>]
   [<CommonParameters>]

Description

Queues a job to trim versions for all document libraries in a site collection.

Caution: Versions deleted using this cmdlet will be permanently deleted and cannot be recovered from the recycle bin.

Examples

EXAMPLE 1

New-SPOSiteFileVersionBatchDeleteJob -Identity https://contoso.sharepoint.com/sites/site1 -DeleteBeforeDays 360

Example 1 starts a trim job that will delete all file versions that are over 360 days old in all document libraries in the site collection.

EXAMPLE 2

New-SPOSiteFileVersionBatchDeleteJob -Identity https://contoso.sharepoint.com/sites/site1 -Automatic

Example 2 starts a trim job that will delete file versions that expired and set version expiration time for the ones not expired in the site collection based on the backend algorithm.

EXAMPLE 3

New-SPOSiteFileVersionBatchDeleteJob -Identity https://contoso.sharepoint.com/sites/site1 -MajorVersionLimit 30 -MajorWithMinorVersionsLimit 10

Example 3 starts a trim job that will delete file versions in the site collection based on the version count limits.

Parameters

-Automatic

Trim file versions using automatic version history limit algorithm.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DeleteBeforeDays

The minimum age of file versions to trim. In other words, all file versions that are older than this number of days will be deleted.

Type:int
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Identity

Specifies the URL of the site collection.

Type:SpoSitePipeBind
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Online

-MajorVersionLimit

Trim file version using version count limits. Need to specify MajorWithMinorVersionsLimit as well.

Type:int
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MajorWithMinorVersionsLimit

Trim file version using version count limits. Need to specify MajorVersionLimit as well.

Type:int
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False