-
Notifications
You must be signed in to change notification settings - Fork 188
[FileVersion] Add documentation for tenant apply version policy cmdlets #1091
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| 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 | ||
|
|
||
| Gets the status for a tenant apply file version policy job. SharePoint Advanced Management license is required to run this cmdlet. | ||
|
|
||
| > [!NOTE] | ||
| > This feature is currently in preview and may not be available in your tenant. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Get-SPOTenantApplyFileVersionPolicyJobProgress [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## 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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). | ||
|
|
||
| ## INPUTS | ||
|
|
||
| ### None | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.Object | ||
| ## NOTES | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md) | ||
|
|
||
| [Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) | ||
|
|
||
| [SharePoint Advanced Management](/sharepoint/sharepoint-advanced-management-licensing) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| --- | ||
| 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 | ||
|
|
||
| Queues a job to apply the tenant-level file version policy across all sites. SharePoint Advanced Management 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] [<CommonParameters>] | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove -WhatIf |
||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| 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. | ||
|
|
||
msjennywu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| The following site types are excluded from processing: | ||
|
|
||
| - Read-only sites | ||
| - Locked sites | ||
| - Archived sites | ||
| - Sites with version policy broken inheritance | ||
|
|
||
| > [!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 | ||
|
|
||
| ### 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 | ||
| Sets 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 | ||
| Trims 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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). | ||
|
|
||
| ## INPUTS | ||
|
|
||
| ### None | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.Object | ||
| ## NOTES | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md) | ||
|
|
||
| [Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) | ||
|
|
||
| [Get-SPOTenant](Get-SPOTenant.md) | ||
|
|
||
| [SharePoint Advanced Management](/sharepoint/sharepoint-advanced-management-licensing) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| --- | ||
| 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 | ||
|
|
||
| Stops further processing of tenant apply file version policy job that is in progress. SharePoint Advanced Management license is required to run this cmdlet. | ||
|
|
||
| > [!NOTE] | ||
| > This feature is currently in preview and may not be available in your tenant. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Remove-SPOTenantApplyFileVersionPolicyJob [-WhatIf] [-Confirm] [<CommonParameters>] | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove -WhatIf |
||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| Stops further processing of tenant apply file version policy job that is in progress. | ||
|
|
||
| > [!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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| > - 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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). | ||
|
|
||
| ## INPUTS | ||
|
|
||
| ### None | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.Object | ||
| ## NOTES | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md) | ||
|
|
||
| [Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md) | ||
|
|
||
| [SharePoint Advanced Management](/sharepoint/sharepoint-advanced-management-licensing) | ||
Uh oh!
There was an error while loading. Please reload this page.