Skip to content

Latest commit

 

History

History
114 lines (83 loc) · 2.32 KB

Remove-PnPFolder.md

File metadata and controls

114 lines (83 loc) · 2.32 KB
Raw
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Remove-PnPFolder

SYNOPSIS

Deletes a folder within a parent folder

SYNTAX

Remove-PnPFolder -Name <String>
                 -Folder <String>
                 [-Recycle [<SwitchParameter>]]
                 [-Force [<SwitchParameter>]]
                 [-Web <WebPipeBind>]
                 [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:> Remove-PnPFolder -Name NewFolder -Folder _catalogs/masterpage

Removes the folder 'NewFolder' from '_catalogsmasterpage'

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

PS:> Remove-PnPFolder -Name NewFolder -Folder _catalogs/masterpage -Recycle

Removes the folder 'NewFolder' from '_catalogsmasterpage' and is saved in the Recycle Bin

PARAMETERS

-Folder

The parent folder in the site

Type: String
Parameter Sets: (All)

Required: True
Position: Named
Accept pipeline input: False

-Force

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Name

The folder name

Type: String
Parameter Sets: (All)

Required: True
Position: Named
Accept pipeline input: False

-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