Skip to content

Commit a80a1a2

Browse files
author
blarrywang
committed
Address comments.
1 parent c503692 commit a80a1a2

File tree

8 files changed

+36
-83
lines changed

8 files changed

+36
-83
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ manager: yigitd
1414
# Get-SPOSiteManageVersionPolicyJobProgress
1515

1616
## SYNOPSIS
17-
Gets the status and progress for background jobs started by `New-SPOSiteManageVersionPolicyJob`.
17+
Gets the status and progress for a background job started by `New-SPOSiteManageVersionPolicyJob`.
1818
> [!NOTE]
1919
> This feature is currently in preview and may not be available in your tenant.
2020
@@ -25,7 +25,7 @@ Get-SPOSiteManageVersionPolicyJobProgress [-Identity] <SpoSitePipeBind> [<Common
2525
```
2626

2727
## DESCRIPTION
28-
Gets the status and progress for background jobs started by `New-SPOSiteManageVersionPolicyJob`.
28+
Gets the status and progress for a background job started by `New-SPOSiteManageVersionPolicyJob`.
2929

3030
## EXAMPLES
3131

@@ -35,7 +35,7 @@ Gets the status and progress for background jobs started by `New-SPOSiteManageVe
3535
Get-SPOSiteManageVersionPolicyJobProgress https://contoso.sharepoint.com/sites/site1
3636
```
3737

38-
Gets the progress of the site manage version policy job for the site.
38+
Gets the progress of the site manage version policy job for the given site.
3939

4040
## PARAMETERS
4141

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ Generates a version storage usage report for a site collection. This report can
463463
Creates a new group in a SharePoint Online site collection.
464464

465465
### [New-SPOSiteManageVersionPolicyJob](New-SPOSiteManageVersionPolicyJob.md)
466-
Starts a background job that manages the file versions and version history limits of all of its document libraries.
466+
Starts a background job to manage file versions and version history limits for all document libraries in the given site.
467467

468468
### [New-SPOSiteSharingReportJob](New-SPOSiteSharingReportJob.md)
469469
Creates a new sharing report job.
@@ -565,7 +565,7 @@ Stops further processing of site level trim job that is in-progress.
565565
Removes a SharePoint Online group from a site collection.
566566

567567
### [Remove-SPOSiteManageVersionPolicyJob](Remove-SPOSiteManageVersionPolicyJob.md)
568-
Stops further processing of site manage version policy job that is in-progress.
568+
Stops processing of the in-progress manage version policy job for the given site.
569569

570570
### [Remove-SPOSiteScript](Remove-SPOSiteScript.md)
571571
Removes a site script.

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

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -167,17 +167,10 @@ Accept wildcard characters: False
167167
168168
### -FileTypes
169169
An array of file type names to trim versions. The supported file type names are:
170-
171170
- Audio
172-
173171
- OutlookPST
174-
175172
- Video
176173
177-
178-
179-
-
180-
181174
```yaml
182175
Type: String[]
183176
Parameter Sets: ByPolicy
@@ -272,10 +265,6 @@ Accept wildcard characters: False
272265
### -TrimUseListPolicy
273266
Indicates whether to trim versions by applying the document library's version history limits.
274267

275-
276-
277-
278-
279268
```yaml
280269
Type: SwitchParameter
281270
Parameter Sets: ByPolicy

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ manager: yigitd
1414
# New-SPOSiteManageVersionPolicyJob
1515

1616
## SYNOPSIS
17-
Starts a background job that manages the file versions and version history limits of all of its document libraries.
17+
Starts a background job to manage file versions and version history limits for all document libraries in the given site.
1818

1919
> [!NOTE]
2020
> This feature is currently in preview and may not be available in your tenant.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ manager: yigitd
1414
# Remove-SPOSiteManageVersionPolicyJob
1515

1616
## SYNOPSIS
17-
Stops further processing of site manage version policy job that is in-progress.
17+
Stops processing of the in-progress manage version policy job for the given site.
1818

1919
> [!NOTE]
2020
> This feature is currently in preview and may not be available in your tenant.
@@ -26,7 +26,7 @@ Remove-SPOSiteManageVersionPolicyJob [-Identity] <SpoSitePipeBind> [-WhatIf] [-C
2626
```
2727

2828
## DESCRIPTION
29-
Stops further processing of site manage version policy job that is in-progress.
29+
Stops processing of the in-progress manage version policy job for the given site.
3030

3131
## EXAMPLES
3232

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

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -216,24 +216,16 @@ Accept wildcard characters: False
216216
> Applicable: SharePoint Online
217217

218218
An array of file type names. The supported file type names are:
219-
220219
- Audio
221-
222220
- OutlookPST
223-
224221
- Video
225222

226223
Apply the version history limits to a set of file types so that they no longer follow the default version history limits. It is used in combination with the following parameters:
224+
- [EnableAutoExpirationVersionTrim](#-EnableAutoExpirationVersionTrim)
225+
- [MajorVersionLimit](#-MajorVersionLimit)
226+
- [ExpireVersionsAfterDays](#-ExpireVersionsAfterDays)
227227

228-
- EnableAutoExpirationVersionTrim
229-
230-
- MajorVersionLimit
231-
232-
- ExpireVersionsAfterDays
233-
234-
Or apply the version history limit override for the file types of the tenant or the site (if the site this document library is in has broken inheritance for version history limits) by using the **Sync** parameter. For more information about this option, please refer to the documentation for the **Sync** parameter.
235-
236-
228+
Or apply the version history limit override for the file types of the tenant or the site (if the site this document library is in has broken inheritance for version history limits) by using the [Sync](#-Sync) parameter. For more information about this option, please refer to the documentation for the [Sync](#-Sync) parameter.
237229

238230
```yaml
239231
Type: String[]
@@ -340,15 +332,10 @@ Accept wildcard characters: False
340332
Apply the version history limits of the tenant or the site (if the site this document library is in has broken inheritance for version history limits).
341333

342334
You may use the following parameters in combination to update only the default policy or a set of file type overrides:
343-
344-
- ExcludeDefaultPolicy: if set, it will not update the default policy.
345-
346-
- FileTypes:
347-
335+
- [ExcludeDefaultPolicy](#-ExcludeDefaultPolicy): if set, it will not update the default policy.
336+
- [FileTypes](#-FileTypes):
348337
- if set, it will update the specified file types;
349-
350338
- if not set, it will update all file type overrides;
351-
352339
- if set to an empty array (i.e. `@()`), it will not update any file type overrides.
353340

354341
> [!NOTE]

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

Lines changed: 18 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -149,14 +149,12 @@ Set-SPOSite [-Identity] <SpoSitePipeBind> [-InformationBarriersMode <String>]
149149

150150
### SetSiteFileTypeFileVersionPolicy
151151

152-
153152
```
154153
Set-SPOSite [-Identity] <SpoSitePipeBind> [-InformationBarriersMode <String>] [-EnableAutoExpirationVersionTrim <Boolean>] [-ExpireVersionsAfterDays <Int32>] [-MajorVersionLimit <Int32>] -FileTypesForVersionExpiration <String[]> [-ApplyToNewDocumentLibraries] [-WhatIf] [-Confirm] [<CommonParameters>]
155154
```
156155

157156
### RemoveSiteFileVersionPolicy
158157

159-
160158
```
161159
Set-SPOSite [-Identity] <SpoSitePipeBind> [-InformationBarriersMode <String>] [-ApplyToNewDocumentLibraries]
162160
[-RemoveVersionExpirationFileTypeOverride <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]
@@ -273,47 +271,47 @@ In this example, an authentication context called MFA is attached to the site.
273271
Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -EnableAutoExpirationVersionTrim $true
274272
```
275273

276-
Example 11 sets automatic version history limits at site level. Automatic setting will be applied to all new document libraries created in the site and a background request will be created to asynchronously process the update on existing document libraries that have versioning enabled.
274+
Example 11 sets automatic version history limits at the site level. Automatic setting will be applied to all new document libraries created in the site and a background request will be created to asynchronously process the update on existing document libraries that have versioning enabled.
277275

278276
### EXAMPLE 12
279277

280278
```powershell
281279
Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -EnableAutoExpirationVersionTrim $false -MajorVersionLimit 500 -MajorWithMinorVersionsLimit 20 -ExpireVersionsAfterDays 30
282280
```
283281

284-
Example 12 sets manual version history limits at site level by limiting the number of versions and the time (in days) versions are kept. The new document libraries will use this version setting. Also it creates a job to set this manual version setting for existing document libraries that enabled versioning.
282+
Example 12 sets manual version history limits at the site level by limiting the number of versions and the time (in days) versions are kept. The new document libraries will use this version setting. Also it creates a job to set this manual version setting for existing document libraries that enabled versioning.
285283

286284
### EXAMPLE 13
287285

288286
```powershell
289287
Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -EnableAutoExpirationVersionTrim $false -MajorVersionLimit 500 -MajorWithMinorVersionsLimit 20 -ExpireVersionsAfterDays 0
290288
```
291289

292-
Example 13 sets manual version history limits at site level by limiting the number of versions with no time limits. The new document libraries will use this version setting. Also it creates a job to set this manual version setting for existing document libraries that enabled versioning.
290+
Example 13 sets manual version history limits at the site level by limiting the number of versions with no time limits. The new document libraries will use this version setting. Also it creates a job to set this manual version setting for existing document libraries that enabled versioning.
293291

294292
### Example 14
295293

296294
```powershell
297295
Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -EnableAutoExpirationVersionTrim $true -ApplyToNewDocumentLibraries
298296
```
299297

300-
Example 14 sets automatic version history limits at site level. The new document libraries will use this version setting.
298+
Example 14 sets automatic version history limits at the site level. The new document libraries will use this version setting.
301299

302300
### EXAMPLE 15
303301

304302
```powershell
305303
Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -EnableAutoExpirationVersionTrim $false -MajorVersionLimit 500 -ExpireVersionsAfterDays 30 -ApplyToNewDocumentLibraries
306304
```
307305

308-
Example 15 sets manual version history limits at site level by limiting the number of versions and the time (in days) versions are kept. The new document libraries will use this version setting.
306+
Example 15 sets manual version history limits at the site level by limiting the number of versions and the time (in days) versions are kept. The new document libraries will use this version setting.
309307

310308
### EXAMPLE 16
311309

312310
```powershell
313311
Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -EnableAutoExpirationVersionTrim $false -MajorVersionLimit 500 -ExpireVersionsAfterDays 0 -ApplyToNewDocumentLibraries
314312
```
315313

316-
Example 16 sets manual version history limits at site level by limiting the number of versions with no time limits. The new document libraries will use this version setting.
314+
Example 16 sets manual version history limits at the site level by limiting the number of versions with no time limits. The new document libraries will use this version setting.
317315

318316
### Example 17
319317

@@ -345,7 +343,7 @@ Example 19 creates a request to set manual version history limits that limits th
345343
Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -InheritVersionPolicyFromTenant
346344
```
347345

348-
Example 20 clears the file version setting at site level. The new document libraries will use the Tenant Level setting. It won't impact the existing document libraries.
346+
Example 20 clears the file version setting at the site level. The new document libraries will use the Tenant Level setting. It won't impact the existing document libraries.
349347

350348
### Example 21
351349

@@ -354,7 +352,7 @@ Example 20 clears the file version setting at site level. The new document libra
354352
Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -EnableAutoExpirationVersionTrim $true -FileTypesForVersionExpiration @("Video", "Audio") -ApplyToNewDocumentLibraries
355353
```
356354

357-
Example 21 sets automatic version history limit override for video and audio file types at site level. The new document libraries will use this version setting.
355+
Example 21 sets automatic version history limit override for video and audio file types at the site level. The new document libraries will use this version setting.
358356

359357
### Example 22
360358

@@ -364,7 +362,7 @@ Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -EnableAutoExpi
364362
-FileTypesForVersionExpiration @("Video", "Audio") -ApplyToNewDocumentLibraries
365363
```
366364

367-
Example 22 sets manual version history limit override for video and audio file types at site level by limiting the number of versions and the time (in days) versions are kept. The new document libraries will use this version setting.
365+
Example 22 sets manual version history limit override for video and audio file types at the site level by limiting the number of versions and the time (in days) versions are kept. The new document libraries will use this version setting.
368366

369367
### Example 23
370368

@@ -374,7 +372,7 @@ Set-SPOSite -Identity https://contoso.sharepoint.com/sites/site1 -EnableAutoExpi
374372
-FileTypesForVersionExpiration @("Video", "Audio") -ApplyToNewDocumentLibraries
375373
```
376374

377-
Example 23 sets manual version history limit override for video and audio file types at site level by limiting the number of versions with no time limits. The new document libraries will use this version setting.
375+
Example 23 sets manual version history limit override for video and audio file types at the site level by limiting the number of versions with no time limits. The new document libraries will use this version setting.
378376

379377
### Example 24
380378

@@ -581,8 +579,7 @@ Accept pipeline input: False
581579
Accept wildcard characters: False
582580
```
583581

584-
585-
```
582+
```yaml
586583
Type: SwitchParameter
587584
Parameter Sets: SetSiteFileTypeFileVersionPolicy
588585
Aliases:
@@ -1241,27 +1238,18 @@ Accept wildcard characters: False
12411238
> Applicable: SharePoint Online
12421239

12431240
An array of file type names. The supported file type names are:
1244-
12451241
- Audio
1246-
12471242
- OutlookPST
1248-
12491243
- Video
12501244

12511245
Apply the version history limits to a set of file types so that they no longer follow the default version history limits. It is used in combination with the following parameters:
1246+
- [EnableAutoExpirationVersionTrim](#-EnableAutoExpirationVersionTrim)
1247+
- [MajorVersionLimit](#-MajorVersionLimit)
1248+
- [ExpireVersionsAfterDays](#-ExpireVersionsAfterDays)
12521249

1253-
- EnableAutoExpirationVersionTrim
1254-
1255-
- MajorVersionLimit
1250+
This must be used with [ApplyToNewDocumentLibraries](#-ApplyToNewDocumentLibraries) switch set to true, because the version history limits are only applied on new document libraries in the site.
12561251

1257-
- ExpireVersionsAfterDays
1258-
1259-
This must be used with **ApplyToNewDocumentLibraries** switch set to true, because the version history limits are only applied on new document libraries in the site.
1260-
1261-
1262-
1263-
1264-
```
1252+
```yaml
12651253
Type: String[]
12661254
Parameter Sets: SetSiteFileTypeFileVersionPolicy
12671255
Aliases:
@@ -1375,7 +1363,7 @@ Accept wildcard characters: False
13751363

13761364
> Applicable: SharePoint Online
13771365

1378-
Clear the file version setting at site level. The new document libraries will use the Tenant Level setting. It won't impact the existing document libraries.
1366+
Clear the file version setting at the site level. The new document libraries will use the Tenant Level setting. It won't impact the existing document libraries.
13791367

13801368
```yaml
13811369
Type: System.Management.Automation.SwitchParameter
@@ -1810,12 +1798,11 @@ Accept wildcard characters: False
18101798

18111799
An array of file type names. Removes the version history limits to a set of file types so that they will follow the default version history limits.
18121800

1813-
This must be used with **ApplyToNewDocumentLibraries** switch set to true, because the version history limits are only applied on new document libraries in the site.
1801+
This must be used with [ApplyToNewDocumentLibraries](#-ApplyToNewDocumentLibraries) switch set to true, because the version history limits are only applied on new document libraries in the site.
18141802

18151803
> [!NOTE]
18161804
> This feature is currently in preview and may not be available in your tenant.
18171805

1818-
18191806
```yaml
18201807
Type: String[]
18211808
Parameter Sets: RemoveSiteFileVersionPolicy

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

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3170,27 +3170,20 @@ Accept wildcard characters: False
31703170
### -FileTypesForVersionExpiration
31713171

31723172
An array of file type names. The supported file type names are:
3173-
31743173
- Audio
3175-
31763174
- OutlookPST
3177-
31783175
- Video
31793176

31803177
Apply the version history limits to a set of file types so that they no longer follow the default version history limits. It is used in combination with the following parameters:
3181-
3182-
- EnableAutoExpirationVersionTrim
3183-
3184-
- MajorVersionLimit
3185-
3186-
- ExpireVersionsAfterDays
3178+
- [EnableAutoExpirationVersionTrim](#-EnableAutoExpirationVersionTrim)
3179+
- [MajorVersionLimit](#-MajorVersionLimit)
3180+
- [ExpireVersionsAfterDays](#-ExpireVersionsAfterDays)
31873181

31883182
The version history limits are applied on new document libraries in the tenant.
31893183

31903184
> [!NOTE]
31913185
> This feature is currently in preview and may not be available in your tenant.
31923186

3193-
31943187
```yaml
31953188
Type: String[]
31963189
Parameter Sets: (All)
@@ -4521,10 +4514,7 @@ The version history limits are applied on new document libraries in the tenant.
45214514
> [!NOTE]
45224515
> This feature is currently in preview and may not be available in your tenant.
45234516

4524-
YAML
4525-
4526-
4527-
```
4517+
```yaml
45284518
Type: String[]
45294519
Parameter Sets: (All)
45304520
Aliases:

0 commit comments

Comments
 (0)