Skip to content

Commit 21e0ba2

Browse files
authored
Merge branch 'main' into gary-test
2 parents c8031c6 + a323e50 commit 21e0ba2

9 files changed

+934
-29
lines changed

.openpublishing.redirection.ms-ol-sp-ps.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,11 @@
505505
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spositegroup",
506506
"redirect_document_id": true
507507
},
508+
{
509+
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteManageVersionPolicyJobProgress.md",
510+
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spositemanageversionpolicyjobprogress",
511+
"redirect_document_id": true
512+
},
508513
{
509514
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSitePages.md",
510515
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spositepages",
@@ -770,6 +775,11 @@
770775
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/new-spositesharingreportjob",
771776
"redirect_document_id": true
772777
},
778+
{
779+
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteManageVersionPolicyJob.md",
780+
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/new-spositemanageversionpolicyjob",
781+
"redirect_document_id": true
782+
},
773783
{
774784
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Register-SPODataEncryptionPolicy.md",
775785
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/register-spodataencryptionpolicy",
@@ -930,6 +940,11 @@
930940
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spositegroup",
931941
"redirect_document_id": true
932942
},
943+
{
944+
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteManageVersionPolicyJob.md",
945+
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spositemanageversionpolicyjob",
946+
"redirect_document_id": true
947+
},
933948
{
934949
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteScript.md",
935950
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spositescript",
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spositemanageversionpolicyjobprogress
5+
applicable: SharePoint Online
6+
title: Get-SPOSiteManageVersionPolicyJobProgress
7+
schema: 2.0.0
8+
author: blarrywangmsft
9+
ms.author: blarrywang
10+
ms.reviewer:
11+
---
12+
13+
# Get-SPOSiteManageVersionPolicyJobProgress
14+
15+
## SYNOPSIS
16+
Gets the status and progress for a background job started by `New-SPOSiteManageVersionPolicyJob`.
17+
> [!NOTE]
18+
> This feature is currently in preview and may not be available in your tenant.
19+
20+
## SYNTAX
21+
22+
```
23+
Get-SPOSiteManageVersionPolicyJobProgress [-Identity] <SpoSitePipeBind> [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
Gets the status and progress for a background job started by `New-SPOSiteManageVersionPolicyJob`.
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
33+
```
34+
Get-SPOSiteManageVersionPolicyJobProgress https://contoso.sharepoint.com/sites/site1
35+
```
36+
37+
Gets the progress of the site manage version policy job for the given site.
38+
39+
## PARAMETERS
40+
41+
### -Identity
42+
43+
> Applicable: SharePoint Online
44+
45+
Specifies the URL of the site collection.
46+
47+
```yaml
48+
Type: SpoSitePipeBind
49+
Parameter Sets: (All)
50+
Aliases:
51+
52+
Required: True
53+
Position: 0
54+
Default value: None
55+
Accept pipeline input: True (ByValue)
56+
Accept wildcard characters: False
57+
```
58+
59+
### CommonParameters
60+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
61+
62+
## INPUTS
63+
64+
### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind
65+
66+
## OUTPUTS
67+
68+
### System.Object
69+
## NOTES
70+
71+
## RELATED LINKS
72+
73+
[New-SPOSiteManageVersionPolicyJob](New-SPOSiteManageVersionPolicyJob.md)
74+
75+
[Remove-SPOSiteManageVersionPolicyJob](Remove-SPOSiteManageVersionPolicyJob.md)

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,9 @@ Gets the status for a file version expiration report generation job for a site c
315315
### [Get-SPOSiteGroup](Get-SPOSiteGroup.md)
316316
Gets all the groups on the specified site collection.
317317

318+
### [Get-SPOSiteManageVersionPolicyJobProgress](Get-SPOSiteManageVersionPolicyJobProgress.md)
319+
Gets the status and progress for site manage version policy jobs.
320+
318321
### [Get-SPOSitePages](Get-SPOSitePages.md)
319322
This cmdlet allows you to retrieve all SharePoint pages under a specific SharePoint site.
320323

@@ -465,6 +468,9 @@ Generates a version storage usage report for a site collection. This report can
465468
### [New-SPOSiteGroup](New-SPOSiteGroup.md)
466469
Creates a new group in a SharePoint Online site collection.
467470

471+
### [New-SPOSiteManageVersionPolicyJob](New-SPOSiteManageVersionPolicyJob.md)
472+
Starts a background job to manage file versions and version history limits for all document libraries in the given site.
473+
468474
### [New-SPOSiteSharingReportJob](New-SPOSiteSharingReportJob.md)
469475
Creates a new sharing report job.
470476

@@ -567,6 +573,9 @@ Stops further processing of site level trim job that is in-progress.
567573
### [Remove-SPOSiteGroup](Remove-SPOSiteGroup.md)
568574
Removes a SharePoint Online group from a site collection.
569575

576+
### [Remove-SPOSiteManageVersionPolicyJob](Remove-SPOSiteManageVersionPolicyJob.md)
577+
Stops processing of the in-progress manage version policy job for the given site.
578+
570579
### [Remove-SPOSiteScript](Remove-SPOSiteScript.md)
571580
Removes a site script.
572581

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOListFileVersionBatchDeleteJob.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@ New-SPOListFileVersionBatchDeleteJob [-Site] <SpoSitePipeBind> -List <SPOListPip
3737
-MajorVersionLimit <Int32> -MajorWithMinorVersionsLimit <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]
3838
```
3939

40+
### ByPolicy
41+
```
42+
New-SPOListFileVersionBatchDeleteJob [-Site] <SpoSitePipeBind> -List <SPOListPipeBind> [-FileTypes <String[]>]
43+
[-ExcludeDefaultPolicy] [-TrimUseListPolicy] [-WhatIf] [-Confirm] [<CommonParameters>]
44+
```
45+
4046
## DESCRIPTION
4147

4248
Queues a job to trim versions from a document library.
@@ -69,6 +75,30 @@ New-SPOListFileVersionBatchDeleteJob -Site https://contoso.sharepoint.com/sites/
6975

7076
Example 3 starts a trim job that will delete file versions in the document library called "Documents" based on the version count limits.
7177

78+
### EXAMPLE 4
79+
80+
```powershell
81+
New-SPOListFileVersionBatchDeleteJob -Site https://contoso.sharepoint.com/sites/site1 -List "Documents" -TrimUseListPolicy
82+
```
83+
84+
Example 4 starts a trim job that will delete file versions in the document library called "Documents" based on the version history limits of the document library.
85+
86+
### EXAMPLE 5
87+
88+
```powershell
89+
New-SPOListFileVersionBatchDeleteJob -Site https://contoso.sharepoint.com/sites/site1 -List "Documents" -TrimUseListPolicy -FileTypes @("Video", "Audio")
90+
```
91+
92+
Example 5 starts a trim job that will delete file versions for video and audio file types, and file versions that do not belong to a file type override in the document library based on the version history limits of the document library.
93+
94+
### EXAMPLE 6
95+
96+
```powershell
97+
New-SPOListFileVersionBatchDeleteJob -Site https://contoso.sharepoint.com/sites/site1 -List "Documents" -TrimUseListPolicy -FileTypes @("Video", "Audio") -ExcludeDefaultPolicy
98+
```
99+
100+
Example 6 starts a trim job that will delete file versions for video and audio file types in the document library based on the version history limits of the document library.
101+
72102
## PARAMETERS
73103

74104
### -Automatic
@@ -101,6 +131,45 @@ Accept pipeline input: False
101131
Accept wildcard characters: False
102132
```
103133
134+
### -ExcludeDefaultPolicy
135+
Indicates whether to trim versions based on the default version history limits.
136+
137+
> [!NOTE]
138+
> This feature is currently in preview and may not be available in your tenant.
139+
140+
```yaml
141+
Type: SwitchParameter
142+
Parameter Sets: ByPolicy
143+
Aliases:
144+
145+
Required: False
146+
Position: Named
147+
Default value: None
148+
Accept pipeline input: False
149+
Accept wildcard characters: False
150+
```
151+
152+
### -FileTypes
153+
An array of file type names to trim versions. The supported file type names are:
154+
- Audio
155+
- OutlookPST
156+
- Video
157+
158+
> [!NOTE]
159+
> This feature is currently in preview and may not be available in your tenant.
160+
161+
```yaml
162+
Type: String[]
163+
Parameter Sets: ByPolicy
164+
Aliases:
165+
166+
Required: False
167+
Position: Named
168+
Default value: None
169+
Accept pipeline input: False
170+
Accept wildcard characters: False
171+
```
172+
104173
### -List
105174
106175
The document library name or Id.
@@ -180,6 +249,24 @@ Accept pipeline input: False
180249
Accept wildcard characters: False
181250
```
182251

252+
### -TrimUseListPolicy
253+
Indicates whether to trim versions by applying the document library's version history limits.
254+
255+
> [!NOTE]
256+
> This feature is currently in preview and may not be available in your tenant.
257+
258+
```yaml
259+
Type: SwitchParameter
260+
Parameter Sets: ByPolicy
261+
Aliases:
262+
263+
Required: False
264+
Position: Named
265+
Default value: None
266+
Accept pipeline input: False
267+
Accept wildcard characters: False
268+
```
269+
183270
### -WhatIf
184271
Shows what would happen if the cmdlet runs.
185272
The cmdlet is not run.

0 commit comments

Comments
 (0)