Skip to content

Commit f504f33

Browse files
m365-skilling-repo-management[bot]m365-skilling-repo-management[bot]
authored
Merge pull request #1092 from MicrosoftDocs/main
[AutoPublish] main to live - 01/22 19:52 PST | 01/23 09:22 IST
2 parents 79e87d1 + 75682d4 commit f504f33

4 files changed

Lines changed: 320 additions & 0 deletions

File tree

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

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
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+
Gets the status for a tenant apply file version policy job. SharePoint Advanced Management license is required to run this cmdlet.
19+
20+
> [!NOTE]
21+
> This feature is currently in preview and may not be available in your tenant.
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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
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)
61+
62+
[SharePoint Advanced Management](/sharepoint/sharepoint-advanced-management-licensing)

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -363,6 +363,9 @@ Get the structural navigation caching state for a web.
363363
### [Get-SPOTenant](Get-SPOTenant.md)
364364
Returns SharePoint Online organization properties.
365365

366+
### [Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md)
367+
Gets the status for a tenant apply file version policy job. SharePoint Advanced Management license is required to run this cmdlet.
368+
366369
### [Get-SPOTenantCdnEnabled](Get-SPOTenantCdnEnabled.md)
367370
Returns whether Public content delivery network (CDN) or Private CDN is enabled on the tenant level. Requires Tenant administrator permissions.
368371

@@ -483,6 +486,9 @@ Starts a background job to manage file versions and version history limits for a
483486
### [New-SPOSiteSharingReportJob](New-SPOSiteSharingReportJob.md)
484487
Creates a new sharing report job.
485488

489+
### [New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md)
490+
Queues a job to apply the tenant-level file version policy across all sites. SharePoint Advanced Management license is required to run this cmdlet.
491+
486492
### [Register-SPODataEncryptionPolicy](Register-SPODataEncryptionPolicy.md)
487493
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)
488494

@@ -600,6 +606,9 @@ Cancels further processing of version settings update on existing document libra
600606
### [Remove-SPOStorageEntity](Remove-SPOStorageEntity.md)
601607
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.
602608

609+
### [Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md)
610+
Stops further processing of tenant apply file version policy job that is in progress. SharePoint Advanced Management license is required to run this cmdlet.
611+
603612
### [Remove-SPOTenantCdnOrigin](Remove-SPOTenantCdnOrigin.md)
604613
Removes a new origin from the Public or Private content delivery network (CDN). Requires Tenant administrator permissions.
605614

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

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
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+
Queues a job to apply the tenant-level file version policy across all sites. SharePoint Advanced Management license is required to run this cmdlet.
19+
20+
> [!NOTE]
21+
> This feature is currently in preview and may not be available in your tenant.
22+
23+
## SYNTAX
24+
25+
```
26+
New-SPOTenantApplyFileVersionPolicyJob [-TrimVersions] [-SetVersionPolicy] [-WhatIf] [-Confirm] [<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
31+
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.
32+
33+
The following site types are excluded from processing:
34+
35+
- Read-only sites
36+
- Locked sites
37+
- Archived sites
38+
- Sites with version policy broken inheritance
39+
40+
> [!NOTE]
41+
> - Versions deleted using this cmdlet will be permanently deleted and cannot be recovered from the recycle bin.
42+
> - 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.
43+
> - 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.
44+
> - Allow only one job per tenant.
45+
46+
## EXAMPLES
47+
48+
### Example 1
49+
```powershell
50+
New-SPOTenantApplyFileVersionPolicyJob -TrimVersions -SetVersionPolicy
51+
```
52+
53+
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.
54+
55+
### Example 2
56+
```powershell
57+
New-SPOTenantApplyFileVersionPolicyJob -TrimVersions
58+
```
59+
60+
Example 2 starts a tenant apply file version policy job to trim existing versions for files in document libraries across all sites.
61+
62+
### Example 3
63+
```powershell
64+
New-SPOTenantApplyFileVersionPolicyJob -SetVersionPolicy
65+
```
66+
67+
Example 3 starts a tenant apply file version policy job to set version policy for existing document libraries across all sites.
68+
69+
## PARAMETERS
70+
71+
### -Confirm
72+
Prompts you for confirmation before running the cmdlet.
73+
74+
```yaml
75+
Type: SwitchParameter
76+
Parameter Sets: (All)
77+
Aliases: cf
78+
79+
Required: False
80+
Position: Named
81+
Default value: None
82+
Accept pipeline input: False
83+
Accept wildcard characters: False
84+
```
85+
86+
### -SetVersionPolicy
87+
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.
88+
89+
```yaml
90+
Type: SwitchParameter
91+
Parameter Sets: (All)
92+
Aliases:
93+
94+
Required: False
95+
Position: Named
96+
Default value: None
97+
Accept pipeline input: False
98+
Accept wildcard characters: False
99+
```
100+
101+
### -TrimVersions
102+
Trims existing versions for files in document libraries across all sites based on the tenant-level file version policy.
103+
104+
```yaml
105+
Type: SwitchParameter
106+
Parameter Sets: (All)
107+
Aliases:
108+
109+
Required: False
110+
Position: Named
111+
Default value: None
112+
Accept pipeline input: False
113+
Accept wildcard characters: False
114+
```
115+
116+
### -WhatIf
117+
Shows what would happen if the cmdlet runs.
118+
The cmdlet is not run.
119+
120+
```yaml
121+
Type: SwitchParameter
122+
Parameter Sets: (All)
123+
Aliases: wi
124+
125+
Required: False
126+
Position: Named
127+
Default value: None
128+
Accept pipeline input: False
129+
Accept wildcard characters: False
130+
```
131+
132+
### CommonParameters
133+
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).
134+
135+
## INPUTS
136+
137+
### None
138+
139+
## OUTPUTS
140+
141+
### System.Object
142+
## NOTES
143+
144+
## RELATED LINKS
145+
146+
[Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md)
147+
148+
[Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md)
149+
150+
[Get-SPOTenant](Get-SPOTenant.md)
151+
152+
[SharePoint Advanced Management](/sharepoint/sharepoint-advanced-management-licensing)

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

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
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+
Stops further processing of tenant apply file version policy job that is in progress. SharePoint Advanced Management license is required to run this cmdlet.
19+
20+
> [!NOTE]
21+
> This feature is currently in preview and may not be available in your tenant.
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+
> [!NOTE]
34+
> - 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.
35+
> - 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.
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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
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)
96+
97+
[SharePoint Advanced Management](/sharepoint/sharepoint-advanced-management-licensing)

0 commit comments

Comments
 (0)