Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
3df3d17
Learn Editor: Update Set-SPOTenant.md
blarrywangmsft Aug 12, 2025
2e51f13
Learn Editor: Update Set-SPOSite.md
blarrywangmsft Aug 12, 2025
5604501
Learn Editor: Update Set-SPOListVersionPolicy.md
blarrywangmsft Aug 12, 2025
f92add7
Learn Editor: Update New-SPOListFileVersionBatchDeleteJob.md
blarrywangmsft Aug 12, 2025
0cb3db8
Add new cmdlet templates.
Aug 12, 2025
a5c0fe6
Learn Editor: Update New-SPOSiteManageVersionPolicyJob.md
blarrywangmsft Aug 12, 2025
247cdf8
Learn Editor: Update Get-SPOSiteManageVersionPolicyJobProgress.md
blarrywangmsft Aug 12, 2025
f78c775
Learn Editor: Update Remove-SPOSiteManageVersionPolicyJob.md
blarrywangmsft Aug 12, 2025
76103d0
Learn Editor: Update New-SPOSiteManageVersionPolicyJob.md
blarrywangmsft Aug 12, 2025
a968dec
Learn Editor: Update New-SPOListFileVersionBatchDeleteJob.md
blarrywangmsft Aug 12, 2025
a1b170e
Add table of content.
Aug 12, 2025
5261728
Learn Editor: Update Get-SPOSiteManageVersionPolicyJobProgress.md
blarrywangmsft Aug 12, 2025
d9d7004
Fix spacing.
Aug 12, 2025
d0ba448
Learn Editor: Update New-SPOSiteManageVersionPolicyJob.md
blarrywangmsft Aug 12, 2025
9d98113
Learn Editor: Update New-SPOSiteManageVersionPolicyJob.md
blarrywangmsft Aug 12, 2025
73f3df8
Learn Editor: Update New-SPOListFileVersionBatchDeleteJob.md
blarrywangmsft Aug 12, 2025
f47f050
Learn Editor: Update New-SPOSiteManageVersionPolicyJob.md
blarrywangmsft Aug 13, 2025
9311a71
Learn Editor: Update Remove-SPOSiteManageVersionPolicyJob.md
blarrywangmsft Aug 13, 2025
78e2d95
Learn Editor: Update Set-SPOTenant.md
blarrywangmsft Aug 13, 2025
05120fa
Learn Editor: Update Set-SPOTenant.md
blarrywangmsft Aug 13, 2025
350a8f0
Learn Editor: Update Set-SPOSite.md
blarrywangmsft Aug 13, 2025
de9c9fb
Learn Editor: Update Set-SPOSite.md
blarrywangmsft Aug 13, 2025
6e83ced
Learn Editor: Update Set-SPOListVersionPolicy.md
blarrywangmsft Aug 13, 2025
c503692
Add metadata.
Aug 14, 2025
a80a1a2
Address comments.
Aug 14, 2025
39f7be1
Merge branch 'docs-editor/Set-SPOTenant-1755022729' of https://github…
Aug 14, 2025
6ee3089
Merge branch 'main' into docs-editor/Set-SPOTenant-1755022729
blarrywangmsft Aug 14, 2025
168b839
Update bookmarks.
Aug 14, 2025
ccbeb9d
Merge branch 'docs-editor/Set-SPOTenant-1755022729' of https://github…
Aug 14, 2025
d6775e2
Fix spacing.
Aug 14, 2025
98c7648
Address comments.
Aug 15, 2025
517204c
Fix more whitespaces etc.
Aug 15, 2025
bbbd665
Reduce the number of examples.
Aug 15, 2025
a092256
Add notes for preview.
Aug 15, 2025
f2ba103
Merge pull request #985 from blarrywangmsft/docs-editor/Set-SPOTenant…
garycentric Aug 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .openpublishing.redirection.ms-ol-sp-ps.json
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,11 @@
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spositegroup",
"redirect_document_id": true
},
{
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteManageVersionPolicyJobProgress.md",
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spositemanageversionpolicyjobprogress",
"redirect_document_id": true
},
{
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSitePages.md",
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/get-spositepages",
Expand Down Expand Up @@ -770,6 +775,11 @@
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/new-spositesharingreportjob",
"redirect_document_id": true
},
{
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/New-SPOSiteManageVersionPolicyJob.md",
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/new-spositemanageversionpolicyjob",
"redirect_document_id": true
},
{
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Register-SPODataEncryptionPolicy.md",
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/register-spodataencryptionpolicy",
Expand Down Expand Up @@ -930,6 +940,11 @@
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spositegroup",
"redirect_document_id": true
},
{
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteManageVersionPolicyJob.md",
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spositemanageversionpolicyjob",
"redirect_document_id": true
},
{
"source_path": "sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteScript.md",
"redirect_url": "/powershell/module/microsoft.online.sharepoint.powershell/remove-spositescript",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name: Microsoft.Online.SharePoint.PowerShell
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spositemanageversionpolicyjobprogress
applicable: SharePoint Online
title: Get-SPOSiteManageVersionPolicyJobProgress
schema: 2.0.0
author: blarrywangmsft
ms.author: blarrywang
ms.reviewer:
---

# Get-SPOSiteManageVersionPolicyJobProgress

## SYNOPSIS
Gets the status and progress for a background job started by `New-SPOSiteManageVersionPolicyJob`.
> [!NOTE]
> This feature is currently in preview and may not be available in your tenant.

## SYNTAX

```
Get-SPOSiteManageVersionPolicyJobProgress [-Identity] <SpoSitePipeBind> [<CommonParameters>]
```

## DESCRIPTION
Gets the status and progress for a background job started by `New-SPOSiteManageVersionPolicyJob`.

## EXAMPLES

### Example 1

```
Get-SPOSiteManageVersionPolicyJobProgress https://contoso.sharepoint.com/sites/site1
```

Gets the progress of the site manage version policy job for the given site.

## PARAMETERS

### -Identity

> Applicable: SharePoint Online

Specifies the URL of the site collection.

```yaml
Type: SpoSitePipeBind
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
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

### Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind

## OUTPUTS

### System.Object
## NOTES

## RELATED LINKS

[New-SPOSiteManageVersionPolicyJob](New-SPOSiteManageVersionPolicyJob.md)

[Remove-SPOSiteManageVersionPolicyJob](Remove-SPOSiteManageVersionPolicyJob.md)
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,9 @@ Gets the status for a file version expiration report generation job for a site c
### [Get-SPOSiteGroup](Get-SPOSiteGroup.md)
Gets all the groups on the specified site collection.

### [Get-SPOSiteManageVersionPolicyJobProgress](Get-SPOSiteManageVersionPolicyJobProgress.md)
Gets the status and progress for site manage version policy jobs.

### [Get-SPOSitePages](Get-SPOSitePages.md)
This cmdlet allows you to retrieve all SharePoint pages under a specific SharePoint site.

Expand Down Expand Up @@ -465,6 +468,9 @@ Generates a version storage usage report for a site collection. This report can
### [New-SPOSiteGroup](New-SPOSiteGroup.md)
Creates a new group in a SharePoint Online site collection.

### [New-SPOSiteManageVersionPolicyJob](New-SPOSiteManageVersionPolicyJob.md)
Starts a background job to manage file versions and version history limits for all document libraries in the given site.

### [New-SPOSiteSharingReportJob](New-SPOSiteSharingReportJob.md)
Creates a new sharing report job.

Expand Down Expand Up @@ -567,6 +573,9 @@ Stops further processing of site level trim job that is in-progress.
### [Remove-SPOSiteGroup](Remove-SPOSiteGroup.md)
Removes a SharePoint Online group from a site collection.

### [Remove-SPOSiteManageVersionPolicyJob](Remove-SPOSiteManageVersionPolicyJob.md)
Stops processing of the in-progress manage version policy job for the given site.

### [Remove-SPOSiteScript](Remove-SPOSiteScript.md)
Removes a site script.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ New-SPOListFileVersionBatchDeleteJob [-Site] <SpoSitePipeBind> -List <SPOListPip
-MajorVersionLimit <Int32> -MajorWithMinorVersionsLimit <Int32> [-WhatIf] [-Confirm] [<CommonParameters>]
```

### ByPolicy
```
New-SPOListFileVersionBatchDeleteJob [-Site] <SpoSitePipeBind> -List <SPOListPipeBind> [-FileTypes <String[]>]
[-ExcludeDefaultPolicy] [-TrimUseListPolicy] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION

Queues a job to trim versions from a document library.
Expand Down Expand Up @@ -69,6 +75,30 @@ New-SPOListFileVersionBatchDeleteJob -Site https://contoso.sharepoint.com/sites/

Example 3 starts a trim job that will delete file versions in the document library called "Documents" based on the version count limits.

### EXAMPLE 4

```powershell
New-SPOListFileVersionBatchDeleteJob -Site https://contoso.sharepoint.com/sites/site1 -List "Documents" -TrimUseListPolicy
```

Example 4 starts a trim job that will delete file versions in the document library called "Documents" based on the version history limits of the document library.

### EXAMPLE 5

```powershell
New-SPOListFileVersionBatchDeleteJob -Site https://contoso.sharepoint.com/sites/site1 -List "Documents" -TrimUseListPolicy -FileTypes @("Video", "Audio")
```

Example 5 starts a trim job that will delete file versions for video and audio file types, and file versions that do not belong to a file type override in the document library based on the version history limits of the document library.

### EXAMPLE 6

```powershell
New-SPOListFileVersionBatchDeleteJob -Site https://contoso.sharepoint.com/sites/site1 -List "Documents" -TrimUseListPolicy -FileTypes @("Video", "Audio") -ExcludeDefaultPolicy
```

Example 6 starts a trim job that will delete file versions for video and audio file types in the document library based on the version history limits of the document library.

## PARAMETERS

### -Automatic
Expand Down Expand Up @@ -101,6 +131,45 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ExcludeDefaultPolicy
Indicates whether to trim versions based on the default version history limits.

> [!NOTE]
> This feature is currently in preview and may not be available in your tenant.

```yaml
Type: SwitchParameter
Parameter Sets: ByPolicy
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -FileTypes
An array of file type names to trim versions. The supported file type names are:
- Audio
- OutlookPST
- Video

> [!NOTE]
> This feature is currently in preview and may not be available in your tenant.

```yaml
Type: String[]
Parameter Sets: ByPolicy
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -List

The document library name or Id.
Expand Down Expand Up @@ -180,6 +249,24 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -TrimUseListPolicy
Indicates whether to trim versions by applying the document library's version history limits.

> [!NOTE]
> This feature is currently in preview and may not be available in your tenant.

```yaml
Type: SwitchParameter
Parameter Sets: ByPolicy
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.
Expand Down
Loading
Loading