Set-PnPList
SYNOPSIS
Updates list settings.
SYNTAX
Set-PnPList -Identity <ListPipeBind> [-EnableContentTypes <Boolean>] [-BreakRoleInheritance]
[-ResetRoleInheritance] [-CopyRoleAssignments] [-ClearSubScopes] [-Title <String>] [-Description <String>]
[-Hidden <Boolean>] [-AllowDeletion <Boolean>] [-ForceCheckout <Boolean>] [-ListExperience <ListExperience>]
[-EnableAttachments <Boolean>] [-EnableFolderCreation <Boolean>] [-EnableVersioning <Boolean>]
[-EnableMinorVersions <Boolean>] [-MajorVersions <UInt32>] [-MinorVersions <UInt32>]
[-EnableModeration <Boolean>] [-DraftVersionVisibility <DraftVisibilityType>] [-ReadSecurity <ListReadSecurity>] [-WriteSecurity <ListWriteSecurity>]
[-NoCrawl] [-ExemptFromBlockDownloadOfNonViewableFiles <Boolean>] [-DisableGridEditing <Boolean>] [-DisableCommenting <Boolean>]
[-EnableAutoExpirationVersionTrim <Boolean>] [-ExpireVersionsAfterDays <UInt32>]
[-DefaultSensitivityLabelForLibrary <SensitivityLabelPipeBind>] [-Path <String>] [-OpenDocumentsMode <DocumentLibraryOpenDocumentsInMode>] [-Color <ListColor>] [-Icon <ListIcon>] [-Connection <PnPConnection>]
DESCRIPTION
Allows the configuration of a specific SharePoint Online list to be set.
EXAMPLES
EXAMPLE 1
Set-PnPList -Identity "Demo List" -EnableContentTypes $true
Switches the Enable Content Type switch on the list.
EXAMPLE 2
Set-PnPList -Identity "Demo List" -Hidden $true
Hides the list from the SharePoint UI.
EXAMPLE 3
Set-PnPList -Identity "Demo List" -EnableVersioning $true
Turns on major versions on a list.
EXAMPLE 4
Set-PnPList -Identity "Demo List" -EnableVersioning $true -MajorVersions 20
Turns on major versions on a list and sets the maximum number of major versions to keep at 20.
EXAMPLE 5
Set-PnPList -Identity "Demo Library" -EnableVersioning $true -EnableMinorVersions $true -MajorVersions 20 -MinorVersions 5
Turns on major versions on a document library, sets the maximum number of major versions to keep at 20, and sets the maximum number of minor versions to 5.
EXAMPLE 6
Set-PnPList -Identity "Demo List" -EnableAttachments $true
Turns on attachments for a list.
EXAMPLE 7
Set-PnPList -Identity "Demo List" -Title "Demo List 2" -Path "Lists/DemoList2"
Renames a list, including its URL.
EXAMPLE 8
Set-PnPList -Identity "Demo List" -EnableAutoExpirationVersionTrim $true
Enables AutoExpiration file version trim mode on a document library.
EXAMPLE 9
Set-PnPList -Identity "Demo List" -EnableAutoExpirationVersionTrim $false -ExpireVersionsAfterDays 30 -MajorVersions 500
Enables ExpireAfter file version trim mode on a document library. MinorVersions parameter is also needed when minor version is enabled.
EXAMPLE 10
Set-PnPList -Identity "Demo List" -EnableAutoExpirationVersionTrim $false -ExpireVersionsAfterDays 0 -MajorVersions 500
Enables NoExpiration file version trim mode on a document library. MinorVersions parameter is also needed when minor version is enabled.
EXAMPLE 11
Set-PnPList -Identity "Demo List" -DefaultSensitivityLabelForLibrary "Confidential"
Sets the default sensitivity label for a document library to Confidential.
EXAMPLE 12
Set-PnPList -Identity "Demo List" -Color Green -Icon "Plane"
Changes the icon of the list to a plane, and the background color of the icon to green.
PARAMETERS
-BreakRoleInheritance
If used, the security inheritance is broken for this list from its parent, the web in which it resides. Permissions can be added using Set-PnPListPermission.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ResetRoleInheritance
If used, the security inheritance is reset for this list, meaning it will not copy the permissions from its parent but will start with an empty list of permissions. Permissions can be added using Set-PnPListPermission.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ClearSubScopes
If used, the unique permissions are cleared from child objects and they can inherit role assignments from this object.
Type: SwitchParameter
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
-CopyRoleAssignments
If used, the role assignments are copied from the parent web.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Description
The description of the list.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DefaultSensitivityLabelForLibrary
The instance, Id or name of the sensitivity label to set as the default for the library. If $null is provided, the default label will be removed.
Type: SensitivityLabelPipeBind
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableAttachments
Enable or disable attachments. Set to $true to enable, $false to disable.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableContentTypes
Set to $true to enable content types, set to $false to disable content types.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableFolderCreation
Enable or disable folder creation. Set to $true to enable, $false to disable.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableMinorVersions
Enable or disable minor versions versioning. Set to $true to enable, $false to disable.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableModeration
Enable or disable whether content approval is enabled for the list. Set to $true to enable, $false to disable.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DraftVersionVisibility
Specify which users should be able to view drafts in this list.
Type: DraftVisibilityType
Parameter Sets: (All)
Accepted values: Approver, Author, Reader
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableVersioning
Enable or disable versioning. Set to $true to enable, $false to disable.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ForceCheckout
Enable or disable force checkout. Set to $true to enable, $false to disable.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Hidden
Hide the list from the SharePoint UI. Set to $true to hide, $false to show.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AllowDeletion
Allow or prevent deletion of the list from the SharePoint UI. Set to $true to allow, $false to prevent.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identity
The ID, Title or Url of the list.
Type: ListPipeBind
Parameter Sets: (All)
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ListExperience
Set the list experience: Auto, NewExperience or ClassicExperience
Type: ListExperience
Parameter Sets: (All)
Accepted values: Auto, NewExperience, ClassicExperience
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MajorVersions
Maximum major versions to keep.
Type: UInt32
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MinorVersions
Maximum major versions for which to keep minor versions.
Type: UInt32
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OpenDocumentsMode
Allows configuring the "Opening Documents in the Browser" advanced setting on document libraries. Set to ClientApplication to have documents opened in the locally installed Word, PowerPoint, or Excel client, or set to Browser to have documents opened in the browser. It is not possible to set it to "Use the server default mode".
Type: DocumentLibraryOpenDocumentsInMode
Parameter Sets: (All)
Accepted values: ClientApplication, Browser
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ReadSecurity
Sets the read security for the list.
Type: ListReadSecurity
Parameter Sets: (All)
Accepted values: AllUsersReadAccess, AllUsersReadAccessOnItemsTheyCreate
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WriteSecurity
Sets the write security for the list.
Type: ListWriteSecurity
Parameter Sets: (All)
Accepted values: WriteAllItems, WriteOnlyMyItems, WriteNoItems
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Title
The title of the list.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NoCrawl
Switch parameter to specify whether this list should be excluded from search indexing.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExemptFromBlockDownloadOfNonViewableFiles
Allows to configure access capabilities for un-managed devices for the list. If set to $true, the list will be accessible by un-managed devices as well. For more information, see SharePoint and OneDrive un-managed device access controls for administrators.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisableGridEditing
Enable or disable whether edit grid editing is enabled for the list. Set to $true to disable, $false to enable.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-DisableCommenting
Enable or disable whether commenting is enabled for the list. Set to $true to disable, $false to enable.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Path
The new URL path of the list. The parent folder must exist and be in the same site/web. I.e. lists\newname.
Type: String
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableAutoExpirationVersionTrim
Enable or disable AutoExpiration version trim for the document library. Set to $true to enable, $false to disable.
Parameter ExpireVersionsAfterDays is required when EnableAutoExpirationVersionTrim is false. Set ExpireVersionsAfterDays to 0 for NoExpiration, set it to greater or equal 30 for ExpireAfter.
Parameter MajorVersions is required when EnableAutoExpirationVersionTrim is false. Parameter MinorVersions is required when EnableAutoExpirationVersionTrim is false and minor version is enabled.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpireVersionsAfterDays
Works with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
Type: UInt32
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableClassicAudienceTargeting
Enable classic audience targeting in a SharePoint list.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-EnableModernAudienceTargeting
Enable modern audience targeting in a SharePoint list. Please make sure the following feature ModernAudienceTargeting with ID "bc13eaf7-67c7-4f85-a80f-a4b0dae5e5bd" is activated first on the site by using Enable-PnPFeature.
Type: Boolean
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Icon
The icon of the list.
Type: ListIcon
Parameter Sets: (All)
Accepted values: Bug, Calendar, Target, Clipboard, Plane, Rocket, ColorPalette, Lightbulb, Cube, Beaker, Robot, PiggyBank, Playlist, Hospital, Bank, MapPin, CoffeCup, ShoppingCart, BirthdayCake
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Color
The background color of the list icon.
Type: ListColor
Parameter Sets: (All)
Accepted values: DarkRed, Red, Orange, Green, DarkGreen, Teal, Blue, NavyBlue, BluePurple, DarkBlue, Lavender , Pink
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False