Show / Hide Table of Contents

    Read-PnPSiteTemplate

    SYNOPSIS

    Loads/Reads a PnP file from the file system or a string

    SYNTAX

    By Path

    Read-PnPSiteTemplate [-Path] <String> [-TemplateProviderExtensions <ITemplateProviderExtension[]>]
     [<CommonParameters>]
    

    By XML

    Read-PnPSiteTemplate [-Xml] <String> [-TemplateProviderExtensions <ITemplateProviderExtension[]>]
     [<CommonParameters>]
    

    DESCRIPTION

    EXAMPLES

    EXAMPLE 1

    Read-PnPSiteTemplate -Path template.pnp
    

    Loads a PnP file from the file system

    EXAMPLE 2

    Read-PnPSiteTemplate -Path template.pnp -TemplateProviderExtensions $extensions
    

    Loads a PnP file from the file system using some custom template provider extensions while loading the file.

    EXAMPLE 3

    Read-PnPSiteTemplate -Xml $xml
    

    Reads a PnP Provisioning template from a string containing the XML of a provisioning template

    PARAMETERS

    -Path

    Filename to read from, optionally including full path.

    Type: String
    Parameter Sets: By Path
    Aliases:
    
    Required: True
    Position: 0
    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)
    Aliases:
    
    Required: False
    Position: Named
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    -Xml

    Variable to read from, containing the valid XML of a provisioning template.

    Type: String
    Parameter Sets: By XML
    Aliases:
    
    Required: True
    Position: 1
    Default value: None
    Accept pipeline input: False
    Accept wildcard characters: False
    

    RELATED LINKS

    SharePoint Developer Patterns and Practices

    Back to top Generated by DocFX spacer