Set-PnPListItemAsRecord

Declares a list item as a record

Syntax

Set-PnPListItemAsRecord
   -List <ListPipeBind>
                          -Identity <ListItemPipeBind>
                          [-DeclarationDate <DateTime>]
                          [-Web <WebPipeBind>]
                          [-Connection <SPOnlineConnection>]

Examples

------------------EXAMPLE 1------------------

Set-PnPListItemAsRecord -List "Documents" -Identity 4

Declares the document in the documents library with id 4 as a record

------------------EXAMPLE 2------------------

Set-PnPListItemAsRecord -List "Documents" -Identity 4 -DeclarationDate $date

Declares the document in the documents library with id as a record

Required Parameters

-Identity

The ID of the listitem, or actual ListItem object

Type:ListItemPipeBind
Position:Named
Accept pipeline input:True
Accept wildcard characters:False
-List

The ID, Title or Url of the list.

Type:ListPipeBind
Position:0
Accept pipeline input:True
Accept wildcard characters:False

Optional Parameters

-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:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-DeclarationDate

The declaration date

Type:DateTime
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type:WebPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False