Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
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.

## 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).

## INPUTS

### None

## OUTPUTS

### System.Object
## NOTES

## RELATED LINKS

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

[Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md)
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,9 @@ Get the structural navigation caching state for a web.
### [Get-SPOTenant](Get-SPOTenant.md)
Returns SharePoint Online organization properties.

### [Get-SPOTenantApplyFileVersionPolicyJobProgress](Get-SPOTenantApplyFileVersionPolicyJobProgress.md)
Gets the status for a tenant apply file version policy job.

### [Get-SPOTenantCdnEnabled](Get-SPOTenantCdnEnabled.md)
Returns whether Public content delivery network (CDN) or Private CDN is enabled on the tenant level. Requires Tenant administrator permissions.

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

### [New-SPOTenantApplyFileVersionPolicyJob](New-SPOTenantApplyFileVersionPolicyJob.md)
Queues a job to apply the tenant-level file version policy across all sites.

### [Register-SPODataEncryptionPolicy](Register-SPODataEncryptionPolicy.md)
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)

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

### [Remove-SPOTenantApplyFileVersionPolicyJob](Remove-SPOTenantApplyFileVersionPolicyJob.md)
Stops further processing of tenant apply file version policy job that is in-progress.

### [Remove-SPOTenantCdnOrigin](Remove-SPOTenantCdnOrigin.md)
Removes a new origin from the Public or Private content delivery network (CDN). Requires Tenant administrator permissions.

Expand Down
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>]
```

## 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.

The following site types are excluded from processing:

- Read-only sites

- Locked sites

- Archived sites

- Sites with version policy broken inheritance

Caution:
- 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)
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.

## SYNTAX

```
Remove-SPOTenantApplyFileVersionPolicyJob [-WhatIf] [-Confirm] [<CommonParameters>]
Copy link
Contributor Author

Choose a reason for hiding this comment

The 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)