Apply-PnPProvisioningTemplate

Applies a provisioning template to a web

Syntax

Apply-PnPProvisioningTemplate
     [-InputInstance <ProvisioningTemplate>]
                                  [-ResourceFolder <String>]
                                  [-OverwriteSystemPropertyBagValues [<SwitchParameter>]]
                                  [-IgnoreDuplicateDataRowErrors [<SwitchParameter>]]
                                  [-ProvisionContentTypesToSubWebs [<SwitchParameter>]]
                                  [-ProvisionFieldsToSubWebs [<SwitchParameter>]]
                                  [-ClearNavigation [<SwitchParameter>]]
                                  [-Parameters <Hashtable>]
                                  [-Handlers <Handlers>]
                                  [-ExcludeHandlers <Handlers>]
                                  [-ExtensibilityHandlers <ExtensibilityHandler[]>]
                                  [-TemplateProviderExtensions <ITemplateProviderExtension[]>]
                                  [-Web <WebPipeBind>]
                                  [-Connection <SPOnlineConnection>]
Apply-PnPProvisioningTemplate
     [-GalleryTemplateId <Guid>]
                                  [-ResourceFolder <String>]
                                  [-OverwriteSystemPropertyBagValues [<SwitchParameter>]]
                                  [-IgnoreDuplicateDataRowErrors [<SwitchParameter>]]
                                  [-ProvisionContentTypesToSubWebs [<SwitchParameter>]]
                                  [-ProvisionFieldsToSubWebs [<SwitchParameter>]]
                                  [-ClearNavigation [<SwitchParameter>]]
                                  [-Parameters <Hashtable>]
                                  [-Handlers <Handlers>]
                                  [-ExcludeHandlers <Handlers>]
                                  [-ExtensibilityHandlers <ExtensibilityHandler[]>]
                                  [-TemplateProviderExtensions <ITemplateProviderExtension[]>]
                                  [-Web <WebPipeBind>]
                                  [-Connection <SPOnlineConnection>]
Apply-PnPProvisioningTemplate
     -Path <String>
                                  [-ResourceFolder <String>]
                                  [-OverwriteSystemPropertyBagValues [<SwitchParameter>]]
                                  [-IgnoreDuplicateDataRowErrors [<SwitchParameter>]]
                                  [-ProvisionContentTypesToSubWebs [<SwitchParameter>]]
                                  [-ProvisionFieldsToSubWebs [<SwitchParameter>]]
                                  [-ClearNavigation [<SwitchParameter>]]
                                  [-Parameters <Hashtable>]
                                  [-Handlers <Handlers>]
                                  [-ExcludeHandlers <Handlers>]
                                  [-ExtensibilityHandlers <ExtensibilityHandler[]>]
                                  [-TemplateProviderExtensions <ITemplateProviderExtension[]>]
                                  [-Web <WebPipeBind>]
                                  [-Connection <SPOnlineConnection>]

Examples

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

Apply-PnPProvisioningTemplate -Path template.xml

Applies a provisioning template in XML format to the current web.

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

Apply-PnPProvisioningTemplate -Path template.xml -ResourceFolder c:\provisioning\resources

Applies a provisioning template in XML format to the current web. Any resources like files that are referenced in the template will be retrieved from the folder as specified with the ResourceFolder parameter.

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

Apply-PnPProvisioningTemplate -Path template.xml -Parameters @{"ListTitle"="Projects";"parameter2"="a second value"}

Applies a provisioning template in XML format to the current web. It will populate the parameter in the template the values as specified and in the template you can refer to those values with the {parameter:} token.

For instance with the example above, specifying {parameter:ListTitle} in your template will translate to 'Projects' when applying the template. These tokens can be used in most string values in a template.

------------------EXAMPLE 4------------------

Apply-PnPProvisioningTemplate -Path template.xml -Handlers Lists, SiteSecurity

Applies a provisioning template in XML format to the current web. It will only apply the lists and site security part of the template.

------------------EXAMPLE 5------------------

Apply-PnPProvisioningTemplate -Path template.pnp

Applies a provisioning template from a pnp package to the current web.

------------------EXAMPLE 6------------------

Apply-PnPProvisioningTemplate -Path https://tenant.sharepoint.com/sites/templatestorage/Documents/template.pnp

Applies a provisioning template from a pnp package stored in a library to the current web.

------------------EXAMPLE 7------------------

$handler1 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1
$handler2 = New-PnPExtensibilityHandlerObject -Assembly Contoso.Core.Handlers -Type Contoso.Core.Handlers.MyExtensibilityHandler1
Apply-PnPProvisioningTemplate -Path NewTemplate.xml -ExtensibilityHandlers $handler1,$handler2

This will create two new ExtensibilityHandler objects that are run while provisioning the template

------------------EXAMPLE 8------------------

Apply-PnPProvisioningTemplate -Path .\ -InputInstance $template

Applies a provisioning template from an in-memory instance of a ProvisioningTemplate type of the PnP Core Component, reading the supporting files, if any, from the current (.) path. The syntax can be used together with any other supported parameters.

Required Parameters

-Path

Path to the xml or pnp file containing the provisioning template.

Type:String
Position:0
Accept pipeline input:True
Accept wildcard characters:False

Optional Parameters

-ClearNavigation

Override the RemoveExistingNodes attribute in the Navigation elements of the template. If you specify this value the navigation nodes will always be removed before adding the nodes in the template

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-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:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-ExcludeHandlers

Allows you to run all handlers, excluding the ones specified.

Type:Handlers
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-ExtensibilityHandlers

Allows you to specify ExtensbilityHandlers to execute while applying a template

Type:ExtensibilityHandler[]
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-GalleryTemplateId
Type:Guid
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Handlers

Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying.

Type:Handlers
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-IgnoreDuplicateDataRowErrors

Ignore duplicate data row errors when the data row in the template already exists.

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-InputInstance

Allows you to provide an in-memory instance of the ProvisioningTemplate type of the PnP Core Component. When using this parameter, the -Path parameter refers to the path of any supporting file for the template.

Type:ProvisioningTemplate
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-OverwriteSystemPropertyBagValues

Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.)

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Parameters

Allows you to specify parameters that can be referred to in the template by means of the {parameter:<Key>} token. See examples on how to use this parameter.

Type:Hashtable
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-ProvisionContentTypesToSubWebs

If set content types will be provisioned if the target web is a subweb.

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-ProvisionFieldsToSubWebs

If set fields will be provisioned if the target web is a subweb.

Type:SwitchParameter
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-ResourceFolder

Root folder where resources/files that are being referenced in the template are located. If not specified the same folder as where the provisioning template is located will be used.

Type:String
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-TemplateProviderExtensions

Allows you to specify ITemplateProviderExtension to execute while applying a template.

Type:ITemplateProviderExtension[]
Position:Named
Accept pipeline input:False
Accept wildcard characters: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
Position:Named
Accept pipeline input:False
Accept wildcard characters:False