Skip to content

Latest commit

 

History

History
130 lines (96 loc) · 2.73 KB

Remove-PnPFile.md

File metadata and controls

130 lines (96 loc) · 2.73 KB
external help file applicable schema
SharePoint Server 2013, SharePoint Server 2016, SharePoint Online
2.0.0

Remove-PnPFile

SYNOPSIS

Removes a file.

SYNTAX

Server Relative

Remove-PnPFile -ServerRelativeUrl <String>
               [-Recycle [<SwitchParameter>]]
               [-Force [<SwitchParameter>]]
               [-Web <WebPipeBind>]
               [-Connection <SPOnlineConnection>]

Site Relative

Remove-PnPFile -SiteRelativeUrl <String>
               [-Recycle [<SwitchParameter>]]
               [-Force [<SwitchParameter>]]
               [-Web <WebPipeBind>]
               [-Connection <SPOnlineConnection>]

EXAMPLES

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

PS:>Remove-PnPFile -ServerRelativeUrl /sites/project/_catalogs/themes/15/company.spcolor

Removes the file company.spcolor

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

PS:>Remove-PnPFile -SiteRelativeUrl _catalogs/themes/15/company.spcolor

Removes the file company.spcolor

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

PS:>Remove-PnPFile -SiteRelativeUrl _catalogs/themes/15/company.spcolor -Recycle

Removes the file company.spcolor and saves it to the Recycle Bin

PARAMETERS

-Force

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-Recycle

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: Named
Accept pipeline input: False

-ServerRelativeUrl

Server relative URL to the file

Type: String
Parameter Sets: Server Relative

Required: True
Position: 0
Accept pipeline input: True

-SiteRelativeUrl

Site relative URL to the file

Type: String
Parameter Sets: Site Relative

Required: True
Position: 0
Accept pipeline input: True

-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