New-SPOSiteFileVersionBatchDeleteJob
Queues a job to trim versions for all document libraries in a site collection.
Syntax
AutomaticTrim
New-SPOSiteFileVersionBatchDeleteJob
[-Identity] <SpoSitePipeBind>
[-Automatic]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DeleteOlderThanDays
New-SPOSiteFileVersionBatchDeleteJob
[-Identity] <SpoSitePipeBind>
[-DeleteBeforeDays <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CountLimits
New-SPOSiteFileVersionBatchDeleteJob
[-Identity] <SpoSitePipeBind>
-MajorVersionLimit <Int32>
-MajorWithMinorVersionsLimit <Int32>
[-WhatIf]
[-Confirm]
[<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.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AutomaticTrim
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
DeleteOlderThanDays
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: SharePoint Online
Specifies the URL of the site collection.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MajorVersionLimit
Trim file version using version count limits. Need to specify MajorWithMinorVersionsLimit as well.
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CountLimits
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MajorWithMinorVersionsLimit
Trim file version using version count limits. Need to specify MajorVersionLimit as well.
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CountLimits
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.