GetPnPFile.md

#Get-PnPFile Downloads a file. ##Syntax

Get-PnPFile [-Web <WebPipeBind>]
            -Url <String>

Get-PnPFile [-AsListItem [<SwitchParameter>]]
            [-Web <WebPipeBind>]
            -Url <String>

Get-PnPFile [-AsString [<SwitchParameter>]]
            [-Web <WebPipeBind>]
            -Url <String>

Get-PnPFile [-Path <String>]
            [-Filename <String>]
            -AsFile [<SwitchParameter>]
            [-Web <WebPipeBind>]
            -Url <String>

##Returns

Microsoft.SharePoint.Client.File

##Parameters

Parameter	Type	Required	Description
AsFile	SwitchParameter	True
AsListItem	SwitchParameter	False
AsString	SwitchParameter	False	Retrieve the file contents as a string
Filename	String	False	Name for the local file
Path	String	False	Local path where the file should be saved
Url	String	True	The URL (server or site relative) to the file
Web	WebPipeBind	False	The web to apply the command to. Omit this parameter to use the current web.
##Examples

###Example 1

PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor

Retrieves the file and downloads it to the current folder

###Example 2

PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -Path c:\temp -FileName company.spcolor

Retrieves the file and downloads it to c:\temp\company.spcolor

###Example 3

PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsString

Retrieves the file and outputs its contents to the console

###Example 4

PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsFile

Retrieves the file and returns it as a File object

###Example 5

PS:> Get-PnPFile -Url /sites/project/_catalogs/themes/15/company.spcolor -AsListItem

Retrieves the file and returns it as a ListItem object

###Example 6

PS:> Get-PnPFile -Url _catalogs/themes/15/company.spcolor -Path c:\temp -FileName company.spcolor

Retrieves the file by site relative URL and downloads it to c:\temp\company.spcolor