Skip to content

Latest commit

 

History

History
108 lines (79 loc) · 2.32 KB

Remove-PnPList.md

File metadata and controls

108 lines (79 loc) · 2.32 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Remove-PnPList

SYNOPSIS

Deletes a list

SYNTAX

Remove-PnPList -Identity <ListPipeBind>
               [-Recycle [<SwitchParameter>]]
               [-Force [<SwitchParameter>]]
               [-Web <WebPipeBind>]
               [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> Remove-PnPList -Identity Announcements

Removes the list named 'Announcements'. Asks for confirmation.

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

PS:> Remove-PnPList -Identity Announcements -Force

Removes the list named 'Announcements' without asking for confirmation.

------------------EXAMPLE 3------------------

PS:> Remove-PnPList -Title Announcements -Recycle

Removes the list named 'Announcements' and saves to the Recycle Bin

PARAMETERS

-Force

Specifying the Force parameter will skip the confirmation question.

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Identity

The ID or Title of the list.

Type: ListPipeBind
Parameter Sets: (All)

Required: True
Position: 0
Accept pipeline input: True

-Recycle

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Connection

Optional connection to be used by cmdlet. Retrieve the value for this parameter by eiter specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type: SPOnlineConnection
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: 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
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

RELATED LINKS

SharePoint Developer Patterns and Practices