Learn Editor: Update New-SPOSiteManageVersionPolicyJob.md

Author: blarrywangmsft

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

@@ -8,7 +8,7 @@ schema: 2.0.0
 # New-SPOSiteManageVersionPolicyJob
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+Starts a background job that manages the file versions and version history limits of all of its document libraries.
 
 ## SYNTAX
 
@@ -25,16 +25,154 @@ New-SPOSiteManageVersionPolicyJob [-Identity] <SpoSitePipeBind> [-FileTypes <Str
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+Starts a background job that does one or more of the following: 
+
+- set the version history limits of all document libraries to that of the site;
+
+- trims version in all document libraries according to each list's version history limits.
+
+This effect can be applied to default version history limits, or a set of file types. Supported file types are:
+
+- Audio
+
+- OutlookPST
+
+- Video
 
 ## EXAMPLES
 
 ### Example 1
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -SyncListPolicy -FileTypes @("Video","Audio") 
+```
+
+Apply the site video, audio, and default version history limits to existing document libraries. If the site is not broken inheritance for version history limits, then it applies the tenant version history limits.
+
+### Example 2
+
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -SyncListPolicy -FileTypes @("Video","Audio") -ExcludeDefaultPolicy
+```
+
+Apply the site video, audio version history limits to existing document libraries. If the site is not broken inheritance for version history limits, then it applies the tenant version history limits.
+
+### Example 3
+
+
 ```powershell
-PS C:\> {{ Add example code here }}
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -SyncListPolicy -FileTypes @()
 ```
 
-{{ Add example description here }}
+Apply the site default version history limits to existing document libraries. If the site is not broken inheritance for version history limits, then it applies the tenant version history limits.
+
+### Example 4
+
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -SyncListPolicy
+```
+
+Apply the site version history limits (including file type overrides) to existing document libraries. If the site is not broken inheritance for version history limits, then it applies the tenant version history limits.
+
+### Example 5
+
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -SyncListPolicy -ExcludeDefaultPolicy
+```
+
+Apply the site level all file type version history limit overrides to existing document libraries. If the site is not broken inheritance for version history limits, then it applies the tenant version history limits.
+
+### Example 6
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -TrimUseListPolicy -FileTypes @("Video","Audio") 
+```
+
+Trim video and audio file versions, and the file versions that don't have a file type override, based on each document library's version history limits.
+
+### Example 7
+
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -TrimUseListPolicy -FileTypes @("Video","Audio") -ExcludeDefaultPolicy
+```
+
+Trim video and audio file versions based on each document library's version history limits.
+
+### Example 8
+
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -TrimUseListPolicy -FileTypes @()
+```
+
+Trim file versions that don't have a file type override based on each document library's version history limits.
+
+### Example 9
+
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -TrimUseListPolicy
+```
+
+Trim all file versions based on each document library's version history limits.
+
+### Example 10
+
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -TrimUseListPolicy -ExcludeDefaultPolicy
+```
+
+Trim all file versions that have a file type override based on each document library's version history limits.
+
+
+### Example 11
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -SyncListPolicy -FileTypes @("Video","Audio") 
+```
+
+Apply the site video, audio, and default version history limits to existing document libraries. If the site is not broken inheritance for version history limits, then it applies the tenant version history limits. Then trim video and audio file versions, and the file versions that don't have a file type override, based on each document library's version history limits.
+
+### Example 12
+
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -SyncListPolicy -TrimUseListPolicy -FileTypes @("Video","Audio") -ExcludeDefaultPolicy
+```
+
+Apply the site video, audio version history limits to existing document libraries. If the site is not broken inheritance for version history limits, then it applies the tenant version history limits. Then trim video and audio file versions based on each document library's version history limits.
+
+### Example 13
+
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -SyncListPolicy -TrimUseListPolicy -FileTypes @()
+```
+
+Apply the site default version history limits to existing document libraries. If the site is not broken inheritance for version history limits, then it applies the tenant version history limits. Then trim file versions that don't have a file type override based on each document library's version history limits.
+
+### Example 14
+
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -SyncListPolicy -TrimUseListPolicy
+```
+
+Apply the site version history limits (including file type overrides) to existing document libraries. If the site is not broken inheritance for version history limits, then it applies the tenant version history limits. Then trim all file versions based on each document library's version history limits.
+
+### Example 15
+
+
+```powershell
+New-SPOSiteManageVersionPolicyJob -Identity $siteUrl -SyncListPolicy -TrimUseListPolicy -ExcludeDefaultPolicy
+```
+
+Apply the site level all file type version history limit overrides to existing document libraries. If the site is not broken inheritance for version history limits, then it applies the tenant version history limits. Then trim all file versions that have a file type override based on each document library's version history limits.
 
 ## PARAMETERS
 
@@ -54,7 +192,7 @@ Accept wildcard characters: False
 ```
 
 ### -ExcludeDefaultPolicy
-{{ Fill ExcludeDefaultPolicy Description }}
+Indicates whether to update the default version history limits and/or to trim file versions that don't have an override.
 
 ```yaml
 Type: SwitchParameter
@@ -69,7 +207,13 @@ Accept wildcard characters: False
 ```
 
 ### -FileTypes
-{{ Fill FileTypes Description }}
+An array of file type names. The supported file type names are:
+
+- Audio
+
+- OutlookPST
+
+- Video
 
 ```yaml
 Type: String[]
@@ -99,7 +243,7 @@ Accept wildcard characters: False
 ```
 
 ### -SyncListPolicy
-{{ Fill SyncListPolicy Description }}
+Indicates whether to update all of the document libraries' version history limits to that of the site. Or if the site is not broken inheritance for version history limits, then it applies the tenant version history limits.
 
 ```yaml
 Type: SwitchParameter
@@ -126,7 +270,7 @@ Accept wildcard characters: False
 ```
 
 ### -TrimUseListPolicy
-{{ Fill TrimUseListPolicy Description }}
+Indicates whether to trim existing versions.
 
 ```yaml
 Type: SwitchParameter
@@ -169,3 +313,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ## NOTES
 
 ## RELATED LINKS
+[Get-SPOSiteManageVersionPolicyJobProgress](Get-SPOSiteManageVersionPolicyJobProgress.md)
+[Remove-SPOSiteManageVersionPolicyJob](Remove-SPOSiteManageVersionPolicyJob.md)