Skip to content

Commit f4c2654

Browse files
author
jennywu
committed
[FileVersion] Add documentation for tenant apply version policy cmdlets
1 parent 44fe6e3 commit f4c2654

3 files changed

Lines changed: 305 additions & 0 deletions

File tree

‎sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOTenantApplyFileVersionPolicyJobProgress.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: microsoft.online.sharepoint.powershell
4+
online version: https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/get-spotenantapplyfileversionpolicyjobprogress
5+
applicable: SharePoint Online
6+
title: Get-SPOTenantApplyFileVersionPolicyJobProgress
7+
schema: 2.0.0
8+
author: msjennywu
9+
ms.author: jennywu
10+
ms.reviewer:
11+
manager: seanmc
12+
---
13+
14+
# Get-SPOTenantApplyFileVersionPolicyJobProgress
15+
16+
## SYNOPSIS
17+
18+
> [!NOTE]
19+
> 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.
20+
21+
Gets the status for a tenant apply file version policy job. SharePoint Advanced Management (SAM) license is required to run this cmdlet.
22+
23+
## SYNTAX
24+
25+
```
26+
Get-SPOTenantApplyFileVersionPolicyJobProgress [<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
31+
Gets the status for a tenant apply file version policy job.
32+
33+
## EXAMPLES
34+
35+
### Example 1
36+
```powershell
37+
Get-SPOTenantApplyFileVersionPolicyJobProgress
38+
```
39+
40+
Example 1 gets the status for a tenant apply file version policy job.
41+
42+
## PARAMETERS
43+
44+
### CommonParameters
45+
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).
46+
47+
## INPUTS
48+
49+
### None
50+
51+
## OUTPUTS
52+
53+
### System.Object
54+
## NOTES
55+
56+
## RELATED LINKS
57+
58+
[New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md)
59+
60+
[Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md)

‎sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/New-SPOTenantApplyFileVersionPolicyJob.md‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: microsoft.online.sharepoint.powershell
4+
online version: https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/new-spotenantapplyfileversionpolicyjob
5+
applicable: SharePoint Online
6+
title: New-SPOTenantApplyFileVersionPolicyJob
7+
schema: 2.0.0
8+
author: msjennywu
9+
ms.author: jennywu
10+
ms.reviewer:
11+
manager: seanmc
12+
---
13+
14+
# New-SPOTenantApplyFileVersionPolicyJob
15+
16+
## SYNOPSIS
17+
18+
> [!NOTE]
19+
> 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.
20+
21+
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.
22+
23+
## SYNTAX
24+
25+
```
26+
New-SPOTenantApplyFileVersionPolicyJob [-TrimVersions] [-SetVersionPolicy] [-WhatIf] [-Confirm]
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
32+
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.
33+
34+
The following site types are excluded from processing:
35+
36+
- Read-only sites
37+
38+
- Locked sites
39+
40+
- Archived sites
41+
42+
- Sites with version policy broken inheritance
43+
44+
Caution:
45+
- Versions deleted using this cmdlet will be permanently deleted and cannot be recovered from the recycle bin.
46+
- 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.
47+
48+
## EXAMPLES
49+
50+
### Example 1
51+
```powershell
52+
New-SPOTenantApplyFileVersionPolicyJob -TrimVersions -SetVersionPolicy
53+
```
54+
55+
Example 1 starts a tenant apply file version policy job to trim versions and set version policy for existing document libraries across all sites.
56+
57+
### Example 2
58+
```powershell
59+
New-SPOTenantApplyFileVersionPolicyJob -TrimVersions
60+
```
61+
62+
Example 2 starts a tenant apply file version policy job to trim versions for files in doducment libraries across all sites.
63+
64+
### Example 3
65+
```powershell
66+
New-SPOTenantApplyFileVersionPolicyJob -SetVersionPolicy
67+
```
68+
69+
Example 3 starts a tenant apply file version policy job to set version policy for existing document libraries across all sites.
70+
71+
## PARAMETERS
72+
73+
### -Confirm
74+
Prompts you for confirmation before running the cmdlet.
75+
76+
```yaml
77+
Type: SwitchParameter
78+
Parameter Sets: (All)
79+
Aliases: cf
80+
81+
Required: False
82+
Position: Named
83+
Default value: None
84+
Accept pipeline input: False
85+
Accept wildcard characters: False
86+
```
87+
88+
### -SetVersionPolicy
89+
Set version policy for existing document libraries across all sites.
90+
91+
```yaml
92+
Type: SwitchParameter
93+
Parameter Sets: (All)
94+
Aliases:
95+
96+
Required: False
97+
Position: Named
98+
Default value: None
99+
Accept pipeline input: False
100+
Accept wildcard characters: False
101+
```
102+
103+
### -TrimVersions
104+
Trim versions for files in document libraries across all sites.
105+
106+
```yaml
107+
Type: SwitchParameter
108+
Parameter Sets: (All)
109+
Aliases:
110+
111+
Required: False
112+
Position: Named
113+
Default value: None
114+
Accept pipeline input: False
115+
Accept wildcard characters: False
116+
```
117+
118+
### -WhatIf
119+
Shows what would happen if the cmdlet runs.
120+
The cmdlet is not run.
121+
122+
```yaml
123+
Type: SwitchParameter
124+
Parameter Sets: (All)
125+
Aliases: wi
126+
127+
Required: False
128+
Position: Named
129+
Default value: None
130+
Accept pipeline input: False
131+
Accept wildcard characters: False
132+
```
133+
134+
### CommonParameters
135+
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).
136+
137+
## INPUTS
138+
139+
### None
140+
141+
## OUTPUTS
142+
143+
### System.Object
144+
## NOTES
145+
146+
## RELATED LINKS
147+
148+
[Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md)
149+
150+
[Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md)

