Set-PnPSiteVersionPolicy
SYNOPSIS
Sets file version policy related properties on the site.
Required Permissions
| Type | API/ Permission Name | Admin consent required |
|---|---|---|
| Delegated | AllSites.FullControl | yes |
SYNTAX
Set-PnPSiteVersionPolicy
[-EnableAutoExpirationVersionTrim <Boolean>]
[-ExpireVersionsAfterDays <UInt32>]
[-MajorVersions <UInt32>]
[-MajorWithMinorVersions <UInt32>]
[-InheritFromTenant]
[-ApplyToNewDocumentLibraries]
[-ApplyToExistingDocumentLibraries]
[-CancelForExistingDocumentLibraries]
[-Connection <PnPConnection>]
DESCRIPTION
Configures the versioning policy for a SharePoint Online site collection.
EXAMPLES
EXAMPLE 1
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $true
This example sets AutoExpiration file version trim mode for a site. The new document libraries will use this version setting. Also creates a request to set the file version trim mode as AutoExpiration for existing document libraries that enabled versioning.
EXAMPLE 2
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MajorWithMinorVersions 10 -ExpireVersionsAfterDays 200
This example sets ExpireAfter file version trim mode for a site. The new document libraries will use this version setting. Also creates a request to set the file version trim mode as ExpireAfter for existing document libraries that enabled versioning.
EXAMPLE 3
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 300 -MajorWithMinorVersions 20 -ExpireVersionsAfterDays 0
Example 3 sets NoExpiration file version trim mode for a site. The new document libraries will use this version setting. Also creates a request to set the file version trim mode as NoExpiration for existing document libraries that enabled versioning.
EXAMPLE 4
Set-PnPSiteVersionPolicy -InheritFromTenant
Example 4 clears the file version setting on a site. The new document libraries will use the tenant level setting.
EXAMPLE 5
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $true -ApplyToNewDocumentLibraries
This example sets AutoExpiration file version trim mode for a site. The new document libraries will use this version setting.
EXAMPLE 6
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -ExpireVersionsAfterDays 200 -ApplyToNewDocumentLibraries
This example sets ExpireAfter file version trim mode for a site. The new document libraries will use this version setting.
EXAMPLE 7
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 300 -ExpireVersionsAfterDays 0 -ApplyToNewDocumentLibraries
Example 7 sets NoExpiration file version trim mode for a site. The new document libraries will use this version setting.
EXAMPLE 8
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $true -ApplyToExistingDocumentLibraries
Example 8 creates a request to set the file version trim mode as AutoExpiration for existing document libraries that enabled versioning.
EXAMPLE 9
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MajorWithMinorVersions 5 -ExpireVersionsAfterDays 200 -ApplyToExistingDocumentLibraries
This example creates a request to set the file version trim mode as ExpireAfter for existing document libraries that enabled versioning.
EXAMPLE 10
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MajorWithMinorVersions 5 -ExpireVersionsAfterDays 0 -ApplyToExistingDocumentLibraries
Example 10 creates a request to set the file version trim mode as NoExpiration for existing document libraries that enabled versioning.
EXAMPLE 11
Set-PnPSiteVersionPolicy -CancelForExistingDocumentLibraries
This example cancels the existing request which sets the file version trim mode for existing document libraries on a site.
PARAMETERS
-ApplyToNewDocumentLibraries
Sets site version policy for new document libraries. Works with parameters EnableAutoExpirationVersionTrim, ExpireVersionsAfterDays, MajorVersions and MajorWithMinorVersions.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ApplyToExistingDocumentLibraries
Creates a request to set the file version trim mode for existing document libraries that enabled versioning. Works with parameters EnableAutoExpirationVersionTrim, ExpireVersionsAfterDays, MajorVersions and MajorWithMinorVersions.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CancelForExistingDocumentLibraries
Cancels the existing request which sets the file version trim mode for existing document libraries on a site.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableAutoExpirationVersionTrim
Enables or disables AutoExpiration version trim for the document libraries on the site. Set to $true to enable, $false to disable.
Parameter ExpireVersionsAfterDays is required when EnableAutoExpirationVersionTrim is false. Set it to 0 for NoExpiration, set it to greater or equal to 30 for ExpireAfter.
Parameter MajorVersions is required when EnableAutoExpirationVersionTrim is false.
Parameter MajorWithMinorVersions is required when EnableAutoExpirationVersionTrim is false and the setting is for document libraries that including existing ones. It is used when minor version is enabled on the document libraries.
Type: Boolean
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpireVersionsAfterDays
Expires the version after the days. Works with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
Type: UInt32
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InheritFromTenant
Clears the file version setting on a site. The new document libraries will use the tenant level setting.
Type: SwitchParameter
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MajorVersions
Maximum major versions to keep. Works with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
Type: UInt32
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MajorWithMinorVersions
Maximum major versions for which to keep minor versions. Works with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
Type: UInt32
Parameter Sets: Set Properties
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False