Table of Contents

Set-PnPFileVersion

SYNOPSIS

Keeps the file version with option to set an expiry date.

Syntax

Set-PnPFileVersion [-List] <ListPipeBind> [-Identity] <ListItemPipeBind> [-Version] <ListItemVersionPipeBind> [[-ExpirationDate] <DateTime>] [-Connection <PnPConnection>] [<CommonParameters>]

DESCRIPTION

This cmdlet keeps the file version with option to set an expiry date.

Examples

Example 1

Set-PnPFileVersion -List "Documents" -Identity 1 -Version "1.0" -ExpirationDate "2025-12-31"

Sets the expiration date for version 1.0 of list item with ID 1 in the Documents library to December 31, 2025.

Example 2

Set-PnPFileVersion -List "Documents" -Identity 1 -Version "1.0" -ExpirationDate $null

Clears the expiration date for version 1.0 of list item with ID 1 in the Documents library, setting the version to Never expires.

Parameters

-List

The library to retrieve the file from.

Type: ListPipeBind
Parameter Sets: (All)

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

-Identity

The ID of the file to update.

Type: ListItemPipeBind
Parameter Sets: (All)

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

-Version

The version of the file to modify. This can be specified by version label (e.g. "1.0") or version ID.

Type: ListItemVersionPipeBind
Parameter Sets: (All)

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

-ExpirationDate

The new expiration date for the version. If not specified, the expiration date will be cleared.

Type: DateTime
Parameter Sets: (All)

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

Outputs

This cmdlet does not produce any output.

Microsoft 365 Patterns and Practices