| external help file | Microsoft.Online.SharePoint.PowerShell.dll-Help.xml |
|---|---|
| Module Name | Microsoft.Online.SharePoint.PowerShell |
| online version | https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/new-spositefileversionbatchdeletejob |
| applicable | SharePoint Online |
| title | New-SPOSiteFileVersionBatchDeleteJob |
| schema | 2.0.0 |
| author | msjennywu |
| ms.author | jennywu |
| ms.reviewer | |
| manager | seanmc |
Queues a job to trim versions for all document libraries in a site collection.
New-SPOSiteFileVersionBatchDeleteJob [-Identity] <SpoSitePipeBind> [-Automatic] [-WhatIf] [-Confirm]
[<CommonParameters>]
New-SPOSiteFileVersionBatchDeleteJob [-Identity] <SpoSitePipeBind> [-DeleteBeforeDays <Int32>] [-WhatIf]
[-Confirm] [<CommonParameters>]
New-SPOSiteFileVersionBatchDeleteJob [-Identity] <SpoSitePipeBind> -MajorVersionLimit <Int32>
-MajorWithMinorVersionsLimit <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]
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.
New-SPOSiteFileVersionBatchDeleteJob -Identity https://contoso.sharepoint.com/sites/site1 -DeleteBeforeDays 360Example 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.
New-SPOSiteFileVersionBatchDeleteJob -Identity https://contoso.sharepoint.com/sites/site1 -AutomaticExample 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.
New-SPOSiteFileVersionBatchDeleteJob -Identity https://contoso.sharepoint.com/sites/site1 -MajorVersionLimit 30 -MajorWithMinorVersionsLimit 10Example 3 starts a trim job that will delete file versions in the site collection based on the version count limits.
Trim file versions using automatic version history limit algorithm.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: AutomaticTrim
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe 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: System.Int32
Parameter Sets: DeleteOlderThanDays
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseApplicable: SharePoint Online
Specifies the URL of the site collection.
Type: Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseTrim file version using version count limits. Need to specify MajorWithMinorVersionsLimit as well.
Type: System.Int32
Parameter Sets: CountLimits
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseTrim file version using version count limits. Need to specify MajorVersionLimit as well.
Type: System.Int32
Parameter Sets: CountLimits
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.