Remove-SPOContainerTenantApplyFileVersionPolicyJob

Module:
Microsoft.Online.SharePoint.PowerShell Module

Stops further processing of an apply file version policy job that is in progress for a SharePoint Embedded (SPE) container type. 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-SPOContainerTenantApplyFileVersionPolicyJob
    -ContainerTypeId <Guid>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Stops further processing of an apply file version policy job that is in progress for the specified SharePoint Embedded (SPE) container type.

Note

  • If the job was queued by using New-SPOContainerTenantApplyFileVersionPolicyJob with the TrimVersions parameter, this stops creating new sub-jobs that trim versions for containers. This does not affect versions that were already permanently deleted while the job was running.
  • If the job was queued by using New-SPOContainerTenantApplyFileVersionPolicyJob with the SetVersionPolicy parameter, this stops creating new sub-jobs that apply the new version policy to existing containers. The version policies that were already applied remain in place and will not be reverted.

Examples

Example 1

Remove-SPOContainerTenantApplyFileVersionPolicyJob -ContainerTypeId <ContainerTypeId>

Example 1 cancels further processing of the apply file version policy job for the specified container type.

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

-ContainerTypeId

The ID of the SharePoint Embedded container type whose job is canceled.

Parameter properties

Type:Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
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