Table of Contents

Save-PnPSiteTemplate

SYNOPSIS

Saves a PnP site template to the file system

SYNTAX

Save-PnPSiteTemplate -Template <SiteTemplatePipeBind> [-Out] <String>
 [-Schema <XMLPnPSchemaVersion>] [-Force] [-TemplateProviderExtensions <ITemplateProviderExtension[]>]
 

DESCRIPTION

Allows to save a PnP site template to the file system.

EXAMPLES

EXAMPLE 1

Save-PnPSiteTemplate -Template .\template.xml -Out .\template.pnp

Saves a PnP provisioning template to the file system as a PnP file.

EXAMPLE 2

$template = Read-PnPSiteTemplate -Path template.xml
Save-PnPSiteTemplate -Template $template -Out .\template.pnp

Saves a PnP site template to the file system as a PnP file. The schema used will the latest released schema when creating the PnP file regardless of the original schema

EXAMPLE 3

$template = Read-PnPSiteTemplate -Path template.xml
Save-PnPSiteTemplate -Template $template -Out .\template.pnp -Schema V202002

Saves a PnP site template to the file system as a PnP file and converts the template in the PnP file to the specified schema.

EXAMPLE 4

Read-PnPSiteTemplate -Path template.xml | Save-PnPSiteTemplate -Out .\template.pnp

Saves a PnP site template to the file system as a PnP file.

PARAMETERS

-Force

Specifying the Force parameter will skip the confirmation question.

Type: SwitchParameter
Parameter Sets: (All)

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

-Out

Filename to write to, optionally including full path.

Type: String
Parameter Sets: (All)

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

-Schema

The optional schema to use when creating the PnP file. Always defaults to the latest schema.

Type: XMLPnPSchemaVersion
Parameter Sets: (All)
Accepted values: LATEST, V201503, V201505, V201508, V201512, V201605, V201705, V201801, V201805, V201807, V201903, V201909, V202002, V202103, V202209

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

-Template

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

Type: SiteTemplatePipeBind
Parameter Sets: (All)
Aliases: InputInstance

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-TemplateProviderExtensions

Allows you to specify the ITemplateProviderExtension to execute while saving a template.

Type: ITemplateProviderExtension[]
Parameter Sets: (All)

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

Microsoft 365 Patterns and Practices