Share via

Remove-SPOTenantApplyFileVersionPolicyJob

Module:
Microsoft.Online.SharePoint.PowerShell Module

Stops further processing of tenant apply file version policy job that is in progress. SharePoint Advanced Management license or Copilot license is required to run this cmdlet.

Note

This feature is currently in preview and may not be available in your tenant.

Syntax

Default (Default) 

Remove-SPOTenantApplyFileVersionPolicyJob
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Stops further processing of tenant apply file version policy job that is in progress.

Note

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

Examples

Example 1

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.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object