Search Results for

    Show / Hide Table of Contents

    Set-PnPListItemAsRecord

    SYNOPSIS

    Declares a list item as a record, for more information, see https://learn.microsoft.com/sharepoint/governance/records-management-in-sharepoint-server

    SYNTAX

    Set-PnPListItemAsRecord [-List] <ListPipeBind> -Identity <ListItemPipeBind> [-DeclarationDate <DateTime>]
     [-Connection <PnPConnection>] 
    

    DESCRIPTION

    Allows to set a list item as a record.

    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 4 as a record.

    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: PnPConnection
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -DeclarationDate

    The declaration date.

    Type: DateTime
    Parameter Sets: (All)
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Identity

    The ID of the listitem, or actual ListItem object.

    Type: ListItemPipeBind
    Parameter Sets: (All)
    
    Required: True
    Position: Named
    Default value: None
    Accept pipeline input: True (ByValue)
    Accept wildcard characters: False
    

    -List

    The ID, Title or Url of the list.

    Type: ListPipeBind
    Parameter Sets: (All)
    
    Required: True
    Position: 0
    Default value: None
    Accept pipeline input: True (ByValue)
    Accept wildcard characters: False
    

    RELATED LINKS

    Microsoft 365 Patterns and Practices

    Back to top Generated by DocFX spacer