New-SPOListFileVersionBatchDeleteJob
Queues a job to trim versions from a document library.
Syntax
New-SPOListFileVersionBatchDeleteJob
[-Site] <SpoSitePipeBind>
[-List] <SpoListPipeBind>
[-Automatic]
[-DeleteBeforeDays <Int32>]
[-MajorVersionLimit <Int32>]
[-MajorWithMinorVersionsLimit <Int32>]
[<CommonParameters>]
Description
Queues a job to trim versions from a document library.
Caution: Versions trimmed using this command will be permanently deleted and cannot be recovered from the recycle bin.
Examples
EXAMPLE 1
New-SPOListFileVersionBatchDeleteJob -Site https://contoso.sharepoint.com/sites/site1 -List "Documents" -DeleteBeforeDays 360
Example 1 starts a trim job that will delete all file versions that are over 360 days old in the document library called "Documents".
EXAMPLE 2
New-SPOListFileVersionBatchDeleteJob -Site https://contoso.sharepoint.com/sites/site1 -List "Documents" -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 document library called "Documents" based on the automatic backend algorithm.
EXAMPLE 3
New-SPOListFileVersionBatchDeleteJob -Site https://contoso.sharepoint.com/sites/site1 -List "Documents" -MajorVersionLimit 30 -MajorWithMinorVersionsLimit 10
Example 3 starts a trim job that will delete file versions in the document library called "Documents" 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 |
-List
The document library name or Id.
Type: | SPOListPipeBind |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-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 |
-Site
Specifies the URL of the site.
Type: | SpoSitePipeBind |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | SharePoint Online |