-
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
Open
msjennywu
wants to merge
3
commits into
MicrosoftDocs:main
Choose a base branch
from
msjennywu:msjennywu/AddDocForTenantApplyVersionPolicyCmdlets
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
60 changes: 60 additions & 0 deletions
60
....Online.SharePoint.PowerShell/Get-SPOTenantApplyFileVersionPolicyJobProgress.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
msjennywu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
msjennywu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
|
||
msjennywu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ## INPUTS | ||
|
|
||
| ### None | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.Object | ||
| ## NOTES | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md) | ||
|
|
||
| [Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
150 changes: 150 additions & 0 deletions
150
...icrosoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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] | ||
| [<CommonParameters>] | ||
msjennywu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| ## 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. | ||
msjennywu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
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 | ||
|
|
||
| Caution: | ||
msjennywu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - 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) | ||
95 changes: 95 additions & 0 deletions
95
...osoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
msjennywu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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. | ||
|
|
||
| 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) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.