‎sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Remove-SPOTenantApplyFileVersionPolicyJob.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: microsoft.online.sharepoint.powershell
4+
online version: https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/remove-spotenantapplyfileversionpolicyjob
5+
applicable: SharePoint Online
6+
title: Remove-SPOTenantApplyFileVersionPolicyJob
7+
schema: 2.0.0
8+
author: msjennywu
9+
ms.author: jennywu
10+
ms.reviewer:
11+
manager: seanmc
12+
---
13+
14+
# Remove-SPOTenantApplyFileVersionPolicyJob
15+
16+
## SYNOPSIS
17+
18+
> [!NOTE]
19+
> 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.
20+
21+
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.
22+
23+
## SYNTAX
24+
25+
```
26+
Remove-SPOTenantApplyFileVersionPolicyJob [-WhatIf] [-Confirm] [<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
31+
Stops further processing of tenant apply file version policy job that is in-progress.
32+
33+
Caution:
34+
- 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.
35+
- 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.
36+
37+
## EXAMPLES
38+
39+
### Example 1
40+
```powershell
41+
Remove-SPOTenantApplyFileVersionPolicyJob
42+
```
43+
44+
Example 1 cancels further processing of the tenant apply file version policy job.
45+
46+
## PARAMETERS
47+
48+
### -Confirm
49+
Prompts you for confirmation before running the cmdlet.
50+
51+
```yaml
52+
Type: SwitchParameter
53+
Parameter Sets: (All)
54+
Aliases: cf
55+
56+
Required: False
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### -WhatIf
64+
Shows what would happen if the cmdlet runs.
65+
The cmdlet is not run.
66+
67+
```yaml
68+
Type: SwitchParameter
69+
Parameter Sets: (All)
70+
Aliases: wi
71+
72+
Required: False
73+
Position: Named
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### CommonParameters
80+
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).
81+
82+
## INPUTS
83+
84+
### None
85+
86+
## OUTPUTS
87+
88+
### System.Object
89+
## NOTES
90+
91+
## RELATED LINKS
92+
93+
[New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md)
94+
95+
[Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md)

0 commit comments

Comments
 (0)