From f4c2654a81cfc0d2da37c71d6f330580cb5b9d0c Mon Sep 17 00:00:00 2001 From: jennywu Date: Wed, 14 Jan 2026 11:30:32 -0800 Subject: [PATCH 1/5] [FileVersion] Add documentation for tenant apply version policy cmdlets --- ...TenantApplyFileVersionPolicyJobProgress.md | 60 +++++++ .../New-SPOTenantApplyFileVersionPolicyJob.md | 150 ++++++++++++++++++ ...move-SPOTenantApplyFileVersionPolicyJob.md | 95 +++++++++++ 3 files changed, 305 insertions(+) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantApplyFileVersionPolicyJobProgress.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantApplyFileVersionPolicyJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantApplyFileVersionPolicyJobProgress.md new file mode 100644 index 000000000..8ea129545 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantApplyFileVersionPolicyJobProgress.md @@ -0,0 +1,60 @@ +--- +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/get-spotenantapplyfileversionpolicyjobprogress +applicable: SharePoint Online +title: Get-SPOTenantApplyFileVersionPolicyJobProgress +schema: 2.0.0 +author: msjennywu +ms.author: jennywu +ms.reviewer: +manager: seanmc +--- + +# Get-SPOTenantApplyFileVersionPolicyJobProgress + +## SYNOPSIS + +> [!NOTE] +> This feature is part of the version history controls preview. If your tenant is not part of the preview or the feature has not rolled out to your tenant, you will get an error when trying to run this cmdlet. + +Gets the status for a tenant apply file version policy job. SharePoint Advanced Management (SAM) license is required to run this cmdlet. + +## SYNTAX + +``` +Get-SPOTenantApplyFileVersionPolicyJobProgress [] +``` + +## DESCRIPTION + +Gets the status for a tenant apply file version policy job. + +## EXAMPLES + +### Example 1 +```powershell +Get-SPOTenantApplyFileVersionPolicyJobProgress +``` + +Example 1 gets the status for a tenant apply file version policy job. + +## PARAMETERS + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS + +[New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md) + +[Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md new file mode 100644 index 000000000..9ce7a54a8 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md @@ -0,0 +1,150 @@ +--- +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-spotenantapplyfileversionpolicyjob +applicable: SharePoint Online +title: New-SPOTenantApplyFileVersionPolicyJob +schema: 2.0.0 +author: msjennywu +ms.author: jennywu +ms.reviewer: +manager: seanmc +--- + +# New-SPOTenantApplyFileVersionPolicyJob + +## SYNOPSIS + +> [!NOTE] +> This feature is part of the version history controls preview. If your tenant is not part of the preview or the feature has not rolled out to your tenant, you will get an error when trying to run this cmdlet. + +Queues a job to apply the tenant-level file version policy across all sites. SharePoint Advanced Management (SAM) license is required to run this cmdlet. + +## SYNTAX + +``` +New-SPOTenantApplyFileVersionPolicyJob [-TrimVersions] [-SetVersionPolicy] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION + +Queues a job to apply the tenant-level file version policy across all sites. The job trims existing file versions and/or set version policy for existing document libraries based on the version policy configured at the tenant level. + +The following site types are excluded from processing: + +- Read-only sites + +- Locked sites + +- Archived sites + +- Sites with version policy broken inheritance + +Caution: +- Versions deleted using this cmdlet will be permanently deleted and cannot be recovered from the recycle bin. +- If the tenant-level version policy is modified while the job is in progress, the job will apply the updated policy to the remaining sites that have not yet been processed. Sites that were already processed will not be re-evaluated or updated. + +## EXAMPLES + +### Example 1 +```powershell +New-SPOTenantApplyFileVersionPolicyJob -TrimVersions -SetVersionPolicy +``` + +Example 1 starts a tenant apply file version policy job to trim versions and set version policy for existing document libraries across all sites. + +### Example 2 +```powershell +New-SPOTenantApplyFileVersionPolicyJob -TrimVersions +``` + +Example 2 starts a tenant apply file version policy job to trim versions for files in doducment libraries across all sites. + +### Example 3 +```powershell +New-SPOTenantApplyFileVersionPolicyJob -SetVersionPolicy +``` + +Example 3 starts a tenant apply file version policy job to set version policy for existing document libraries across all sites. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetVersionPolicy +Set version policy for existing document libraries across all sites. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TrimVersions +Trim versions for files in document libraries across all sites. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS + +[Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md) + +[Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md new file mode 100644 index 000000000..aba093f6b --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md @@ -0,0 +1,95 @@ +--- +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/remove-spotenantapplyfileversionpolicyjob +applicable: SharePoint Online +title: Remove-SPOTenantApplyFileVersionPolicyJob +schema: 2.0.0 +author: msjennywu +ms.author: jennywu +ms.reviewer: +manager: seanmc +--- + +# Remove-SPOTenantApplyFileVersionPolicyJob + +## SYNOPSIS + +> [!NOTE] +> This feature is part of the version history controls preview. If your tenant is not part of the preview or the feature has not rolled out to your tenant, you will get an error when trying to run this cmdlet. + +Stops further processing of tenant apply file version policy job that is in-progress. SharePoint Advanced Management (SAM) license is required to run this cmdlet. + +## SYNTAX + +``` +Remove-SPOTenantApplyFileVersionPolicyJob [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +Stops further processing of tenant apply file version policy job that is in-progress. + +Caution: +- When 'TrimVersions' is specified in the job, this will stop creating new jobs that trim versions for sites. This does not affect versions that were already permanently deleted while the job was running. +- When 'SetVersionPolicy' is specified in the job, this will stop creating new jobs that apply the new version policy to existing document libraries for sites. The version policies that were already applied remain in place and will not be reverted. + +## EXAMPLES + +### Example 1 +```powershell +Remove-SPOTenantApplyFileVersionPolicyJob +``` + +Example 1 cancels further processing of the tenant apply file version policy job. + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +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). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS + +[New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md) + +[Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md) From 992de28261cffa367b296845242da3767373f324 Mon Sep 17 00:00:00 2001 From: jennywu Date: Wed, 14 Jan 2026 11:54:43 -0800 Subject: [PATCH 2/5] Add cmdlets in the list on page Microsoft.Online.SharePoint.PowerShell.md --- .../Microsoft.Online.SharePoint.PowerShell.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md index 50fe76c51..e0d91b4bc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md @@ -363,6 +363,9 @@ Get the structural navigation caching state for a web. ### [Get-SPOTenant](Get-SPOTenant.md) Returns SharePoint Online organization properties. +### [Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md) +Gets the status for a tenant apply file version policy job. + ### [Get-SPOTenantCdnEnabled](Get-SPOTenantCdnEnabled.md) Returns whether Public content delivery network (CDN) or Private CDN is enabled on the tenant level. Requires Tenant administrator permissions. @@ -483,6 +486,9 @@ Starts a background job to manage file versions and version history limits for a ### [New-SPOSiteSharingReportJob](New-SPOSiteSharingReportJob.md) Creates a new sharing report job. +### [New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md) +Queues a job to apply the tenant-level file version policy across all sites. + ### [Register-SPODataEncryptionPolicy](Register-SPODataEncryptionPolicy.md) Cmdlet to register customer encryption status for your geo tenant. For more information, see [Controlling your data in Office 365 using Customer Key](/microsoft-365/compliance/controlling-your-data-using-customer-key) @@ -600,6 +606,9 @@ Cancels further processing of version settings update on existing document libra ### [Remove-SPOStorageEntity](Remove-SPOStorageEntity.md) Tenant properties allow tenant administrators to add properties in the app catalog that can be read by various SharePoint Framework components. Because tenant properties are stored in the tenant app catalog, you must provide the tenant app catalog site collection URL or the site collection app catalog URL in the following cmdlets. This cmdlet is used to remove a value in the property bag. +### [Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) +Stops further processing of tenant apply file version policy job that is in-progress. + ### [Remove-SPOTenantCdnOrigin](Remove-SPOTenantCdnOrigin.md) Removes a new origin from the Public or Private content delivery network (CDN). Requires Tenant administrator permissions. From 02ec3fa8c15554710ad1b7dfc0d4506dc6af5272 Mon Sep 17 00:00:00 2001 From: jennywu Date: Thu, 15 Jan 2026 11:38:34 -0800 Subject: [PATCH 3/5] Resolve comments --- ...TenantApplyFileVersionPolicyJobProgress.md | 12 ++++--- .../Microsoft.Online.SharePoint.PowerShell.md | 6 ++-- .../New-SPOTenantApplyFileVersionPolicyJob.md | 34 ++++++++++--------- ...move-SPOTenantApplyFileVersionPolicyJob.md | 18 +++++----- 4 files changed, 38 insertions(+), 32 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantApplyFileVersionPolicyJobProgress.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantApplyFileVersionPolicyJobProgress.md index 8ea129545..872673139 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantApplyFileVersionPolicyJobProgress.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantApplyFileVersionPolicyJobProgress.md @@ -15,10 +15,10 @@ manager: seanmc ## SYNOPSIS -> [!NOTE] -> This feature is part of the version history controls preview. If your tenant is not part of the preview or the feature has not rolled out to your tenant, you will get an error when trying to run this cmdlet. +Gets the status for a tenant apply file version policy job. SharePoint Advanced Management license is required to run this cmdlet. -Gets the status for a tenant apply file version policy job. SharePoint Advanced Management (SAM) license is required to run this cmdlet. +> [!NOTE] +> This feature is currently in preview and may not be available in your tenant. ## SYNTAX @@ -42,7 +42,7 @@ Example 1 gets the status for a tenant apply file version policy job. ## PARAMETERS ### CommonParameters -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). +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -57,4 +57,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md) -[Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) \ No newline at end of file +[Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) + +[SharePoint Advanced Management](/sharepoint/sharepoint-advanced-management-licensing) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md index e0d91b4bc..506f96665 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md @@ -364,7 +364,7 @@ Get the structural navigation caching state for a web. Returns SharePoint Online organization properties. ### [Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md) -Gets the status for a tenant apply file version policy job. +Gets the status for a tenant apply file version policy job. SharePoint Advanced Management license is required to run this cmdlet. ### [Get-SPOTenantCdnEnabled](Get-SPOTenantCdnEnabled.md) Returns whether Public content delivery network (CDN) or Private CDN is enabled on the tenant level. Requires Tenant administrator permissions. @@ -487,7 +487,7 @@ Starts a background job to manage file versions and version history limits for a Creates a new sharing report job. ### [New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md) -Queues a job to apply the tenant-level file version policy across all sites. +Queues a job to apply the tenant-level file version policy across all sites. SharePoint Advanced Management license is required to run this cmdlet. ### [Register-SPODataEncryptionPolicy](Register-SPODataEncryptionPolicy.md) Cmdlet to register customer encryption status for your geo tenant. For more information, see [Controlling your data in Office 365 using Customer Key](/microsoft-365/compliance/controlling-your-data-using-customer-key) @@ -607,7 +607,7 @@ Cancels further processing of version settings update on existing document libra Tenant properties allow tenant administrators to add properties in the app catalog that can be read by various SharePoint Framework components. Because tenant properties are stored in the tenant app catalog, you must provide the tenant app catalog site collection URL or the site collection app catalog URL in the following cmdlets. This cmdlet is used to remove a value in the property bag. ### [Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) -Stops further processing of tenant apply file version policy job that is in-progress. +Stops further processing of tenant apply file version policy job that is in-progress. SharePoint Advanced Management license is required to run this cmdlet. ### [Remove-SPOTenantCdnOrigin](Remove-SPOTenantCdnOrigin.md) Removes a new origin from the Public or Private content delivery network (CDN). Requires Tenant administrator permissions. diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md index 9ce7a54a8..4aa2949d9 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md @@ -15,35 +15,33 @@ manager: seanmc ## SYNOPSIS -> [!NOTE] -> This feature is part of the version history controls preview. If your tenant is not part of the preview or the feature has not rolled out to your tenant, you will get an error when trying to run this cmdlet. +Queues a job to apply the tenant-level file version policy across all sites. SharePoint Advanced Management license is required to run this cmdlet. -Queues a job to apply the tenant-level file version policy across all sites. SharePoint Advanced Management (SAM) license is required to run this cmdlet. +> [!NOTE] +> This feature is currently in preview and may not be available in your tenant. ## SYNTAX ``` -New-SPOTenantApplyFileVersionPolicyJob [-TrimVersions] [-SetVersionPolicy] [-WhatIf] [-Confirm] - [] +New-SPOTenantApplyFileVersionPolicyJob [-TrimVersions] [-SetVersionPolicy] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Queues a job to apply the tenant-level file version policy across all sites. The job trims existing file versions and/or set version policy for existing document libraries based on the version policy configured at the tenant level. +Queues a job to apply the tenant-level file version policy across all sites. The job trims existing file versions and/or sets version policy for existing document libraries based on the version policy configured at the tenant level. The following site types are excluded from processing: - Read-only sites - - Locked sites - - Archived sites - - Sites with version policy broken inheritance -Caution: -- Versions deleted using this cmdlet will be permanently deleted and cannot be recovered from the recycle bin. -- If the tenant-level version policy is modified while the job is in progress, the job will apply the updated policy to the remaining sites that have not yet been processed. Sites that were already processed will not be re-evaluated or updated. +> [!NOTE] +> - Versions deleted using this cmdlet will be permanently deleted and cannot be recovered from the recycle bin. +> - Use `Get-SPOTenant` cmdlet and the `EnableAutoExpirationVersionTrim`, `MajorVersionLimit`, `ExpireVersionsAfterDays` and `VersionPolicyFileTypeOverride` properties to confirm the tenant-level file version policy before running the cmdlet to make sure it matches your intended configuration. +> - If the tenant-level version policy changes while the job is in progress, the job will apply the updated policy to the remaining sites that have not yet been processed. Sites that were already processed will not be re-evaluated or updated. +> - Allow only one job per tenant. ## EXAMPLES @@ -86,7 +84,7 @@ Accept wildcard characters: False ``` ### -SetVersionPolicy -Set version policy for existing document libraries across all sites. +Sets version policy for existing document libraries across all sites. ```yaml Type: SwitchParameter @@ -101,7 +99,7 @@ Accept wildcard characters: False ``` ### -TrimVersions -Trim versions for files in document libraries across all sites. +Trims versions for files in document libraries across all sites. ```yaml Type: SwitchParameter @@ -132,7 +130,7 @@ Accept wildcard characters: False ``` ### CommonParameters -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). +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -147,4 +145,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md) -[Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) \ No newline at end of file +[Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) + +[Get-SPOTenant](Get-SPOTenant.md) + +[SharePoint Advanced Management](/sharepoint/sharepoint-advanced-management-licensing) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md index aba093f6b..2ed15da64 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md @@ -15,10 +15,10 @@ manager: seanmc ## SYNOPSIS -> [!NOTE] -> This feature is part of the version history controls preview. If your tenant is not part of the preview or the feature has not rolled out to your tenant, you will get an error when trying to run this cmdlet. +Stops further processing of tenant apply file version policy job that is in progress. SharePoint Advanced Management license is required to run this cmdlet. -Stops further processing of tenant apply file version policy job that is in-progress. SharePoint Advanced Management (SAM) license is required to run this cmdlet. +> [!NOTE] +> This feature is currently in preview and may not be available in your tenant. ## SYNTAX @@ -28,11 +28,11 @@ Remove-SPOTenantApplyFileVersionPolicyJob [-WhatIf] [-Confirm] [ [!NOTE] +> - When 'TrimVersions' is specified in the job, this will stop creating new jobs that trim versions for sites. This does not affect versions that were already permanently deleted while the job was running. +> - When 'SetVersionPolicy' is specified in the job, this will stop creating new jobs that apply the new version policy to existing document libraries for sites. The version policies that were already applied remain in place and will not be reverted. ## EXAMPLES @@ -77,7 +77,7 @@ Accept wildcard characters: False ``` ### CommonParameters -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). +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## INPUTS @@ -93,3 +93,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md) [Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md) + +[SharePoint Advanced Management](/sharepoint/sharepoint-advanced-management-licensing) From d04c315759d48f2404c33f50aa7e99f7a86de2b5 Mon Sep 17 00:00:00 2001 From: jennywu Date: Tue, 20 Jan 2026 15:22:31 -0800 Subject: [PATCH 4/5] Resolve comments and updates --- .../New-SPOTenantApplyFileVersionPolicyJob.md | 8 ++++---- .../Remove-SPOTenantApplyFileVersionPolicyJob.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md index 4aa2949d9..b15f554fc 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md @@ -50,14 +50,14 @@ The following site types are excluded from processing: New-SPOTenantApplyFileVersionPolicyJob -TrimVersions -SetVersionPolicy ``` -Example 1 starts a tenant apply file version policy job to trim versions and set version policy for existing document libraries across all sites. +Example 1 starts a tenant apply file version policy job to trim existing versions and set version policy for existing document libraries across all sites. ### Example 2 ```powershell New-SPOTenantApplyFileVersionPolicyJob -TrimVersions ``` -Example 2 starts a tenant apply file version policy job to trim versions for files in doducment libraries across all sites. +Example 2 starts a tenant apply file version policy job to trim existing versions for files in doducment libraries across all sites. ### Example 3 ```powershell @@ -84,7 +84,7 @@ Accept wildcard characters: False ``` ### -SetVersionPolicy -Sets version policy for existing document libraries across all sites. +Sets version policy for existing document libraries across all sites based on the tenant-level file version policy. The version policy applys to new versions created in these existing document libraries. ```yaml Type: SwitchParameter @@ -99,7 +99,7 @@ Accept wildcard characters: False ``` ### -TrimVersions -Trims versions for files in document libraries across all sites. +Trims existing versions for files in document libraries across all sites based on the tenant-level file version policy. ```yaml Type: SwitchParameter diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md index 2ed15da64..ed33d87d3 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md @@ -31,8 +31,8 @@ Remove-SPOTenantApplyFileVersionPolicyJob [-WhatIf] [-Confirm] [ [!NOTE] -> - When 'TrimVersions' is specified in the job, this will stop creating new jobs that trim versions for sites. This does not affect versions that were already permanently deleted while the job was running. -> - When 'SetVersionPolicy' is specified in the job, this will stop creating new jobs that apply the new version policy to existing document libraries for sites. The version policies that were already applied remain in place and will not be reverted. +> - If the tenant apply version job is queued by using the cmdlet `New-SPOTenantApplyFileVersionPolicyJob` with the `TrimVersions` parameter, this will stop creating new sub-jobs that trim versions for sites. This does not affect versions that were already permanently deleted while the job was running. +> - If the tenant apply version job is queued by using the cmdlet `New-SPOTenantApplyFileVersionPolicyJob` with the `SetVersionPolicy` parameter, this will stop creating new sub-jobs that apply the new version policy to existing document libraries for sites. The version policies that were already applied remain in place and will not be reverted. ## EXAMPLES From 8c1105cd0e0748ddfb767d7ee5076c403790cdb6 Mon Sep 17 00:00:00 2001 From: jennywu Date: Wed, 21 Jan 2026 11:31:34 -0800 Subject: [PATCH 5/5] Resolve comments --- .../Microsoft.Online.SharePoint.PowerShell.md | 2 +- .../New-SPOTenantApplyFileVersionPolicyJob.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md index 506f96665..7212d8199 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md @@ -607,7 +607,7 @@ Cancels further processing of version settings update on existing document libra Tenant properties allow tenant administrators to add properties in the app catalog that can be read by various SharePoint Framework components. Because tenant properties are stored in the tenant app catalog, you must provide the tenant app catalog site collection URL or the site collection app catalog URL in the following cmdlets. This cmdlet is used to remove a value in the property bag. ### [Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) -Stops further processing of tenant apply file version policy job that is in-progress. SharePoint Advanced Management license is required to run this cmdlet. +Stops further processing of tenant apply file version policy job that is in progress. SharePoint Advanced Management license is required to run this cmdlet. ### [Remove-SPOTenantCdnOrigin](Remove-SPOTenantCdnOrigin.md) Removes a new origin from the Public or Private content delivery network (CDN). Requires Tenant administrator permissions. diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md index b15f554fc..44e8921cd 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md @@ -84,7 +84,7 @@ Accept wildcard characters: False ``` ### -SetVersionPolicy -Sets version policy for existing document libraries across all sites based on the tenant-level file version policy. The version policy applys to new versions created in these existing document libraries. +Sets version policy for existing document libraries across all sites based on the tenant-level file version policy. The version policy applies to new versions created in these existing document libraries. ```yaml Type: SwitchParameter