Skip to content

Latest commit

 

History

History
203 lines (155 loc) · 5.38 KB

Add-PnPFileToSiteTemplate.md

File metadata and controls

203 lines (155 loc) · 5.38 KB
Module Name schema applicable online version external help file title
PnP.PowerShell
2.0.0
SharePoint Online
PnP.PowerShell.dll-Help.xml
Add-PnPFileToSiteTemplate

Add-PnPFileToSiteTemplate

SYNOPSIS

Adds a file to a PnP Provisioning Template package

SYNTAX

Local File

Add-PnPFileToSiteTemplate [-Path] <String> [-Source] <String> [-Folder] <String>
 [[-Container] <String>] [[-FileLevel] <FileLevel>] [-FileOverwrite]
 [[-TemplateProviderExtensions] <ITemplateProviderExtension[]>] 
 [-Connection <PnPConnection>]

Remove File

Add-PnPFileToSiteTemplate [-Path] <String> [-SourceUrl] <String> [[-Container] <String>]
 [[-FileLevel] <FileLevel>] [-FileOverwrite] [[-TemplateProviderExtensions] <ITemplateProviderExtension[]>]
 [-Connection <PnPConnection>]

DESCRIPTION

Allows adding a file to a PnP Provisioning Template package (.pnp) so that the file will get uploaded to the SharePoint Online site to which the template is being invoked. This allows the file to be referenced in i.e. a document template, site logo or any other component that references a file.

EXAMPLES

EXAMPLE 1

Add-PnPFileToSiteTemplate -Path template.pnp -Source "Instructions.docx" -Folder "Shared Documents"

Embeds a file named "Instructions.docx" located in the current folder on the local machine into the PnP Site Template file "template.pnp" located in the current folder on the local machine, instructing it to be uploaded to the default document library when the template is applied to a site.

EXAMPLE 2

Add-PnPFileToSiteTemplate -Path c:\temp\template.pnp -Source "c:\temp\Sample.pptx" -Folder "Shared Documents\Samples"

Embeds a file named "Sample.pptx" located in the c:\temp on the local machine into the PnP Site Template file located at "c:\temp\template.pnp" on the local machine, instructing it to be uploaded to the folder Samples located in the default document library when the template is applied to a site.

EXAMPLE 3

Add-PnPFileToSiteTemplate -Path template.pnp -Source "./myfile.png" -Folder "folderinsite" -FileLevel Published -FileOverwrite:$false

Adds a file to a PnP Site Template, specifies the level as Published and defines to not overwrite the file if it exists in the site.

EXAMPLE 4

Add-PnPFileToSiteTemplate -Path template.pnp -Source $sourceFilePath -Folder $targetFolder -Container $container

Adds a file to a PnP Site Template with a custom container for the file

EXAMPLE 5

Add-PnPFileToSiteTemplate -Path template.pnp -SourceUrl "Shared%20Documents/ProjectStatus.docx"

Adds a file to a PnP Provisioning Template retrieved from the currently connected site. The url can be server relative or web relative. If specifying a server relative url has to start with the current site url.

PARAMETERS

-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

-Container

The target Container for the file to add to the in-memory template, optional argument.

Type: String
Parameter Sets: (All)

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FileLevel

The level of the files to add, defaults to Published.

Type: FileLevel
Parameter Sets: (All)

Required: False
Position: 4
Default value: Published
Accept pipeline input: False
Accept wildcard characters: False

-FileOverwrite

Set to overwrite in site, defaults to true.

Type: SwitchParameter
Parameter Sets: (All)

Required: False
Position: 5
Default value: $true
Accept pipeline input: False
Accept wildcard characters: False

-Folder

The target Folder for the file to add to the in-memory template.

Type: String
Parameter Sets: Local File

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Path

Filename of the .PNP Open XML site template to read from, optionally including full path.

Type: String
Parameter Sets: (All)

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Source

The file to add to the PnP Provisioning Template, optionally including full path.

Type: String
Parameter Sets: Local File

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SourceUrl

The file to add to the PnP Provisioning Template, specifying its url in the current connected Web.

Type: String
Parameter Sets: Remove File

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TemplateProviderExtensions

Allows you to specify ITemplateProviderExtension to execute while loading the template.

Type: ITemplateProviderExtension[]
Parameter Sets: (All)

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

RELATED LINKS

Microsoft 365 Patterns and Practices