PnP Provisioning Schema

Topic automatically generated on 12/10/2021*

Namespace

The namespace of the PnP Provisioning Schema is:

http://schemas.dev.office.com/PnP/2021/03/ProvisioningSchema

All the elements have to be declared with that namespace reference.

Root Elements

Here follows the list of root elements available in the PnP Provisioning Schema.

Provisioning

<pnp:Provisioning
      xmlns:pnp="http://schemas.dev.office.com/PnP/2021/03/ProvisioningSchema"
      Version="xsd:decimal"
      Author="xsd:string"
      Generator="xsd:string"
      ImagePreviewUrl="xsd:string"
      DisplayName="xsd:string"
      Description="xsd:string">
   <pnp:Preferences />
   <pnp:Localizations />
   <pnp:Tenant />
   <pnp:Templates />
   <pnp:Sequence />
   <pnp:Teams />
   <pnp:AzureActiveDirectory />
   <pnp:Drive />
   <pnp:ProvisioningWebhooks />
</pnp:Provisioning>

Here follow the available child elements for the Provisioning element.

Element	Type	Description
Preferences	Preferences	Section of preferences for the current provisioning definition.
Localizations	Localizations	An optional list of localizations files to include.
Tenant	Tenant	Entry point to manage tenant-wide settings.
Templates	Templates	An optional section made of provisioning templates.
Sequence	Sequence	An optional section made of provisioning sequences, which can include Sites, Site Collections, Taxonomies, Provisioning Templates, etc.
Teams	Teams	Entry point to manage Microsoft Teams provisioning.
AzureActiveDirectory	AzureActiveDirectory	Entry point to manage Microsoft Azure Active Directory provisioning.
Drive	Drive	Entry point to manage OneDrive for Business provisioning.
ProvisioningWebhooks	ProvisioningWebhooks	Entry point to manage global provisioning webhooks.

Here follow the available attributes for the Provisioning element.

Attibute	Type	Description	Required
Version	xsd:decimal	The Version of the Provisioning Template, optional attribute.	No
Author	xsd:string	The Author of the Provisioning Template, optional attribute.	No
Generator	xsd:string	Name of the tool generating this Provisioning File, optional attribute.	No
ImagePreviewUrl	xsd:string	The Image Preview Url of the Provisioning File, optional attribute.	No
DisplayName	xsd:string	The Display Name of the Provisioning File, optional attribute.	No
Description	xsd:string	The Description of the Provisioning file, optional attribute.	No

ProvisioningTemplate

Represents the root element of the SharePoint Provisioning Template.

<pnp:ProvisioningTemplate
      xmlns:pnp="http://schemas.dev.office.com/PnP/2021/03/ProvisioningSchema"
      ID="xsd:ID"
      Version="xsd:decimal"
      BaseSiteTemplate="xsd:string"
      ImagePreviewUrl="xsd:string"
      DisplayName="xsd:string"
      Description="xsd:string"
      TemplateCultureInfo="pnp:ReplaceableString"
      Scope="">
   <pnp:Properties />
   <pnp:SitePolicy />
   <pnp:WebSettings />
   <pnp:SiteSettings />
   <pnp:RegionalSettings />
   <pnp:SupportedUILanguages />
   <pnp:AuditSettings />
   <pnp:PropertyBagEntries />
   <pnp:Security />
   <pnp:Navigation />
   <pnp:SiteFields />
   <pnp:ContentTypes />
   <pnp:Lists />
   <pnp:Features />
   <pnp:CustomActions />
   <pnp:Files />
   <pnp:Pages />
   <pnp:TermGroups />
   <pnp:ComposedLook />
   <pnp:Workflows />
   <pnp:SearchSettings />
   <pnp:Publishing />
   <pnp:ApplicationLifecycleManagement />
   <pnp:Providers />
   <pnp:SiteWebhooks />
   <pnp:ClientSidePages />
   <pnp:Header />
   <pnp:Footer />
   <pnp:ProvisioningTemplateWebhooks />
   <pnp:Theme />
</pnp:ProvisioningTemplate>

Here follow the available child elements for the ProvisioningTemplate element.

Element	Type	Description
Properties	ProvisioningTemplateProperties	A set of custom Properties for the Provisioning Template, optional element.
SitePolicy	ReplaceableString	The Site Policy of the Provisioning Template, optional element.
WebSettings	WebSettings	Section of Settings for the current Web Site, optional element.
SiteSettings	SiteSettings	Section of Settings for the current Site Collection, optional element.
RegionalSettings	RegionalSettings	The Regional Settings of the Provisioning Template, optional element.
SupportedUILanguages	SupportedUILanguages	The Supported UI Languages for the Provisioning Template, optional element.
AuditSettings	AuditSettings	The Audit Settings for the Provisioning Template, optional element.
PropertyBagEntries	PropertyBagEntries	The Property Bag entries of the Provisioning Template, optional collection of elements.
Security	Security	The Security configurations of the Provisioning Template, optional collection of elements.
Navigation	Navigation	The Navigation configurations of the Provisioning Template, optional collection of elements.
SiteFields	SiteFields	The Site Columns of the Provisioning Template, optional element.
ContentTypes	ContentTypes	The Content Types of the Provisioning Template, optional element.
Lists	Lists	The Lists instances of the Provisioning Template, optional element.
Features	Features	The Features (Site or Web) to activate or deactivate while applying the Provisioning Template, optional collection of elements.
CustomActions	CustomActions	The Custom Actions (Site or Web) to provision with the Provisioning Template, optional element.
Files	Files	The Files to provision into the target Site through the Provisioning Template, optional element.
Pages	Pages	The Pages to provision into the target Site through the Provisioning Template, optional element.
TermGroups	TermGroups	The TermGroups element allows provisioning one or more TermGroups into the target Site, optional element.
ComposedLook	ComposedLook	The ComposedLook for the Provisioning Template, optional element.
Workflows	Workflows	The Workflows for the Provisioning Template, optional element.
SearchSettings	SearchSettings	The Search Settings for the Provisioning Template, optional element.
Publishing	Publishing	The Publishing capabilities configuration for the Provisioning Template, optional element.
ApplicationLifecycleManagement	ApplicationLifecycleManagement	Entry point to manage the ALM of SharePoint Add-Ins and SharePoint Framework solutions at the site collection level.
Providers	Providers	The Extensiblity Providers to invoke while applying the Provisioning Template, optional collection of elements.
SiteWebhooks	SiteWebhooksList	Defines any list of Webhooks for the current site.
ClientSidePages	ClientSidePages	The Client-side Pages to provision into the target Site through the Provisioning Template, optional element.
Header	Header	The Header of the Site provisioned through the Provisioning Template, optional element.
Footer	Footer	The Footer of the Site provisioned through the Provisioning Template, optional element.
ProvisioningTemplateWebhooks	ProvisioningTemplateWebhooks	The Webhooks for the Provisioning Template, optional element.
Theme	Theme	The Theme for the Provisioning Template, optional element.

Here follow the available attributes for the ProvisioningTemplate element.

Attibute	Type	Description	Required
ID	xsd:ID	The ID of the Provisioning Template, required attribute.	Yes
Version	xsd:decimal	The Version of the Provisioning Template, optional attribute.	No
BaseSiteTemplate	xsd:string	The Base SiteTemplate of the Provisioning Template, optional attribute.	No
ImagePreviewUrl	xsd:string	The Image Preview Url of the Provisioning Template, optional attribute.	No
DisplayName	xsd:string	The Display Name of the Provisioning Template, optional attribute.	No
Description	xsd:string	The Description of the Provisioning Template, optional attribute.	No
TemplateCultureInfo	ReplaceableString	The default CultureInfo of the Provisioning Template, used to format all input values, optional attribute.	No
Scope		Declares the target scope of the current Provisioning Template	No

Child Elements and Complex Types

Here follows the list of all the other child elements and complex types that can be used in the PnP Provisioning Schema.

Preferences

General settings for a Provisioning file.

<pnp:Preferences
      Version="xsd:string"
      Author="xsd:string"
      Generator="xsd:string">
   <pnp:Parameters />
</pnp:Preferences>

Here follow the available child elements for the Preferences element.

Element	Type	Description
Parameters	Parameters	Definition of parameters that can be used as replacement within templates and provisioning objects.

Here follow the available attributes for the Preferences element.

Attibute	Type	Description	Required
Version	xsd:string	Provisioning File Version number, optional attribute.	No
Author	xsd:string	Provisioning File Author name, optional attribute.	No
Generator	xsd:string	Name of the tool generating this Provisioning File, optional attribute.	No

Parameters

Definition of parameters that can be used as replacement within templates and provisioning objects.

<pnp:Parameters>
   <pnp:Parameter />
</pnp:Parameters>

Here follow the available child elements for the element.

Element	Type	Description
Parameter	Parameter	A Parameter that can be used as a replacement within templates and provisioning objects.

Localizations

An optional list of localizations files to include.

<pnp:Localizations
      DefaultLCID="xsd:int">
   <pnp:Localization />
</pnp:Localizations>

Here follow the available child elements for the Localizations element.

Element	Type	Description
Localization	Localization	A Localization element

Here follow the available attributes for the Localizations element.

Attibute	Type	Description	Required	Default
DefaultLCID	xsd:int	The default Locale ID for the current template, optional attribute.	No	1033

Localization

A Localization element

<pnp:Localization
      LCID="xsd:int"
      Name="xsd:string"
      ResourceFile="xsd:string">
</pnp:Localization>

Here follow the available attributes for the element.

Attibute	Type	Description	Required
LCID	xsd:int	The Locale ID of a Localization Language, required attribute.	Yes
Name	xsd:string	The Name of a Localization Language, required attribute.	Yes
ResourceFile	xsd:string	The path to the .RESX (XML) resource file for the current Localization, required attribute.	Yes

Tenant

Element to manage tenant-wide settings.

<pnp:Tenant>
   <pnp:AppCatalog />
   <pnp:WebApiPermissions />
   <pnp:ContentDeliveryNetwork />
   <pnp:SiteDesigns />
   <pnp:SiteScripts />
   <pnp:StorageEntities />
   <pnp:Themes />
   <pnp:SPUsersProfiles />
   <pnp:Office365GroupLifecyclePolicies />
   <pnp:Office365GroupsSettings />
   <pnp:SharingSettings />
</pnp:Tenant>

Here follow the available child elements for the Tenant element.

Element	Type	Description
AppCatalog	AppCatalog	Entry point for the tenant-wide AppCatalog, optional element.
WebApiPermissions	WebApiPermissions	Entry point for the tenant-wide Web API permissions, optional element.
ContentDeliveryNetwork	ContentDeliveryNetwork	Entry point for the tenant-wide Content Delivery Network, optional element.
SiteDesigns	SiteDesigns	Entry point for the tenant-wide Site Designs, optional element.
SiteScripts	SiteScripts	Entry point for the tenant-wide Site Scripts, optional element.
StorageEntities	StorageEntities	Entry point for the tenant-wide properties (Storage Entities), optional element.
Themes	Themes	Entry point for the tenant-wide Themes, optional element.
SPUsersProfiles	SPUsersProfiles	Entry point for the User Profile properties, optional element.
Office365GroupLifecyclePolicies	Office365GroupLifecyclePolicies	Defines a collection of Group Lifecycle Policies, optional element.
Office365GroupsSettings	Office365GroupsSettings	Defines the configuration properties for Unified Groups at tenant level, optional element.
SharingSettings	SharingSettings	Defines the tenant-level sharing settings, optional element.

Office365GroupsSettings

Defines the configuration properties for Unified Groups at tenant level, optional element.

<pnp:Office365GroupsSettings>
   <pnp:Property />
</pnp:Office365GroupsSettings>

Here follow the available child elements for the element.

Element	Type	Description
Property	StringDictionaryItem	Defines a custom property and value for the Unified Group Settings

WebApiPermissions

Collection of tenant-wide Web API permissions.

<pnp:WebApiPermissions>
   <pnp:WebApiPermission />
</pnp:WebApiPermissions>

Here follow the available child elements for the WebApiPermissions element.

Element	Type	Description
WebApiPermission	WebApiPermission

WebApiPermission

A single tenant-wide Web API permission.

<pnp:WebApiPermission
      Resource="xsd:string"
      Scope="xsd:string">
</pnp:WebApiPermission>

Here follow the available attributes for the element.

Attibute	Type	Description	Required
Resource	xsd:string	The target resource for a Web API permission, required attribute.	Yes
Scope	xsd:string	The target resource for a Web API permission, required attribute.	Yes

SiteDesigns

Collection of tenant-wide Site Designs

<pnp:SiteDesigns>
   <pnp:SiteDesign />
</pnp:SiteDesigns>

Here follow the available child elements for the SiteDesigns element.

Element	Type	Description
SiteDesign	SiteDesign	Defines a single tenant-wide Site Design

SiteDesign

Defines a single tenant-wide Site Design

<pnp:SiteDesign
      Title="xsd:string"
      Description="xsd:string"
      IsDefault="xsd:boolean"
      WebTemplate=""
      PreviewImageUrl="xsd:string"
      PreviewImageAltText="xsd:string"
      Overwrite="xsd:boolean">
   <pnp:SiteScripts />
   <pnp:Grants />
</pnp:SiteDesign>

Here follow the available child elements for the element.

Element	Type	Description
SiteScripts	SiteScripts	A collection of Site Scripts references for the current Site Design
Grants	Grants	A collection of Grants for the Site Design

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
Title	xsd:string	The Title of the Site Design	Yes
Description	xsd:string	The Description of the Site Design, optional attribute.	No
IsDefault	xsd:boolean	Defines whether the Site Design is default or not, optional attribute (default: false).	No	false
WebTemplate		Defines whether the Site Design is default or not, required attribute.	Yes
PreviewImageUrl	xsd:string	The URL of the preview image for the Site Design, optional attribute.	No
PreviewImageAltText	xsd:string	The alternate text for the preview image of the Site Design, optional attribute.	No
Overwrite	xsd:boolean	Defines whether the Site Design should be overwritten in case of existence, optional attribute (default:true).	No	true

SiteScripts

Collection of tenant-wide Site Scripts

<pnp:SiteScripts>
   <pnp:SiteScript />
</pnp:SiteScripts>

Here follow the available child elements for the SiteScripts element.

Element	Type	Description
SiteScript	SiteScript	Defines a single tenant-wide Site Script

SiteScript

Defines a single tenant-wide Site Script

<pnp:SiteScript
      Title="xsd:string"
      Description="xsd:string"
      JsonFilePath="xsd:string"
      Overwrite="xsd:boolean">
</pnp:SiteScript>

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
Title	xsd:string	The Title of the Site Script, required attribute.	Yes
Description	xsd:string	The Description of the Site Script, required attribute.	Yes
JsonFilePath	xsd:string	The path of the JSON file defining the Site Script, required attribute.	Yes
Overwrite	xsd:boolean	Defines whether the Site Script should be overwritten in case of existence, optional attribute (default:true).	No	true

StorageEntities

Collection of tenant-wide properties (Storage Entities)

<pnp:StorageEntities
      Comment="xsd:string"
      Description="xsd:string">
   <pnp:StorageEntity />
</pnp:StorageEntities>

Here follow the available child elements for the StorageEntities element.

Element	Type	Description
StorageEntity	StorageEntity	Defines a single tenant-wide property (Storage Entity)

Here follow the available attributes for the StorageEntities element.

Attibute	Type	Description	Required
Comment	xsd:string	The Comment of the tenant-wide property, optional attribute.	No
Description	xsd:string	The Description of the tenant-wide property, optional attribute.	No

StorageEntity

Defines a single tenant-wide property (Storage Entity)

<pnp:StorageEntity
      Comment="xsd:string"
      Description="xsd:string">
</pnp:StorageEntity>

Here follow the available attributes for the element.

Attibute	Type	Description	Required
Comment	xsd:string	The Comment of the tenant-wide property, optional attribute.	No
Description	xsd:string	The Description of the tenant-wide property, optional attribute.	No

Themes

Collection of tenant-wide Themes

<pnp:Themes>
   <pnp:Theme />
</pnp:Themes>

Here follow the available child elements for the Themes element.

Element	Type	Description
Theme	Theme	Defines a single tenant-wide Theme

Theme

Defines a single Theme

<pnp:Theme
      Name="xsd:string"
      IsInverted="xsd:boolean"
      Overwrite="xsd:boolean">
</pnp:Theme>

Here follow the available attributes for the Theme element.

Attibute	Type	Description	Required	Default
Name	xsd:string	Defines the name of the tenant-wide Theme	Yes
IsInverted	xsd:boolean	Defines the name of the tenant-wide Theme	No	false
Overwrite	xsd:boolean	Defines whether to overwrite an already existing theme, optional attribute.	No	false

SPUsersProfiles

Collection of UserProfile objects with custom properties

<pnp:SPUsersProfiles>
   <pnp:SPUserProfile />
</pnp:SPUsersProfiles>

Here follow the available child elements for the SPUsersProfiles element.

Element	Type	Description
SPUserProfile	SPUserProfile	Defines a single UserProfile

SPUserProfile

Defines a single UserProfile

<pnp:SPUserProfile
      TargetUser="pnp:ReplaceableString"
      TargetGroup="pnp:ReplaceableString">
   <pnp:Property />
</pnp:SPUserProfile>

Here follow the available child elements for the SPUserProfile element.

Element	Type	Description
Property	StringDictionaryItem	Defines a custom property and value for a UserProfile

Here follow the available attributes for the SPUserProfile element.

Attibute	Type	Description	Required
TargetUser	ReplaceableString	Defines the target User	No
TargetGroup	ReplaceableString	Defines the target AAD Group	No

Office365GroupLifecyclePolicies

Collection of Group Lifecycle Policies objects

<pnp:Office365GroupLifecyclePolicies>
   <pnp:Office365GroupLifecyclePolicy />
</pnp:Office365GroupLifecyclePolicies>

Here follow the available child elements for the Office365GroupLifecyclePolicies element.

Element	Type	Description
Office365GroupLifecyclePolicy	Office365GroupLifecyclePolicy	Defines a single Group Lifecycle Policy

SharingSettings

Defines the tenant-level sharing settings

<pnp:SharingSettings
      SharingCapability=""
      RequireAnonymousLinksExpireInDays="xsd:int"
      FileAnonymousLinkType="pnp:AnonymousLinkType"
      FolderAnonymousLinkType="pnp:AnonymousLinkType"
      DefaultSharingLinkType=""
      PreventExternalUsersFromResharing="xsd:boolean"
      RequireAcceptingAccountMatchInvitedAccount="xsd:boolean"
      SharingDomainRestrictionMode=""
      AllowedDomainList="pnp:ReplaceableString"
      BlockedDomainList="pnp:ReplaceableString">
</pnp:SharingSettings>

Here follow the available attributes for the SharingSettings element.

Attibute	Type	Description	Required
SharingCapability		Configures the sharing capability for the tenant, required attribute.	Yes
RequireAnonymousLinksExpireInDays	xsd:int	Number of days before expiration of anonymous sharing links, optional attribute.	No
FileAnonymousLinkType	AnonymousLinkType	Defines the permissions for anonymous links for files, optional attribute.	No
FolderAnonymousLinkType	AnonymousLinkType	Defines the permissions for anonymous links for folders, optional attribute.	No
DefaultSharingLinkType		Defines the default type of a sharing link, optional attribute.	No
PreventExternalUsersFromResharing	xsd:boolean	Defines whether external users are allowed to reshare the content, optional attribute.	No
RequireAcceptingAccountMatchInvitedAccount	xsd:boolean	Defines whether invited external users need to use the same account used as the target for the invite, optional attribute.	No
SharingDomainRestrictionMode		Defines domains restrictions for sharing, optional attribute.	No
AllowedDomainList	ReplaceableString	Defines a comma separated list of allowed domains for sharing, optional attribute. It is considered if and only if SharingDomainRestrictionMode=AllowList.	No
BlockedDomainList	ReplaceableString	Defines a comma separated list of blocked domains for sharing, optional attribute. It is considered if and only if SharingDomainRestrictionMode=BlockList.	No

Office365GroupLifecyclePolicy

Defines a single Group Lifecycle Policy

<pnp:Office365GroupLifecyclePolicy
      ID="xsd:string"
      GroupLifetimeInDays="xsd:int"
      AlternateNotificationEmails="pnp:ReplaceableString"
      ManagedGroupTypes="">
</pnp:Office365GroupLifecyclePolicy>

Here follow the available attributes for the Office365GroupLifecyclePolicy element.

Attibute	Type	Description	Required
ID	xsd:string	Defines the PnP internal ID for the Group Lifetime Policy, required attribute.	Yes
GroupLifetimeInDays	xsd:int	Defines the Group Lifetime in Days for the policy, required attribute.	Yes
AlternateNotificationEmails	ReplaceableString	Defines the Alternate Notification Emails for the policy, required attribute. Separate multiple email addresses with a semicolon.	Yes
ManagedGroupTypes		Defines the Managed Group Types for the policy, required attribute.	Yes

Templates

SharePoint Templates, which can be inline or references to external files.

<pnp:Templates
      ID="xsd:ID">
   <pnp:ProvisioningTemplateFile />
   <pnp:ProvisioningTemplateReference />
   <pnp:ProvisioningTemplate />
</pnp:Templates>

Here follow the available child elements for the Templates element.

Element	Type	Description
ProvisioningTemplateFile	ProvisioningTemplateFile	Reference to an external template file, which will be based on the current schema but will focus only on the SharePointProvisioningTemplate section.
ProvisioningTemplateReference	ProvisioningTemplateReference	Reference to another template by ID.
ProvisioningTemplate	ProvisioningTemplate

Here follow the available attributes for the Templates element.

Attibute	Type	Description	Required	Default
ID	xsd:ID	A unique identifier of the Templates collection, optional attribute.	No

SiteFields

The Site Columns of the Provisioning Template, optional element.

<pnp:SiteFields>
   <!-- Any other XML content -->
</pnp:SiteFields>

ContentTypes

The Content Types of the Provisioning Template, optional element.

<pnp:ContentTypes>
   <pnp:ContentType />
</pnp:ContentTypes>

Here follow the available child elements for the element.

Element	Type	Description
ContentType	ContentType

Lists

The Lists instances of the Provisioning Template, optional element.

<pnp:Lists>
   <pnp:ListInstance />
</pnp:Lists>

Here follow the available child elements for the element.

Element	Type	Description
ListInstance	ListInstance

Files

The Files to provision into the target Site through the Provisioning Template, optional element.

<pnp:Files>
   <pnp:File />
   <pnp:Directory />
</pnp:Files>

Here follow the available child elements for the element.

Element	Type	Description
File	File
Directory	Directory

TermGroups

The TermGroups element allows provisioning one or more TermGroups into the target Site, optional element.

<pnp:TermGroups>
   <pnp:TermGroup />
</pnp:TermGroups>

Here follow the available child elements for the element.

Element	Type	Description
TermGroup	TermGroup	The TermGroup element to provision into the target Site through the Provisioning Template, optional element.

SearchSettings

The Search Settings for the Provisioning Template, optional element.

<pnp:SearchSettings>
   <pnp:SiteSearchSettings />
   <pnp:WebSearchSettings />
</pnp:SearchSettings>

Here follow the available child elements for the element.

Element	Type	Description
SiteSearchSettings	SiteSearchSettings	The Search Settings for the Site Collection, optional element.
WebSearchSettings	WebSearchSettings	The Search Settings for the Site, optional element.

Providers

The Extensiblity Providers to invoke while applying the Provisioning Template, optional collection of elements.

<pnp:Providers>
   <pnp:Provider />
</pnp:Providers>

Here follow the available child elements for the element.

Element	Type	Description
Provider	Provider

ProvisioningTemplateWebhooks

Allows to define one or more webhooks that will be invoked by the engine, upon completion of specific actions

<pnp:ProvisioningTemplateWebhooks>
   <pnp:ProvisioningTemplateWebhook />
</pnp:ProvisioningTemplateWebhooks>

Here follow the available child elements for the element.

Element	Type	Description
ProvisioningTemplateWebhook	ProvisioningWebhook	Defines a single Provisioning Template Webhook

ProvisioningTemplateProperties

A set of custom Properties for the Provisioning Template.

<pnp:ProvisioningTemplateProperties>
   <pnp:Property />
</pnp:ProvisioningTemplateProperties>

Here follow the available child elements for the ProvisioningTemplateProperties element.

Element	Type	Description
Property	StringDictionaryItem	A custom Property for the Provisioning Template, collection of elements.

WebSettings

Section of Settings for the current Web Site, optional element.

<pnp:WebSettings
      RequestAccessEmail="xsd:string"
      NoCrawl="xsd:boolean"
      WelcomePage="xsd:string"
      Title="xsd:string"
      Description="xsd:string"
      SiteLogo="xsd:string"
      SiteLogoThumbnail="xsd:string"
      AlternateCSS="xsd:string"
      MasterPageUrl="xsd:string"
      CustomMasterPageUrl="xsd:string"
      HubSiteUrl="xsd:string"
      CommentsOnSitePagesDisabled="xsd:boolean"
      QuickLaunchEnabled="xsd:boolean"
      ExcludeFromOfflineClient="xsd:boolean"
      MembersCanShare="xsd:boolean"
      DisableFlows="xsd:boolean"
      DisableAppViews="xsd:boolean"
      HorizontalQuickLaunch="xsd:boolean"
      SearchScope=""
      IsMultilingual="xsd:boolean"
      OverwriteTranslationsOnChange="xsd:boolean"
      SearchBoxInNavBar="pnp:SearchBoxInNavBar"
      SearchCenterUrl="pnp:ReplaceableString">
   <pnp:AlternateUICultures />
</pnp:WebSettings>

Here follow the available child elements for the WebSettings element.

Element	Type	Description
AlternateUICultures	AlternateUICultures	Defines the list of Alternate UI Cultures for the current web, optional element.

Here follow the available attributes for the WebSettings element.

Attibute	Type	Description	Required	Default
RequestAccessEmail	xsd:string	The email address to which any access request will be sent, optional attribute.	No
NoCrawl	xsd:boolean	Defines whether the site has to be crawled or not, optional attribute.	No
WelcomePage	xsd:string	Defines the Welcome Page (Home Page) of the site to which the Provisioning Template is applied, optional attribute. The page does not necessarily need to be in the current template, can be an already existing one.	No
Title	xsd:string	The Title of the Site, optional attribute.	No
Description	xsd:string	The Description of the Site, optional attribute.	No
SiteLogo	xsd:string	The SiteLogo of the Site, optional attribute.	No
SiteLogoThumbnail	xsd:string	The SiteLogoThumbnail of the Site, optional attribute.	No
AlternateCSS	xsd:string	The AlternateCSS of the Site, optional attribute.	No
MasterPageUrl	xsd:string	The MasterPage URL of the Site, optional attribute.	No
CustomMasterPageUrl	xsd:string	The Custom MasterPage URL of the Site, optional attribute.	No
HubSiteUrl	xsd:string	The URL of the Hub Site to associate the site to, optional attribute. If it is empty, you disassociate it from any Hub Site.	No
CommentsOnSitePagesDisabled	xsd:boolean	Enables or disables comments on client side pages, optional attribute.	No
QuickLaunchEnabled	xsd:boolean	Enables or disables the QuickLaunch for the site, optional attribute.	No
ExcludeFromOfflineClient	xsd:boolean	Defines whether to exclude the web from offline client, optional attribute.	No	false
MembersCanShare	xsd:boolean	Defines whether members can share content from the current web, optional attribute.	No	false
DisableFlows	xsd:boolean	Defines whether disable flows for the current web, optional attribute.	No	false
DisableAppViews	xsd:boolean	Defines whether disable PowerApps for the current web, optional attribute.	No	false
HorizontalQuickLaunch	xsd:boolean	Defines whether to enable the Horizontal QuickLaunch for the current web, optional attribute.	No	false
SearchScope		Defines the SearchScope for the site, optional attribute.	No
IsMultilingual	xsd:boolean	Defines whether to enable Multilingual capabilities for the current web, optional attribute.	No	false
OverwriteTranslationsOnChange	xsd:boolean	Defines whether to OverwriteTranslationsOnChange on change for the current web, optional attribute.	No	false
SearchBoxInNavBar	SearchBoxInNavBar	Defines how the searchbox in navbar will be rendered, optional attribute.	No
SearchCenterUrl	ReplaceableString	Defines the Search Center URL, optional attribute.	No

AlternateUICultures

Defines the list of Alternate UI Cultures for the current web, optional element.

<pnp:AlternateUICultures>
   <pnp:AlternateUICulture />
</pnp:AlternateUICultures>

Here follow the available child elements for the element.

Element	Type	Description
AlternateUICulture	AlternateUICulture	Defines an Alternate UI Culture item for the current web, optional element.

SiteSettings

Section of Settings for the current Site Collection, optional element.

<pnp:SiteSettings
      AllowDesigner="xsd:boolean"
      AllowCreateDeclarativeWorkflow="xsd:boolean"
      AllowSaveDeclarativeWorkflowAsTemplate="xsd:boolean"
      AllowSavePublishDeclarativeWorkflow="xsd:boolean"
      SocialBarOnSitePagesDisabled="xsd:boolean"
      SearchBoxInNavBar="pnp:SearchBoxInNavBar"
      SearchCenterUrl="pnp:ReplaceableString">
</pnp:SiteSettings>

Here follow the available attributes for the SiteSettings element.

Attibute	Type	Description	Required	Default
AllowDesigner	xsd:boolean	Defines whether a designer can be used on this site collection, optional attribute.	No	false
AllowCreateDeclarativeWorkflow	xsd:boolean	Defines whether creation of declarative workflows is allowed in the site collection, optional attribute.	No	false
AllowSaveDeclarativeWorkflowAsTemplate	xsd:boolean	Defines whether saving of declarative workflows is allowed in the site collection, optional attribute.	No	false
AllowSavePublishDeclarativeWorkflow	xsd:boolean	Defines whether publishing of declarative workflows is allowed in the site collection, optional attribute.	No	false
SocialBarOnSitePagesDisabled	xsd:boolean	Defines whether social bar is disabled on Site Pages in this site collection, optional attribute.	No	false
SearchBoxInNavBar	SearchBoxInNavBar	Defines how the searchbox in navbar will be rendered, optional attribute.	No
SearchCenterUrl	ReplaceableString	Defines the Search Center URL, optional attribute.	No

RegionalSettings

Defines the Regional Settings for a site.

<pnp:RegionalSettings
      AdjustHijriDays="xsd:int"
      AlternateCalendarType="pnp:CalendarType"
      CalendarType="pnp:CalendarType"
      Collation="xsd:int"
      FirstDayOfWeek="pnp:DayOfWeek"
      FirstWeekOfYear="xsd:int"
      LocaleId="xsd:int"
      ShowWeeks="xsd:boolean"
      Time24="xsd:boolean"
      TimeZone="pnp:ReplaceableInt"
      WorkDayEndHour="pnp:WorkHour"
      WorkDays="xsd:int"
      WorkDayStartHour="pnp:WorkHour">
</pnp:RegionalSettings>

Here follow the available attributes for the RegionalSettings element.

Attibute	Type	Description	Required
AdjustHijriDays	xsd:int	The number of days to extend or reduce the current month in Hijri calendars, optional attribute.	No
AlternateCalendarType	CalendarType	The Alternate Calendar type that is used on the server, optional attribute.	No
CalendarType	CalendarType	The Calendar Type that is used on the server, optional attribute.	No
Collation	xsd:int	The Collation that is used on the site, optional attribute.	No
FirstDayOfWeek	DayOfWeek	The First Day of the Week used in calendars on the server, optional attribute.	No
FirstWeekOfYear	xsd:int	The First Week of the Year used in calendars on the server, optional attribute.	No
LocaleId	xsd:int	The Locale Identifier in use on the server, optional attribute.	No
ShowWeeks	xsd:boolean	Defines whether to display the week number in day or week views of a calendar, optional attribute.	No
Time24	xsd:boolean	Defines whether to use a 24-hour time format in representing the hours of the day, optional attribute.	No
TimeZone	ReplaceableInt	The Time Zone that is used on the server, optional attribute.	No
WorkDayEndHour	WorkHour	The the default hour at which the work day ends on the calendar that is in use on the server, optional attribute.	No
WorkDays	xsd:int	The work days of Web site calendars, optional attribute.	No
WorkDayStartHour	WorkHour	The the default hour at which the work day starts on the calendar that is in use on the server, optional attribute.	No

SupportedUILanguages

Defines the Supported UI Languages for a site.

<pnp:SupportedUILanguages>
   <pnp:SupportedUILanguage />
</pnp:SupportedUILanguages>

Here follow the available child elements for the SupportedUILanguages element.

Element	Type	Description
SupportedUILanguage	SupportedUILanguage	Defines a single Supported UI Language for a site.

SupportedUILanguage

Defines a single Supported UI Language for a site.

<pnp:SupportedUILanguage
      LCID="xsd:int">
</pnp:SupportedUILanguage>

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
LCID	xsd:int	The Locale ID of a Supported UI Language, required attribute.	Yes

AuditSettings

The Audit Settings for the Provisioning Template, optional collection of elements.

<pnp:AuditSettings
      AuditLogTrimmingRetention="xsd:int"
      TrimAuditLog="xsd:boolean">
   <pnp:Audit />
</pnp:AuditSettings>

Here follow the available child elements for the AuditSettings element.

Element	Type	Description
Audit	Audit	A single Audit setting defined by an AuditFlag.

Here follow the available attributes for the AuditSettings element.

Attibute	Type	Description	Required
AuditLogTrimmingRetention	xsd:int	The Audit Log Trimming Retention for Audits, optional attribute.	No
TrimAuditLog	xsd:boolean	A flag to enable Audit Log Trimming, optional attribute.	No

Audit

A single Audit setting defined by an AuditFlag.

<pnp:Audit
      AuditFlag="">
</pnp:Audit>

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
AuditFlag		An Audit Flag for a single Audit setting, required attribute.	Yes

PropertyBagEntries

The Property Bag entries of the Provisioning Template, optional collection of elements.

<pnp:PropertyBagEntries>
   <pnp:PropertyBagEntry />
</pnp:PropertyBagEntries>

Here follow the available child elements for the PropertyBagEntries element.

Element	Type	Description
PropertyBagEntry	PropertyBagEntry

Security

The Security configurations of the Provisioning Template, optional collection of elements.

<pnp:Security
      BreakRoleInheritance="xsd:boolean"
      ResetRoleInheritance="xsd:boolean"
      CopyRoleAssignments="xsd:boolean"
      RemoveExistingUniqueRoleAssignments="xsd:boolean"
      ClearSubscopes="xsd:boolean"
      AssociatedGroups="pnp:ReplaceableString"
      AssociatedOwnerGroup="pnp:ReplaceableString"
      AssociatedMemberGroup="pnp:ReplaceableString"
      AssociatedVisitorGroup="pnp:ReplaceableString">
   <pnp:AdditionalAdministrators />
   <pnp:AdditionalOwners />
   <pnp:AdditionalMembers />
   <pnp:AdditionalVisitors />
   <pnp:SiteGroups />
   <pnp:Permissions />
</pnp:Security>

Here follow the available child elements for the Security element.

Element	Type	Description
AdditionalAdministrators	UsersList	List of additional Administrators for the Site, optional collection of elements.
AdditionalOwners	UsersList	List of additional Owners for the Site, optional collection of elements.
AdditionalMembers	UsersList	List of additional Members for the Site, optional collection of elements.
AdditionalVisitors	UsersList	List of additional Visitors for the Site, optional collection of elements.
SiteGroups	SiteGroups	List of additional Groups for the Site, optional collection of elements.
Permissions	Permissions

Here follow the available attributes for the Security element.

Attibute	Type	Description	Required	Default
BreakRoleInheritance	xsd:boolean	Declares whether the to break role inheritance for the site, if it is a sub-site, optional attribute.	No	false
ResetRoleInheritance	xsd:boolean	Declares whether to reset the role inheritance or not for the site, if it is a sub-site, optional attribute.	No	false
CopyRoleAssignments	xsd:boolean	Defines whether to copy role assignments or not while breaking role inheritance, optional attribute.	No	false
RemoveExistingUniqueRoleAssignments	xsd:boolean	Defines whether to remove unique role assignments or not if the site already breaks role inheritance. If true all existing unique role assignments on the site will be removed if BreakRoleInheritance also is true.	No	false
ClearSubscopes	xsd:boolean	Defines whether to clear subscopes or not while breaking role inheritance for the site, optional attribute.	No	false
AssociatedGroups	ReplaceableString	Specifies the list of groups that are associated with the Web site. Groups in this list will appear under the Groups section in the People and Groups page.	No
AssociatedOwnerGroup	ReplaceableString	Specifies the default owners group for this site. The group will automatically be added to the end of the Associated Groups list.	No
AssociatedMemberGroup	ReplaceableString	Specifies the default members group for this site. The group will automatically be added to the top of the Associated Groups list.	No
AssociatedVisitorGroup	ReplaceableString	Specifies the default visitors group for this site. The group will automatically be added to the end of the Associated Groups list.	No

Permissions

<pnp:Permissions>
   <pnp:RoleDefinitions />
   <pnp:RoleAssignments />
</pnp:Permissions>

Here follow the available child elements for the element.

Element	Type	Description
RoleDefinitions	RoleDefinitions	List of Role Definitions for the Site, optional collection of elements.
RoleAssignments	RoleAssignments	List of Role Assignments for the Site, optional collection of elements.

Navigation

The Navigation configurations of the Provisioning Template, optional collection of elements.

<pnp:Navigation
      EnableTreeView="xsd:boolean"
      AddNewPagesToNavigation="xsd:boolean"
      CreateFriendlyUrlsForNewPages="xsd:boolean"
      EnableAudienceTargeting="xsd:boolean">
   <pnp:GlobalNavigation />
   <pnp:CurrentNavigation />
   <pnp:SearchNavigation />
</pnp:Navigation>

Here follow the available child elements for the Navigation element.

Element	Type	Description
GlobalNavigation	GlobalNavigation	The Global Navigation settings for the Provisioning Template, optional element.
CurrentNavigation	CurrentNavigation	The Current Navigation settings for the Provisioning Template, optional element.
SearchNavigation	StructuralNavigation	The Search Navigation settings for the Provisioning Template, optional element.

Here follow the available attributes for the Navigation element.

Attibute	Type	Description	Required	Default
EnableTreeView	xsd:boolean	Declares whether the tree view has to be enabled at the site level or not, optional attribute.	No	false
AddNewPagesToNavigation	xsd:boolean	Declares whether the New Page ribbon command will automatically create a navigation item for the newly created page, optional attribute.	No	false
CreateFriendlyUrlsForNewPages	xsd:boolean	Declares whether the New Page ribbon command will automatically create a friendly URL for the newly created page, optional attribute.	No	false
EnableAudienceTargeting	xsd:boolean	Declares whether to enable site navigation audience targeting or not, optional attribute.	No	false

GlobalNavigation

The Global Navigation settings for the Provisioning Template, optional element.

<pnp:GlobalNavigation
      NavigationType="">
   <pnp:StructuralNavigation />
   <pnp:ManagedNavigation />
</pnp:GlobalNavigation>

Here follow the available child elements for the element.

Element	Type	Description
StructuralNavigation	StructuralNavigation
ManagedNavigation	ManagedNavigation

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
NavigationType		Defines the type of Global Navigation, required attribute.	No	Inherit

CurrentNavigation

The Current Navigation settings for the Provisioning Template, optional element.

<pnp:CurrentNavigation
      NavigationType="">
   <pnp:StructuralNavigation />
   <pnp:ManagedNavigation />
</pnp:CurrentNavigation>

Here follow the available child elements for the element.

Element	Type	Description
StructuralNavigation	StructuralNavigation
ManagedNavigation	ManagedNavigation

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
NavigationType		Defines the type of Current Navigation, required attribute.	No	Inherit

ManagedNavigation

Defines the Managed Navigation settings of a site, optional element.

<pnp:ManagedNavigation
      TermStoreId="pnp:ReplaceableString"
      TermSetId="pnp:ReplaceableString">
</pnp:ManagedNavigation>

Here follow the available attributes for the ManagedNavigation element.

Attibute	Type	Description	Required
TermStoreId	ReplaceableString	Defines the TermStore ID for the Managed Navigation, required attribute.	Yes
TermSetId	ReplaceableString	Defines the TermSet ID for the Managed Navigation, required attribute.	Yes

StructuralNavigation

Defines the Structural Navigation settings of a site.

<pnp:StructuralNavigation
      RemoveExistingNodes="xsd:boolean">
   <pnp:NavigationNode />
</pnp:StructuralNavigation>

Here follow the available child elements for the StructuralNavigation element.

Element	Type	Description
NavigationNode	NavigationNode

Here follow the available attributes for the StructuralNavigation element.

Attibute	Type	Description	Required	Default
RemoveExistingNodes	xsd:boolean	Defines whether to remove existing nodes before creating those described through this element, required attribute.	Yes

NavigationNode

Defines a Navigation Node for the Structural Navigation of a site.

<pnp:NavigationNode
      Title="pnp:ReplaceableString"
      Url="pnp:ReplaceableString"
      IsExternal="xsd:boolean">
   <pnp:NavigationNode />
</pnp:NavigationNode>

Here follow the available child elements for the NavigationNode element.

Element	Type	Description
NavigationNode	NavigationNode

Here follow the available attributes for the NavigationNode element.

Attibute	Type	Description	Required	Default
Title	ReplaceableString	Defines the Title of a Navigation Node for the Structural Navigation of a site.	Yes
Url	ReplaceableString	Defines the Url of a Navigation Node for the Structural Navigation of a site.	No
IsExternal	xsd:boolean	Defines whether the Navigation Node for the Structural Navigation targets an External resource.	No	false

Features

The Features (Site or Web) to activate or deactivate while applying the Provisioning Template, optional collection of elements.

<pnp:Features>
   <pnp:SiteFeatures />
   <pnp:WebFeatures />
</pnp:Features>

Here follow the available child elements for the Features element.

Element	Type	Description
SiteFeatures	FeaturesList	The Site Features to activate or deactivate while applying the Provisioning Template, optional collection of elements.
WebFeatures	FeaturesList	The Web Features to activate or deactivate while applying the Provisioning Template, optional collection of elements.

CustomActions

The Custom Actions (Site or Web) to provision with the Provisioning Template, optional element.

<pnp:CustomActions>
   <pnp:SiteCustomActions />
   <pnp:WebCustomActions />
</pnp:CustomActions>

Here follow the available child elements for the CustomActions element.

Element	Type	Description
SiteCustomActions	CustomActionsList	The Site Custom Actions to provision while applying the Provisioning Template, optional collection of elements.
WebCustomActions	CustomActionsList	The Web Custom Actions to provision while applying the Provisioning Template, optional collection of elements.

Pages

The Pages to provision into the target Site through the Provisioning Template, optional collection of elements.

<pnp:Pages>
   <pnp:Page />
</pnp:Pages>

Here follow the available child elements for the Pages element.

Element	Type	Description
Page	Page

PropertyBagEntry

The Property Bag Entry of the Provisioning Template.

<pnp:PropertyBagEntry
      Overwrite="xsd:boolean"
      Indexed="xsd:boolean">
</pnp:PropertyBagEntry>

Here follow the available attributes for the PropertyBagEntry element.

Attibute	Type	Description	Required	Default
Overwrite	xsd:boolean	Declares whether the Property Bag Entry has to overwrite an already existing entry, optional attribute.	No
Indexed	xsd:boolean	Declares whether the Property Bag Entry has to be indexed, optional attribute.	No	false

StringDictionaryItem

Defines a StringDictionary element.

<pnp:StringDictionaryItem
      Key="xsd:string"
      Value="xsd:string">
</pnp:StringDictionaryItem>

Here follow the available attributes for the StringDictionaryItem element.

Attibute	Type	Description	Required
Key	xsd:string	The Key of the property to store in the StringDictionary, required attribute.	Yes
Value	xsd:string	The Value of the property to store in the StringDictionary, required attribute.	Yes

UsersList

List of Users for the Site Security, collection of elements.

<pnp:UsersList
      ClearExistingItems="xsd:boolean">
   <pnp:User />
</pnp:UsersList>

Here follow the available child elements for the UsersList element.

Element	Type	Description
User	User

Here follow the available attributes for the UsersList element.

Attibute	Type	Description	Required	Default
ClearExistingItems	xsd:boolean	Declares whether to clear existing users before adding new users, optional attribute.	No	false

User

The base type for a User element.

<pnp:User
      Name="xsd:string">
</pnp:User>

Here follow the available attributes for the User element.

Attibute	Type	Description	Required	Default
Name	xsd:string	The Name of the User, required attribute.	Yes

SiteGroups

List of Site Groups for the Site Security, collection of elements.

<pnp:SiteGroups>
   <pnp:SiteGroup />
</pnp:SiteGroups>

Here follow the available child elements for the SiteGroups element.

Element	Type	Description
SiteGroup	SiteGroup

SiteGroup

The base type for a Site Group element.

<pnp:SiteGroup
      Title="xsd:string"
      Description="xsd:string"
      Owner="xsd:string"
      AllowMembersEditMembership="xsd:boolean"
      AllowRequestToJoinLeave="xsd:boolean"
      AutoAcceptRequestToJoinLeave="xsd:boolean"
      OnlyAllowMembersViewMembership="xsd:boolean"
      RequestToJoinLeaveEmailSetting="xsd:string">
   <pnp:Members />
</pnp:SiteGroup>

Here follow the available child elements for the SiteGroup element.

Element	Type	Description
Members	UsersList	The list of members of the Site Group, optional element.

Here follow the available attributes for the SiteGroup element.

Attibute	Type	Description	Required
Title	xsd:string	The Title of the Site Group, required attribute.	Yes
Description	xsd:string	The Description of the Site Group, optional attribute.	No
Owner	xsd:string	The Owner of the Site Group, optional attribute. If not specified SharePoint will assign the user provisioning the schema as the group owner when creating a new group.	No
AllowMembersEditMembership	xsd:boolean	Defines whether the members can edit membership of the Site Group, optional attribute.	No
AllowRequestToJoinLeave	xsd:boolean	Defines whether to allow requests to join or leave the Site Group, optional attribute.	No
AutoAcceptRequestToJoinLeave	xsd:boolean	Defines whether to auto-accept requests to join or leave the Site Group, optional attribute.	No
OnlyAllowMembersViewMembership	xsd:boolean	Defines whether to allow members only to view the membership of the Site Group, optional attribute.	No
RequestToJoinLeaveEmailSetting	xsd:string	Defines the email address used for membership requests to join or leave will be sent for the Site Group, optional attribute.	No

RoleDefinitions

List of Role Definitions for a target RoleAssignment, collection of elements.

<pnp:RoleDefinitions>
   <pnp:RoleDefinition />
</pnp:RoleDefinitions>

Here follow the available child elements for the RoleDefinitions element.

Element	Type	Description
RoleDefinition	RoleDefinition

RoleDefinition

<pnp:RoleDefinition
      Name="xsd:string"
      Description="xsd:string">
   <pnp:Permissions />
</pnp:RoleDefinition>

Here follow the available child elements for the RoleDefinition element.

Element	Type	Description
Permissions	Permissions	Defines the Permissions of the Role Definition, required element.

Here follow the available attributes for the RoleDefinition element.

Attibute	Type	Description	Required
Name	xsd:string	Defines the Name of the Role Definition, required attribute.	Yes
Description	xsd:string	Defines the Description of the Role Definition, optional attribute.	No

Permissions

Defines the Permissions of the Role Definition, required element.

<pnp:Permissions>
   <pnp:Permission />
</pnp:Permissions>

Here follow the available child elements for the element.

Element	Type	Description
Permission	Permission	Defines a Permission for a Role Definition.

RoleAssignments

List of Role Assignments for a target Principal, collection of elements.

<pnp:RoleAssignments>
   <pnp:RoleAssignment />
</pnp:RoleAssignments>

Here follow the available child elements for the RoleAssignments element.

Element	Type	Description
RoleAssignment	RoleAssignment

RoleAssignment

<pnp:RoleAssignment
      Principal="xsd:string"
      RoleDefinition="xsd:string"
      Remove="xsd:boolean">
</pnp:RoleAssignment>

Here follow the available attributes for the RoleAssignment element.

Attibute	Type	Description	Required	Default
Principal	xsd:string	Defines the Role to which the assignment will apply, required attribute.	Yes
RoleDefinition	xsd:string	Defines the Role to which the assignment will apply, required attribute.	Yes
Remove	xsd:boolean	Allows to remove a role assignment, instead of adding it. It is an optional attribute, and by default it assumes a value of false.	No	false

ObjectSecurity

Defines a set of Role Assignments for specific principals.

<pnp:ObjectSecurity>
   <pnp:BreakRoleInheritance />
</pnp:ObjectSecurity>

Here follow the available child elements for the ObjectSecurity element.

Element	Type	Description
BreakRoleInheritance	BreakRoleInheritance

BreakRoleInheritance

Declares a section of custom permissions, breaking role inheritance from parent.

<pnp:BreakRoleInheritance
      CopyRoleAssignments="xsd:boolean"
      ClearSubscopes="xsd:boolean">
   <pnp:RoleAssignment />
</pnp:BreakRoleInheritance>

Here follow the available child elements for the element.

Element	Type	Description
RoleAssignment	RoleAssignment

Here follow the available attributes for the element.

Attibute	Type	Description	Required
CopyRoleAssignments	xsd:boolean	Defines whether to copy role assignments or not while breaking role inheritance, required attribute.	Yes
ClearSubscopes	xsd:boolean	Defines whether to clear subscopes or not while breaking role inheritance, required attribute.	Yes

ListInstance

Defines a ListInstance element

<pnp:ListInstance
      Title="xsd:string"
      Description="xsd:string"
      DocumentTemplate="xsd:string"
      OnQuickLaunch="xsd:boolean"
      TemplateType="xsd:int"
      Url="xsd:string"
      ForceCheckout="xsd:boolean"
      EnableVersioning="xsd:boolean"
      EnableMinorVersions="xsd:boolean"
      EnableModeration="xsd:boolean"
      MinorVersionLimit="xsd:int"
      MaxVersionLimit="xsd:int"
      DraftVersionVisibility="xsd:int"
      RemoveExistingContentTypes="xsd:boolean"
      TemplateFeatureID="pnp:GUID"
      ContentTypesEnabled="xsd:boolean"
      Hidden="xsd:boolean"
      EnableAttachments="xsd:boolean"
      EnableFolderCreation="xsd:boolean"
      NoCrawl="xsd:boolean"
      ListExperience=""
      DefaultDisplayFormUrl="xsd:string"
      DefaultEditFormUrl="xsd:string"
      DefaultNewFormUrl="xsd:string"
      Direction=""
      ImageUrl="xsd:string"
      IrmExpire="xsd:boolean"
      IrmReject="xsd:boolean"
      IsApplicationList="xsd:boolean"
      ReadSecurity="xsd:int"
      WriteSecurity="xsd:int"
      ValidationFormula="xsd:string"
      ValidationMessage="xsd:string"
      TemplateInternalName="xsd:string">
   <pnp:DefaultColumnValues />
   <pnp:PropertyBagEntries />
   <pnp:ContentTypeBindings />
   <pnp:Views />
   <pnp:Fields />
   <pnp:FieldRefs />
   <pnp:DataRows />
   <pnp:Folders />
   <pnp:FieldDefaults />
   <pnp:Security />
   <pnp:UserCustomActions />
   <pnp:Webhooks />
   <pnp:IRMSettings />
   <pnp:DataSource />
</pnp:ListInstance>

Here follow the available child elements for the ListInstance element.

Element	Type	Description
DefaultColumnValues	DefaultColumnValues	The Default Columne Values entries of the Folder, optional collection of elements.
PropertyBagEntries	PropertyBagEntries	The Property Bag entries of the root folder, optional collection of elements.
ContentTypeBindings	ContentTypeBindings	The ContentTypeBindings entries of the List Instance, optional collection of elements.
Views	Views	The Views entries of the List Instance, optional collection of elements.
Fields	Fields	The Fields entries of the List Instance, optional collection of elements.
FieldRefs	FieldRefs	The FieldRefs entries of the List Instance, optional collection of elements.
DataRows	DataRows	Defines a collection of rows that will be added to the List Instance, optional element.
Folders	Folders	Defines a collection of folders (eventually nested) that will be provisioned into the target list/library, optional element.
FieldDefaults	FieldDefaults	Defines a list of default values for the Fields of the List Instance, optional collection of elements.
Security	ObjectSecurity	Defines the Security rules for the List Instance, optional element.
UserCustomActions	CustomActionsList	Defines any Custom Action for the List Instance, optional element.
Webhooks	WebhooksList	Defines any Webhook for the current list instance.
IRMSettings	IRMSettings	Declares the Information Rights Management settings for the list or library.
DataSource	DataSource	Allows defining the Data Source for an external list, optional element.

Here follow the available attributes for the ListInstance element.

Attibute	Type	Description	Required	Default
Title	xsd:string	The Title of the List Instance, required attribute.	Yes
Description	xsd:string	The Description of the List Instance, optional attribute.	No
DocumentTemplate	xsd:string	The DocumentTemplate of the List Instance, optional attribute.	No
OnQuickLaunch	xsd:boolean	The OnQuickLaunch flag for the List Instance, optional attribute.	No	false
TemplateType	xsd:int	The TemplateType of the List Instance, required attribute. Values available here: https://msdn.microsoft.com/en-us/library/office/microsoft.sharepoint.client.listtemplatetype.aspx	Yes
Url	xsd:string	The Url of the List Instance, required attribute.	Yes
ForceCheckout	xsd:boolean	The ForceCheckout flag for the List Instance, optional attribute.	No	false
EnableVersioning	xsd:boolean	The EnableVersioning flag for the List Instance, optional attribute.	No	false
EnableMinorVersions	xsd:boolean	The EnableMinorVersions flag for the List Instance, optional attribute.	No	false
EnableModeration	xsd:boolean	The EnableModeration flag for the List Instance, optional attribute.	No	false
MinorVersionLimit	xsd:int	The MinorVersionLimit for versions history for the List Instance, optional attribute.	No
MaxVersionLimit	xsd:int	The MaxVersionLimit for versions history for the List Instance, optional attribute.	No
DraftVersionVisibility	xsd:int	The DraftVersionVisibility for the List Instance, optional attribute. The property will be cast to enum DraftVersionVisibility 0 - Reader - Any user who can read items, 1 - Author - Only users who can edit items, 2 - Approver - Only users who can approve items (and the author of the item)	No
RemoveExistingContentTypes	xsd:boolean	The RemoveExistingContentTypes flag for the List Instance, optional attribute.	No	false
TemplateFeatureID	GUID	The TemplateFeatureID for the feature on which the List Instance is based, optional attribute.	No
ContentTypesEnabled	xsd:boolean	The ContentTypesEnabled flag for the List Instance, optional attribute.	No	false
Hidden	xsd:boolean	The Hidden flag for the List Instance, optional attribute.	No	false
EnableAttachments	xsd:boolean	The EnableAttachments flag for the List Instance, optional attribute.	No	true
EnableFolderCreation	xsd:boolean	The EnableFolderCreation flag for the List Instance, optional attribute.	No	true
NoCrawl	xsd:boolean	Defines if the current list or library has to be included in crawling, optional attribute.	No	false
ListExperience		Defines the current list UI/UX experience (valid for SPO only).	No	Auto
DefaultDisplayFormUrl	xsd:string	Defines a value that specifies the location of the default display form for the list.	No
DefaultEditFormUrl	xsd:string	Defines a value that specifies the URL of the edit form to use for list items in the list.	No
DefaultNewFormUrl	xsd:string	Defines a value that specifies the location of the default new form for the list.	No
Direction		Defines a value that specifies the reading order of the list.	No	NONE
ImageUrl	xsd:string	Defines a value that specifies the URI for the icon of the list, optional attribute.	No
IrmExpire	xsd:boolean	Defines if IRM Expire property, optional attribute.	No
IrmReject	xsd:boolean	Defines the IRM Reject property, optional attribute.	No
IsApplicationList	xsd:boolean	Defines a value that specifies a flag that a client application can use to determine whether to display the list, optional attribute.	No
ReadSecurity	xsd:int	Defines the Read Security property, optional attribute.	No	1
WriteSecurity	xsd:int	Defines the Write Security property, optional attribute.	No	1
ValidationFormula	xsd:string	Defines a value that specifies the data validation criteria for a list item, optional attribute.	No
ValidationMessage	xsd:string	Defines a value that specifies the error message returned when data validation fails for a list item, optional attribute.	No
TemplateInternalName	xsd:string	Defines the alternate template internal name for a list based on a .STP file/list definition.	No

DefaultColumnValues

The Default Columne Values entries of the Folder, optional collection of elements.

<pnp:DefaultColumnValues>
   <pnp:DefaultColumnValue />
</pnp:DefaultColumnValues>

Here follow the available child elements for the element.

Element	Type	Description
DefaultColumnValue	StringDictionaryItem	A custom Default Column Value for the Provisioning Template, collection of elements.

ContentTypeBindings

The ContentTypeBindings entries of the List Instance, optional collection of elements.

<pnp:ContentTypeBindings>
   <pnp:ContentTypeBinding />
</pnp:ContentTypeBindings>

Here follow the available child elements for the element.

Element	Type	Description
ContentTypeBinding	ContentTypeBinding

Views

The Views entries of the List Instance, optional collection of elements.

<pnp:Views
      RemoveExistingViews="xsd:boolean">
   <!-- Any other XML content -->
</pnp:Views>

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
RemoveExistingViews	xsd:boolean	A flag to declare if the existing views of the List Instance have to be removed, before adding the custom views, optional attribute.	No	false

Fields

The Fields entries of the List Instance, optional collection of elements.

<pnp:Fields>
   <!-- Any other XML content -->
</pnp:Fields>

FieldRefs

The FieldRefs entries of the List Instance, optional collection of elements.

<pnp:FieldRefs>
   <pnp:FieldRef />
</pnp:FieldRefs>

Here follow the available child elements for the element.

Element	Type	Description
FieldRef	ListInstanceFieldRef

DataRows

Defines a collection of rows that will be added to the List Instance, optional element.

<pnp:DataRows
      KeyColumn="xsd:string"
      UpdateBehavior="">
   <pnp:DataRow />
</pnp:DataRows>

Here follow the available child elements for the element.

Element	Type	Description
DataRow	DataRow

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
KeyColumn	xsd:string	Optional attribute to declare the name of the Key Column, if any, used to identify any already existing DataRows. If this attribute has a value and the target list already has items with matching KeyColumn values, the engine will handle the matching DataRows based on the value of the UpdateBehavior attribute. If UpdateBehavior has a value of Skip, the DataRows will be skipped. If UpdateBehavior has a value of Overwrite, the existing items will be updated with the values defined in the DataRows.	No
UpdateBehavior		If the DataRow already exists on target list, this attribute defines whether the DataRow will be overwritten or skipped.	No	Skip

Folders

Defines a collection of folders (eventually nested) that will be provisioned into the target list/library, optional element.

<pnp:Folders>
   <pnp:Folder />
</pnp:Folders>

Here follow the available child elements for the element.

Element	Type	Description
Folder	Folder

FieldDefaults

Defines a list of default values for the Fields of the List Instance, optional collection of elements.

<pnp:FieldDefaults>
   <pnp:FieldDefault />
</pnp:FieldDefaults>

Here follow the available child elements for the element.

Element	Type	Description
FieldDefault	FieldDefault	Defines a default value for a Field of the List Instance.

DataSource

Allows defining the Data Source for an external list, optional element.

<pnp:DataSource>
   <pnp:DataSourceItem />
</pnp:DataSource>

Here follow the available child elements for the element.

Element	Type	Description
DataSourceItem	StringDictionaryItem	A single data source property for an external list.

IRMSettings

Declares the Information Rights Management settings for the list or library.

<pnp:IRMSettings
      Enabled="xsd:boolean"
      AllowPrint="xsd:boolean"
      AllowScript="xsd:boolean"
      AllowWriteCopy="xsd:boolean"
      DisableDocumentBrowserView="xsd:boolean"
      DocumentAccessExpireDays="xsd:int"
      DocumentLibraryProtectionExpiresInDays="pnp:ReplaceableInt"
      EnableDocumentAccessExpire="xsd:boolean"
      EnableDocumentBrowserPublishingView="xsd:boolean"
      EnableGroupProtection="xsd:boolean"
      EnableLicenseCacheExpire="xsd:boolean"
      GroupName="xsd:string"
      LicenseCacheExpireDays="xsd:int"
      PolicyDescription="xsd:string"
      PolicyTitle="xsd:string">
</pnp:IRMSettings>

Here follow the available attributes for the IRMSettings element.

Attibute	Type	Description	Required	Default
Enabled	xsd:boolean	Defines whether the IRM settings have to be enabled or not.	Yes
AllowPrint	xsd:boolean	Defines whether a viewer can print the downloaded document.	No	true
AllowScript	xsd:boolean	Defines whether a viewer can run a script on the downloaded document.	No	true
AllowWriteCopy	xsd:boolean	Defines whether a viewer can write on a copy of the downloaded document.	No	true
DisableDocumentBrowserView	xsd:boolean	Defines whether to block Office Web Application Companion applications (WACs) from showing this document.	No	true
DocumentAccessExpireDays	xsd:int	Defines the number of days after which the downloaded document will expire.	No
DocumentLibraryProtectionExpiresInDays	ReplaceableInt	Defines the expire days for the Information Rights Management (IRM) protection of this document library will expire.	No
EnableDocumentAccessExpire	xsd:boolean	Defines whether the downloaded document will expire.	No	false
EnableDocumentBrowserPublishingView	xsd:boolean	Defines whether to enable Office Web Application Companion applications (WACs) to publishing view.	No	true
EnableGroupProtection	xsd:boolean	Defines whether the permission of the downloaded document is applicable to a group.	No	true
EnableLicenseCacheExpire	xsd:boolean	Defines whether a user must verify their credentials after some interval.	No	false
GroupName	xsd:string	Defines the group name (email address) that the permission is also applicable to.	No
LicenseCacheExpireDays	xsd:int	Defines the number of days that the application that opens the document caches the IRM license. When these elapse, the application will connect to the IRM server to validate the license.	No
PolicyDescription	xsd:string	Defines the permission policy description.	No
PolicyTitle	xsd:string	Defines the permission policy title.	No

Folder

Defines a folder that will be provisioned into the target list/library.

<pnp:Folder
      Name="xsd:string"
      ContentTypeID="pnp:ContentTypeId">
   <pnp:Folder />
   <pnp:Security />
   <pnp:PropertyBagEntries />
   <pnp:DefaultColumnValues />
   <pnp:Properties />
</pnp:Folder>

Here follow the available child elements for the Folder element.

Element	Type	Description
Folder	Folder	A child Folder of another Folder item, optional element.
Security	ObjectSecurity	Defines the security rules for the row that will be added to the List Instance, optional element.
PropertyBagEntries	PropertyBagEntries	The Property Bag entries of the Folder, optional collection of elements.
DefaultColumnValues	DefaultColumnValues	The Default Columne Values entries of the Folder, optional collection of elements.
Properties	FileProperties	The File Properties for the Folder, optional collection of elements.

Here follow the available attributes for the Folder element.

Attibute	Type	Description	Required
Name	xsd:string	The Name of the Folder, required attribute.	Yes
ContentTypeID	ContentTypeId	The Content Type ID for the Folder, optional attribute.	No

DefaultColumnValues

The Default Columne Values entries of the Folder, optional collection of elements.

<pnp:DefaultColumnValues>
   <pnp:DefaultColumnValue />
</pnp:DefaultColumnValues>

Here follow the available child elements for the element.

Element	Type	Description
DefaultColumnValue	StringDictionaryItem	A custom Default Column Value for the Provisioning Template, collection of elements.

DataValue

The DataValue of a single field of a row to insert into a target ListInstance.

<pnp:DataValue>
</pnp:DataValue>

FieldDefault

The FieldDefault of a single field of list or library for target ListInstance.

<pnp:FieldDefault>
</pnp:FieldDefault>

ContentType

Defines a Content Type.

<pnp:ContentType
      ID="pnp:ContentTypeId"
      Name="xsd:string"
      Description="xsd:string"
      Group="xsd:string"
      Hidden="xsd:boolean"
      Sealed="xsd:boolean"
      ReadOnly="xsd:boolean"
      Overwrite="xsd:boolean"
      NewFormUrl="xsd:string"
      EditFormUrl="xsd:string"
      DisplayFormUrl="xsd:string"
      UpdateChildren="xsd:boolean">
   <pnp:FieldRefs />
   <pnp:DocumentTemplate />
   <pnp:DocumentSetTemplate />
</pnp:ContentType>

Here follow the available child elements for the ContentType element.

Element	Type	Description
FieldRefs	FieldRefs	The FieldRefs entries of the List Instance, optional collection of elements.
DocumentTemplate	DocumentTemplate	Specifies the document template for the content type. This is the file which SharePoint Foundation opens as a template when a user requests a new item of this content type.
DocumentSetTemplate	DocumentSetTemplate	Specifies the properties of the DocumentSet Template if the ContentType defines a DocumentSet.

Here follow the available attributes for the ContentType element.

Attibute	Type	Description	Required	Default
ID	ContentTypeId	The value of the Content Type ID, required attribute.	Yes
Name	xsd:string	The Name of the Content Type, required attribute.	Yes
Description	xsd:string	The Description of the Content Type, optional attribute.	No
Group	xsd:string	The Group of the Content Type, optional attribute.	No
Hidden	xsd:boolean	Optional Boolean. True to define the content type as hidden. If you define a content type as hidden, SharePoint Foundation does not display that content type on the New button in list views.	No	false
Sealed	xsd:boolean	Optional Boolean. True to prevent changes to this content type. You cannot change the value of this attribute through the user interface, but you can change it in code if you have sufficient rights. You must have site collection administrator rights to unseal a content type.	No	false
ReadOnly	xsd:boolean	Optional Boolean. TRUE to specify that the content type cannot be edited without explicitly removing the read-only setting. This can be done either in the user interface or in code.	No	false
Overwrite	xsd:boolean	Optional Boolean. TRUE to overwrite an existing content type with the same ID.	No	false
NewFormUrl	xsd:string	Specifies the URL of a custom new form to use for list items that have been assigned the content type, optional attribute.	No
EditFormUrl	xsd:string	Specifies the URL of a custom edit form to use for list items that have been assigned the content type, optional attribute.	No
DisplayFormUrl	xsd:string	Specifies the URL of a custom display form to use for list items that have been assigned the content type, optional attribute.	No
UpdateChildren	xsd:boolean	Declares whether changes to the content type will be udpated on inherited content types, optional attribute, default true.	No	true

FieldRefs

The FieldRefs entries of the List Instance, optional collection of elements.

<pnp:FieldRefs>
   <pnp:FieldRef />
</pnp:FieldRefs>

Here follow the available child elements for the element.

Element	Type	Description
FieldRef	ContentTypeFieldRef

DocumentTemplate

Specifies the document template for the content type. This is the file which SharePoint Foundation opens as a template when a user requests a new item of this content type.

<pnp:DocumentTemplate
      TargetName="xsd:string">
</pnp:DocumentTemplate>

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
TargetName	xsd:string	The value of the Content Type ID, required attribute.	Yes

ContentTypeBinding

Defines the binding between a ListInstance and a ContentType.

<pnp:ContentTypeBinding
      ContentTypeID="pnp:ContentTypeId"
      Default="xsd:boolean"
      Remove="xsd:boolean"
      Hidden="xsd:boolean">
</pnp:ContentTypeBinding>

Here follow the available attributes for the ContentTypeBinding element.

Attibute	Type	Description	Required	Default
ContentTypeID	ContentTypeId	The value of the Content Type ID to bind, required attribute.	Yes
Default	xsd:boolean	Declares if the Content Type should be the default Content Type in the list or library, optional attribute.	No	false
Remove	xsd:boolean	Declares if the Content Type should be Removed from the list or library, optional attribute.	No	false
Hidden	xsd:boolean	Declares if the Content Type should be Hidden from New button of the list or library, optional attribute.	No	false

DocumentSetTemplate

Defines a DocumentSet Template for creating multiple DocumentSet instances.

<pnp:DocumentSetTemplate
      WelcomePage="xsd:string"
      UpdateChildren="xsd:boolean">
   <pnp:AllowedContentTypes />
   <pnp:DefaultDocuments />
   <pnp:SharedFields />
   <pnp:WelcomePageFields />
   <pnp:XmlDocuments />
</pnp:DocumentSetTemplate>

Here follow the available child elements for the DocumentSetTemplate element.

Element	Type	Description
AllowedContentTypes	AllowedContentTypes
DefaultDocuments	DefaultDocuments
SharedFields	SharedFields
WelcomePageFields	WelcomePageFields
XmlDocuments	XmlDocuments	Defines any custom XmlDocument section for the DocumentSet, it is optional.

Here follow the available attributes for the DocumentSetTemplate element.

Attibute	Type	Description	Required	Default
WelcomePage	xsd:string	Defines the custom WelcomePage for the Document Set, optional attribute.	No
UpdateChildren	xsd:boolean	Declares whether changes to the content type will be udpated on inherited content types, optional attribute, default true.	No	true

AllowedContentTypes

The list of allowed Content Types for the Document Set, optional element.

<pnp:AllowedContentTypes
      RemoveExistingContentTypes="xsd:boolean">
   <pnp:AllowedContentType />
</pnp:AllowedContentTypes>

Here follow the available child elements for the element.

Element	Type	Description
AllowedContentType	AllowedContentType

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
RemoveExistingContentTypes	xsd:boolean	The RemoveExistingContentTypes flag for the Allowed Content Types of the current Document Set, optional attribute.	No	false

DefaultDocuments

The list of default Documents for the Document Set, optional element.

<pnp:DefaultDocuments>
   <pnp:DefaultDocument />
</pnp:DefaultDocuments>

Here follow the available child elements for the element.

Element	Type	Description
DefaultDocument	DefaultDocument

SharedFields

The list of Shared Fields for the Document Set, optional element.

<pnp:SharedFields>
   <pnp:SharedField />
</pnp:SharedFields>

Here follow the available child elements for the element.

Element	Type	Description
SharedField	DocumentSetFieldRef

WelcomePageFields

The list of Welcome Page Fields for the Document Set, optional element.

<pnp:WelcomePageFields>
   <pnp:WelcomePageField />
</pnp:WelcomePageFields>

Here follow the available child elements for the element.

Element	Type	Description
WelcomePageField	DocumentSetFieldRef

XmlDocuments

Defines any custom XmlDocument section for the DocumentSet, it is optional.

<pnp:XmlDocuments>
   <!-- Any other XML content -->
</pnp:XmlDocuments>

FeaturesList

Defines a collection of elements of type Feature.

<pnp:FeaturesList>
   <pnp:Feature />
</pnp:FeaturesList>

Here follow the available child elements for the FeaturesList element.

Element	Type	Description
Feature	Feature

Feature

Defines a single Site or Web Feature, which will be activated or deactivated while applying the Provisioning Template.

<pnp:Feature
      ID="pnp:GUID"
      Deactivate="xsd:boolean"
      Description="xsd:string">
</pnp:Feature>

Here follow the available attributes for the Feature element.

Attibute	Type	Description	Required	Default
ID	GUID	The unique ID of the Feature, required attribute.	Yes
Deactivate	xsd:boolean	Defines if the feature has to be deactivated or activated while applying the Provisioning Template, optional attribute.	No	false
Description	xsd:string	The Description of the feature, optional attribute.	No

FieldRefBase

<pnp:FieldRefBase
      ID="pnp:ReplaceableString">
</pnp:FieldRefBase>

Here follow the available attributes for the FieldRefBase element.

Attibute	Type	Description	Required	Default
ID	ReplaceableString	The value of the field ID to bind, required attribute.	Yes

FieldRefFull

<pnp:FieldRefFull>
</pnp:FieldRefFull>

ListInstanceFieldRef

Defines the binding between a ListInstance and a Field.

<pnp:ListInstanceFieldRef
      DisplayName="xsd:string"
      Remove="xsd:boolean">
</pnp:ListInstanceFieldRef>

Here follow the available attributes for the ListInstanceFieldRef element.

Attibute	Type	Description	Required	Default
DisplayName	xsd:string	The display name of the field to bind, only applicable to fields that will be added to lists, optional attribute.	Yes
Remove	xsd:boolean	Declares if the FieldRef should be Removed from the list or library, optional attribute.	No	false

ContentTypeFieldRef

Defines the binding between a ContentType and a Field.

<pnp:ContentTypeFieldRef
      UpdateChildren="xsd:boolean">
</pnp:ContentTypeFieldRef>

Here follow the available attributes for the ContentTypeFieldRef element.

Attibute	Type	Description	Required	Default
UpdateChildren	xsd:boolean	Declares whether the current field reference has to be udpated on inherited content types, optional attribute.	No

DocumentSetFieldRef

Defines the binding between a Document Set and a Field.

<pnp:DocumentSetFieldRef
      Name="xsd:string"
      Remove="xsd:boolean">
</pnp:DocumentSetFieldRef>

Here follow the available attributes for the DocumentSetFieldRef element.

Attibute	Type	Description	Required	Default
Name	xsd:string	The name of the field used in the field reference. This is for reference/readibility only. Optional attribute.	No
Remove	xsd:boolean	Declares if the field should be Removed from the field reference, optional attribute.	No	false

CustomActionsList

Defines a collection of elements of type CustomAction.

<pnp:CustomActionsList>
   <pnp:CustomAction />
</pnp:CustomActionsList>

Here follow the available child elements for the CustomActionsList element.

Element	Type	Description
CustomAction	CustomAction

CustomAction

Defines a Custom Action, which will be provisioned while applying the Provisioning Template.

<pnp:CustomAction
      Name="xsd:string"
      Description="xsd:string"
      Group="xsd:string"
      Location="xsd:string"
      Title="xsd:string"
      Sequence="xsd:int"
      Rights="xsd:string"
      Url="xsd:string"
      Enabled="xsd:boolean"
      Remove="xsd:boolean"
      ScriptBlock="xsd:string"
      ImageUrl="xsd:string"
      ScriptSrc="xsd:string"
      RegistrationId="xsd:string"
      RegistrationType="pnp:RegistrationType"
      ClientSideComponentId="xsd:string"
      ClientSideComponentProperties="xsd:string"
      ClientSideHostProperties="xsd:string">
   <pnp:CommandUIExtension />
</pnp:CustomAction>

Here follow the available child elements for the CustomAction element.

Element	Type	Description
CommandUIExtension	CommandUIExtension	Defines the Custom UI Extension XML, optional element.

Here follow the available attributes for the CustomAction element.

Attibute	Type	Description	Required	Default
Name	xsd:string	The Name of the CustomAction, required attribute.	Yes
Description	xsd:string	The Description of the CustomAction, optional attribute.	No
Group	xsd:string	The Group of the CustomAction, optional attribute.	No
Location	xsd:string	The Location of the CustomAction, required attribute.	Yes
Title	xsd:string	The Title of the CustomAction, required attribute.	No
Sequence	xsd:int	The Sequence of the CustomAction, optional attribute.	No
Rights	xsd:string	The Rights for the CustomAction, based on values from Microsoft.SharePoint.Client.PermissionKind, optional attribute.	No
Url	xsd:string	The URL of the CustomAction, optional attribute.	No
Enabled	xsd:boolean	The Enabled flag for the CustomAction, optional attribute.	No	true
Remove	xsd:boolean	To Remove a CustomAction, optional attribute.	No	false
ScriptBlock	xsd:string	The ScriptBlock of the CustomAction, optional attribute.	No
ImageUrl	xsd:string	The ImageUrl of the CustomAction, optional attribute.	No
ScriptSrc	xsd:string	The ScriptSrc of the CustomAction, optional attribute.	No
RegistrationId	xsd:string	The RegistrationId of the CustomAction, optional attribute.	No
RegistrationType	RegistrationType	The RegistrationType of the CustomAction, optional attribute.	No
ClientSideComponentId	xsd:string	The Client-Side Component Id of a customizer, optional attribute.	No
ClientSideComponentProperties	xsd:string	The Client-Side Component Properties of a customizer, optional attribute.	No
ClientSideHostProperties	xsd:string	The Client Side Host Properties of a customizer, optional attribute.	No

CommandUIExtension

Defines the Custom UI Extension XML, optional element.

<pnp:CommandUIExtension>
   <!-- Any other XML content -->
</pnp:CommandUIExtension>

SiteWebhooksList

Defines a collection of elements of type SiteWebhook.

<pnp:SiteWebhooksList>
   <pnp:Webhook />
</pnp:SiteWebhooksList>

Here follow the available child elements for the SiteWebhooksList element.

Element	Type	Description
Webhook	SiteWebhook

WebhooksList

Defines a collection of elements of type Webhook.

<pnp:WebhooksList>
   <pnp:Webhook />
</pnp:WebhooksList>

Here follow the available child elements for the WebhooksList element.

Element	Type	Description
Webhook	Webhook

Webhook

Defines a single element of type Webhook.

<pnp:Webhook
      ServerNotificationUrl="pnp:ReplaceableString"
      ExpiresInDays="pnp:ReplaceableInt"
      ClientState="pnp:ReplaceableString">
</pnp:Webhook>

Here follow the available attributes for the Webhook element.

Attibute	Type	Description	Required
ServerNotificationUrl	ReplaceableString	The Server Notification URL of the Webhook, required attribute.	Yes
ExpiresInDays	ReplaceableInt	The expire days for the subscription of the Webhook, required attribute.	Yes
ClientState	ReplaceableString	An opaque string passed back to the client on all notifications, optional attribute.	No

SiteWebhook

Defines a single element of type SiteWebhook.

<pnp:SiteWebhook
      SiteWebhookType="">
</pnp:SiteWebhook>

Here follow the available attributes for the SiteWebhook element.

Attibute	Type	Description	Required	Default
SiteWebhookType			Yes

ClientSidePages

Defines a collection of elements of type ClientSidePage.

<pnp:ClientSidePages>
   <pnp:ClientSidePage />
</pnp:ClientSidePages>

Here follow the available child elements for the ClientSidePages element.

Element	Type	Description
ClientSidePage	ClientSidePage

BaseClientSidePage

Defines a base Client Side Page.

<pnp:BaseClientSidePage
      PromoteAsNewsArticle="xsd:boolean"
      PromoteAsTemplate="xsd:boolean"
      Overwrite="xsd:boolean"
      Layout="xsd:string"
      Publish="xsd:boolean"
      EnableComments="xsd:boolean"
      Title="xsd:string"
      ContentTypeID="pnp:ReplaceableString"
      ThumbnailUrl="pnp:ReplaceableString">
   <pnp:Header />
   <pnp:Sections />
   <pnp:FieldValues />
   <pnp:Security />
   <pnp:Properties />
</pnp:BaseClientSidePage>

Here follow the available child elements for the BaseClientSidePage element.

Element	Type	Description
Header	Header	Defines the layout of the Header for the current client side page
Sections	Sections	Defines the Canvas sections for a single ClientSidePage.
FieldValues	FieldValues	Defines the page fields values, if any.
Security	ObjectSecurity
Properties	Properties	Defines property bag properties for the client side page, optional element.

Here follow the available attributes for the BaseClientSidePage element.

Attibute	Type	Description	Required	Default
PromoteAsNewsArticle	xsd:boolean	Declares to promote the page as a news article.	No
PromoteAsTemplate	xsd:boolean	Declares to promote the page as a page template.	No
Overwrite	xsd:boolean	Can the page be overwritten if it exists.	No
Layout	xsd:string	Defines the target layout for the client-side page, optional attribute (default: Article).	No	Article
Publish	xsd:boolean	Defines whether the page will be published or not, optional attribute (default: true).	No	true
EnableComments	xsd:boolean	Defines whether the page will have comments enabled or not, optional attribute (default: true).	No	true
Title	xsd:string	Defines the Title of the page, optional attribute.	No
ContentTypeID	ReplaceableString	Defines the Content Type ID for the page, optional attribute.	No
ThumbnailUrl	ReplaceableString	Defines the URL of the thumbnail for the client side page, optional attribute.	No

Header

Defines the layout of the Header for the current client side page

<pnp:Header
      Type=""
      ServerRelativeImageUrl="xsd:string"
      TranslateX="xsd:double"
      TranslateY="xsd:double"
      LayoutType=""
      TextAlignment=""
      ShowTopicHeader="xsd:boolean"
      ShowPublishDate="xsd:boolean"
      TopicHeader="xsd:string"
      AlternativeText="xsd:string"
      Authors="xsd:string"
      AuthorByLine="xsd:string"
      AuthorByLineId="xsd:int">
</pnp:Header>

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
Type		Defines the layout of the Header for the current client side page	Yes
ServerRelativeImageUrl	xsd:string	Defines the server-relative URL of the image for the header of the current client side page.	No
TranslateX	xsd:double	Defines the x-translate of the image for the header of the current client side page.	No
TranslateY	xsd:double	Defines the y-translate of of the image for the header of the current client side page.	No
LayoutType		Defines the type of layout used inside the header of the current client side page	No
TextAlignment		Defines the text alignment of the text in the header of the current client side page	No	Left
ShowTopicHeader	xsd:boolean	Defines whether to show the topic header in the title region of the current client side page.	No
ShowPublishDate	xsd:boolean	Defines whether to show the page publication date in the title region of the current client side page.	No
TopicHeader	xsd:string	Defines the topic header text to show if ShowTopicHeader is set to true of the current client side page.	No
AlternativeText	xsd:string	Defines the alternative text for the header image of the current client side page.	No
Authors	xsd:string	Defines the page author(s) to be displayed of the current client side page.	No
AuthorByLine	xsd:string	Defines the page author by line of the current client side page.	No
AuthorByLineId	xsd:int	Defines the ID of the page author by line of the current client side page.	No

Sections

Defines the Canvas sections for a single ClientSidePage.

<pnp:Sections>
   <pnp:Section />
</pnp:Sections>

Here follow the available child elements for the element.

Element	Type	Description
Section	CanvasSection	Defines a Canvas section for a single ClientSidePage.

FieldValues

Defines the page fields values, if any.

<pnp:FieldValues>
   <pnp:FieldValue />
</pnp:FieldValues>

Here follow the available child elements for the element.

Element	Type	Description
FieldValue	StringDictionaryItem	A custom field for the current Client Page

Properties

Defines property bag properties for the client side page, optional element.

<pnp:Properties>
   <pnp:Property />
</pnp:Properties>

Here follow the available child elements for the element.

Element	Type	Description
Property	StringDictionaryItem	A custom property for the current Client Page

ClientSidePage

Defines a single element of type ClientSidePage.

<pnp:ClientSidePage
      PageName="xsd:string"
      LCID="xsd:int"
      CreateTranslations="xsd:boolean">
</pnp:ClientSidePage>

Here follow the available attributes for the ClientSidePage element.

Attibute	Type	Description	Required	Default
PageName	xsd:string	Defines the page name for a single ClientSidePage.	Yes
LCID	xsd:int	The Locale ID of a Localization Language, optional attribute.	No
CreateTranslations	xsd:boolean	Defines whether to create translations of the current Client Side Page, optional attribute.	No	false

TranslatedClientSidePage

<pnp:TranslatedClientSidePage
      LCID="xsd:int"
      PageName="xsd:string">
</pnp:TranslatedClientSidePage>

Here follow the available attributes for the TranslatedClientSidePage element.

Attibute	Type	Description	Required
LCID	xsd:int	The Locale ID of a Localization Language, optional attribute.	No
PageName	xsd:string	Defines the page name for a single ClientSidePage, optional attribute.	No

Header

Defines the Header settings for the target site.

<pnp:Header
      Layout=""
      MenuStyle=""
      BackgroundEmphasis="pnp:Emphasis"
      ShowSiteTitle="xsd:boolean"
      ShowSiteNavigation="xsd:boolean">
</pnp:Header>

Here follow the available attributes for the Header element.

Attibute	Type	Description	Required	Default
Layout		Defines the Layout of the Header, required attribute.	Yes
MenuStyle		Defines the Menu Style, required attribute.	No	Cascading
BackgroundEmphasis	Emphasis	Defines the Background Emphasis of the Header, optional attribute.	No	None
ShowSiteTitle	xsd:boolean	Defines whether the site title is visible or not, optional attribute.	No	true
ShowSiteNavigation	xsd:boolean	Defines whether the site navigation is visible or not, optional attribute.	No	true

Footer

Defines the Footer settings for the target site.

<pnp:Footer
      Enabled="xsd:boolean"
      Logo="pnp:ReplaceableString"
      Name="pnp:ReplaceableString"
      RemoveExistingNodes="xsd:boolean"
      Layout=""
      DisplayName="pnp:ReplaceableString">
   <pnp:FooterLinks />
</pnp:Footer>

Here follow the available child elements for the Footer element.

Element	Type	Description
FooterLinks	FooterLinks	Defines the Footer Links for the target site.

Here follow the available attributes for the Footer element.

Attibute	Type	Description	Required	Default
Enabled	xsd:boolean	Defines whether the site Footer is enabled or not, required attribute.	Yes
Logo	ReplaceableString	Defines the Logo to render in the Footer, optional attribute.	No
Name	ReplaceableString	Defines the name of the footer, optional attribute.	No
RemoveExistingNodes	xsd:boolean	Defines whether the existing site Footer links should be removed, optional attribute.	No	true
Layout		Defines the Layout of the Footer, required attribute.	No	Simple
DisplayName	ReplaceableString	Defines the Display Name for the footer, optional attribute.	No

FooterLinks

Defines the Footer Links for the target site.

<pnp:FooterLinks>
   <pnp:FooterLink />
</pnp:FooterLinks>

Here follow the available child elements for the element.

Element	Type	Description
FooterLink	FooterLink	Defines a Footer Link for the target site.

FooterLink

Defines a Footer Link for the target site.

<pnp:FooterLink
      DisplayName="pnp:ReplaceableString"
      Url="pnp:ReplaceableString">
   <pnp:FooterLink />
</pnp:FooterLink>

Here follow the available child elements for the FooterLink element.

Element	Type	Description
FooterLink	FooterLink	Defines a collection of children Footer Link for the current Footer Link (which represents an header).

Here follow the available attributes for the FooterLink element.

Attibute	Type	Description	Required
DisplayName	ReplaceableString	Defines the DisplayName for the Footer Link for the target site.	Yes
Url	ReplaceableString	Defines the URL for the Footer Link for the target site.	No

ProvisioningWebhook

<pnp:ProvisioningWebhook
      Kind=""
      Url="pnp:ReplaceableString"
      Method=""
      BodyFormat=""
      Async="xsd:boolean">
   <pnp:Parameters />
</pnp:ProvisioningWebhook>

Here follow the available child elements for the ProvisioningWebhook element.

Element	Type	Description
Parameters	Parameters	A collection of custom parameters that will be provided to the webhook request

Here follow the available attributes for the ProvisioningWebhook element.

Attibute	Type	Description	Required	Default
Kind		Defines the kind of a Provisioning Template Webhook, required attribute.	Yes
Url	ReplaceableString	Defines the URL of a Provisioning Template Webhook, can be a replaceable string and it is a required attribute.	Yes
Method		Defines how to call the target Webhook URL, required attribute.	Yes
BodyFormat		Defines how to format the request body for HTTP POST requests, optional attribute.	No	Json
Async	xsd:boolean	Defines whether the Provisioning Template Webhook should be executed asychronously or not, optional attribute.	No	true

Parameters

A collection of custom parameters that will be provided to the webhook request

<pnp:Parameters>
   <pnp:Parameter />
</pnp:Parameters>

Here follow the available child elements for the element.

Element	Type	Description
Parameter	StringDictionaryItem	A custom parameter that will be provided to the webhook request

CanvasSection

A Canvas Section for a Client-side Page.

<pnp:CanvasSection
      Order="xsd:int"
      Type=""
      BackgroundEmphasis="pnp:Emphasis"
      VerticalSectionEmphasis="pnp:Emphasis">
   <pnp:Controls />
</pnp:CanvasSection>

Here follow the available child elements for the CanvasSection element.

Element	Type	Description
Controls	Controls	A collection of Canvas Controls for a Client-side Page.

Here follow the available attributes for the CanvasSection element.

Attibute	Type	Description	Required	Default
Order	xsd:int	The order of the Canvas Section for a Client-side Page.	No
Type		The type of the Canvas Section for a Client-side Page.	Yes
BackgroundEmphasis	Emphasis	The emphasis color of the Canvas Section for a Client-side Page.	No	None
VerticalSectionEmphasis	Emphasis	The emphasis color of the Canvas Section for a Client-side Page.	No	None

Controls

A collection of Canvas Controls for a Client-side Page.

<pnp:Controls>
   <pnp:CanvasControl />
</pnp:Controls>

Here follow the available child elements for the element.

Element	Type	Description
CanvasControl	CanvasControl	A single Canvas Control for a Client-side Page.

CanvasControl

Defines a Canvas Control for a Client-side Page.

<pnp:CanvasControl
      WebPartType=""
      CustomWebPartName="xsd:string"
      JsonControlData="xsd:string"
      ControlId="pnp:GUID"
      Order="xsd:int"
      Column="xsd:int">
   <pnp:CanvasControlProperties />
</pnp:CanvasControl>

Here follow the available child elements for the CanvasControl element.

Element	Type	Description
CanvasControlProperties	CanvasControlProperties	Custom properties for the client-side web part control.

Here follow the available attributes for the CanvasControl element.

Attibute	Type	Description	Required	Default
WebPartType		The Type of Client-side Web Part.	Yes
CustomWebPartName	xsd:string	The Name of the client-side web part if the WebPartType attribute has a value of "Custom".	No
JsonControlData	xsd:string	The JSON Control Data for Canvas Control of a Client-side Page.	No
ControlId	GUID	The Instance Id for Canvas Control of a Client-side Page.	No
Order	xsd:int	The order of the Canvas Control for a Client-side Page.	No	0
Column	xsd:int	The Column of the Section in which the Canvas Control will be inserted. Optional, default 0.	No	0

CanvasControlProperties

Custom properties for the client-side web part control.

<pnp:CanvasControlProperties>
   <pnp:CanvasControlProperty />
</pnp:CanvasControlProperties>

Here follow the available child elements for the element.

Element	Type	Description
CanvasControlProperty	StringDictionaryItem	A single property of a client-side web part control.

CanvasColumn

Defines a Canvas Section for a Client-side Page.

<pnp:CanvasColumn
      Order="xsd:int"
      ColumnFactor="xsd:int">
   <pnp:Controls />
</pnp:CanvasColumn>

Here follow the available child elements for the CanvasColumn element.

Element	Type	Description
Controls	Controls	A collection of Canvas Controls for a Client-side Page.

Here follow the available attributes for the CanvasColumn element.

Attibute	Type	Description	Required
Order	xsd:int	The order of the Canvas section for a Client-side Page.	No
ColumnFactor	xsd:int	The column Factor for Canvas column of a Client-side Page.	No

Controls

A collection of Canvas Controls for a Client-side Page.

<pnp:Controls>
   <pnp:CanvasControl />
</pnp:Controls>

Here follow the available child elements for the element.

Element	Type	Description
CanvasControl	CanvasControl	A single Canvas Control for a Client-side Page.

FileProperties

A collection of File Properties.

<pnp:FileProperties>
   <pnp:Property />
</pnp:FileProperties>

Here follow the available child elements for the FileProperties element.

Element	Type	Description
Property	StringDictionaryItem

File

Defines a File element, to describe a file that will be provisioned into the target Site.

<pnp:File
      Src="xsd:string"
      Folder="xsd:string"
      Overwrite="xsd:boolean"
      Level="pnp:FileLevel"
      TargetFileName="pnp:ReplaceableString">
   <pnp:Properties />
   <pnp:WebParts />
   <pnp:Security />
</pnp:File>

Here follow the available child elements for the File element.

Element	Type	Description
Properties	FileProperties	The File Properties, optional collection of elements.
WebParts	WebParts	The webparts to add to the page, optional collection of elements.
Security	ObjectSecurity

Here follow the available attributes for the File element.

Attibute	Type	Description	Required	Default
Src	xsd:string	The Src of the File, required attribute.	Yes
Folder	xsd:string	The TargetFolder of the File, required attribute.	Yes
Overwrite	xsd:boolean	The Overwrite flag for the File, optional attribute.	No	false
Level	FileLevel	The Level status for the File, optional attribute.	No
TargetFileName	ReplaceableString	The Target file name for the File, optional attribute. If missing, the original file name will be used.	No

WebParts

The webparts to add to the page, optional collection of elements.

<pnp:WebParts>
   <pnp:WebPart />
</pnp:WebParts>

Here follow the available child elements for the element.

Element	Type	Description
WebPart	WebPartPageWebPart

Page

Defines a Page element, to describe a page that will be provisioned into the target Site. Because of the Layout attribute, the assumption is made that you're referring/creating a WikiPage.

<pnp:Page
      Url="xsd:string"
      Overwrite="xsd:boolean"
      Layout="pnp:WikiPageLayout">
   <pnp:WebParts />
   <pnp:Fields />
   <pnp:Security />
</pnp:Page>

Here follow the available child elements for the Page element.

Element	Type	Description
WebParts	WebParts	The webparts to add to the page, optional collection of elements.
Fields	Fields	The Fields to setup for the Page, optional collection of elements.
Security	ObjectSecurity

Here follow the available attributes for the Page element.

Attibute	Type	Description	Required	Default
Url	xsd:string	The server relative url of the page, supports tokens, required attribute.	Yes
Overwrite	xsd:boolean	If set, overwrites an existing page in the case of a wikipage, optional attribute.	No	false
Layout	WikiPageLayout	Defines the layout of the wikipage, required attribute.	Yes

WebParts

The webparts to add to the page, optional collection of elements.

<pnp:WebParts>
   <pnp:WebPart />
</pnp:WebParts>

Here follow the available child elements for the element.

Element	Type	Description
WebPart	WikiPageWebPart

Fields

The Fields to setup for the Page, optional collection of elements.

<pnp:Fields>
   <pnp:Field />
</pnp:Fields>

Here follow the available child elements for the element.

Element	Type	Description
Field	BaseFieldValue

WikiPageWebPart

Defines a WebPart to be added to a WikiPage.

<pnp:WikiPageWebPart
      Title="xsd:string"
      Row="xsd:int"
      Column="xsd:int">
   <pnp:Contents />
</pnp:WikiPageWebPart>

Here follow the available child elements for the WikiPageWebPart element.

Element	Type	Description
Contents	Contents	Defines the WebPart XML, required element.

Here follow the available attributes for the WikiPageWebPart element.

Attibute	Type	Description	Required
Title	xsd:string	Defines the title of the WebPart, required attribute.	Yes
Row	xsd:int	Defines the row to add the WebPart to, required attribute.	Yes
Column	xsd:int	Defines the column to add the WebPart to, required attribute.	Yes

WebPartPageWebPart

Defines a webpart to be added to a WebPart Page.

<pnp:WebPartPageWebPart
      Title="xsd:string"
      Zone="xsd:string"
      Order="xsd:int">
   <pnp:Contents />
</pnp:WebPartPageWebPart>

Here follow the available child elements for the WebPartPageWebPart element.

Element	Type	Description
Contents	Contents	Defines the WebPart XML, required element.

Here follow the available attributes for the WebPartPageWebPart element.

Attibute	Type	Description	Required
Title	xsd:string	Defines the title of the WebPart, required attribute.	Yes
Zone	xsd:string	Defines the zone of a WebPart Page to add the webpart to, required attribute.	Yes
Order	xsd:int	Defines the index of the WebPart in the zone, required attribute.	Yes

ComposedLook

Defines a ComposedLook element.

<pnp:ComposedLook
      Name="xsd:string"
      ColorFile="xsd:string"
      FontFile="xsd:string"
      BackgroundFile="xsd:string"
      Version="xsd:int">
</pnp:ComposedLook>

Here follow the available attributes for the ComposedLook element.

Attibute	Type	Description	Required
Name	xsd:string	The Name of the ComposedLook, required attribute.	Yes
ColorFile	xsd:string	The ColorFile of the ComposedLook, required attribute.	Yes
FontFile	xsd:string	The FontFile of the ComposedLook, required attribute.	Yes
BackgroundFile	xsd:string	The BackgroundFile of the ComposedLook, optional attribute.	Yes
Version	xsd:int	The Version of the ComposedLook, optional attribute.	No

Workflows

Defines the Workflows to provision.

<pnp:Workflows>
   <pnp:WorkflowDefinitions />
   <pnp:WorkflowSubscriptions />
</pnp:Workflows>

Here follow the available child elements for the Workflows element.

Element	Type	Description
WorkflowDefinitions	WorkflowDefinitions
WorkflowSubscriptions	WorkflowSubscriptions

WorkflowDefinitions

Defines the Workflows Definitions to provision.

<pnp:WorkflowDefinitions>
   <pnp:WorkflowDefinition />
</pnp:WorkflowDefinitions>

Here follow the available child elements for the element.

Element	Type	Description
WorkflowDefinition	WorkflowDefinition

WorkflowSubscriptions

Defines the Workflows Subscriptions to provision.

<pnp:WorkflowSubscriptions>
   <pnp:WorkflowSubscription />
</pnp:WorkflowSubscriptions>

Here follow the available child elements for the element.

Element	Type	Description
WorkflowSubscription	WorkflowSubscription

ApplicationLifecycleManagement

Defines the SharePoint Add-ins and SharePoint Framework solutions to provision, collection of elements.

<pnp:ApplicationLifecycleManagement>
   <pnp:AppCatalog />
   <pnp:Apps />
</pnp:ApplicationLifecycleManagement>

Here follow the available child elements for the ApplicationLifecycleManagement element.

Element	Type	Description
AppCatalog	AppCatalog	The App Catalog local to the current Site Collection
Apps	Apps	The SharePoint Add-ins and SharePoint Framework solutions to provision into the target Site through the ALM API of SharePoint Online, optional element.

Apps

The SharePoint Add-ins and SharePoint Framework solutions to provision into the target Site through the ALM API of SharePoint Online, optional element.

<pnp:Apps>
   <pnp:App />
</pnp:Apps>

Here follow the available child elements for the element.

Element	Type	Description
App	App

AppCatalog

Element to manage the AppCatalog tenant-wide, or local to a specific Site Collection

<pnp:AppCatalog>
   <pnp:Package />
</pnp:AppCatalog>

Here follow the available child elements for the AppCatalog element.

Element	Type	Description
Package	Package

Package

<pnp:Package
      PackageId="pnp:ReplaceableString"
      Src="xsd:string"
      Action=""
      SkipFeatureDeployment="xsd:boolean"
      Overwrite="xsd:boolean">
</pnp:Package>

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
PackageId	ReplaceableString	Defines the ID of the package to manage, optional attribute (either this one or the Src has to be provided)	No
Src	xsd:string	Defines the path of the package to manage, optional attribute (either this one or the PackageId has to be provided).	No
Action		Defines the action to execute against the package, required attribute	Yes
SkipFeatureDeployment	xsd:boolean	Defines whether to skip the feature deployment for tenant-wide enabled packages, optional attribute (default: false).	No	false
Overwrite	xsd:boolean	Defines whether to overwrite an already existing package in the AppCatalog, optional attribute (default: false).	No	false

ContentDeliveryNetwork

Element to manage the tenant-wide CDN.

<pnp:ContentDeliveryNetwork>
   <pnp:Public />
   <pnp:Private />
</pnp:ContentDeliveryNetwork>

Here follow the available child elements for the ContentDeliveryNetwork element.

Element	Type	Description
Public	CdnSetting	Defines the Public CDN settings.
Private	CdnSetting	Defines the Private CDN settings.

CdnSetting

Defines the settings for a Public or Private CDN.

<pnp:CdnSetting
      Enabled="xsd:boolean"
      NoDefaultOrigins="xsd:boolean">
   <pnp:Origins />
   <pnp:IncludeFileExtensions />
   <pnp:ExcludeRestrictedSiteClassifications />
   <pnp:ExcludeIfNoScriptDisabled />
</pnp:CdnSetting>

Here follow the available child elements for the CdnSetting element.

Element	Type	Description
Origins	Origins	Defines the CDN Origins for the current CDN.
IncludeFileExtensions	xsd:string	Defines the file extensions to include in the CDN policy.
ExcludeRestrictedSiteClassifications	xsd:string	Defines the site classifications to exclude of the wild card origins.
ExcludeIfNoScriptDisabled	xsd:string	Allows to opt-out of sites that have disabled NoScript.

Here follow the available attributes for the CdnSetting element.

Attibute	Type	Description	Required	Default
Enabled	xsd:boolean	Defines whether the CDN has to be enabled or disabled, required attribute.	Yes
NoDefaultOrigins	xsd:boolean	Defines whether the CDN should have default origins, optional attribute.	No	false

Origins

Defines the CDN Origins for the current CDN.

<pnp:Origins>
   <pnp:Origin />
</pnp:Origins>

Here follow the available child elements for the element.

Element	Type	Description
Origin	Origin	Defines a single CDN Origin for the current CDN.

Publishing

Defines the Publishing configuration to provision.

<pnp:Publishing
      AutoCheckRequirements="">
   <pnp:DesignPackage />
   <pnp:AvailableWebTemplates />
   <pnp:PageLayouts />
   <pnp:ImageRenditions />
</pnp:Publishing>

Here follow the available child elements for the Publishing element.

Element	Type	Description
DesignPackage	DesignPackage	Defines a Design Package to import into the current Publishing site, optional element.
AvailableWebTemplates	AvailableWebTemplates	Defines the Available Web Templates for the current Publishing site, optional collection of elements.
PageLayouts	PageLayouts	Defines the Available Page Layouts for the current Publishing site, optional collection of elements.
ImageRenditions	ImageRenditions	Defines the Image Renditions for the current Publishing site, optional collection of elements.

Here follow the available attributes for the Publishing element.

Attibute	Type	Description	Required	Default
AutoCheckRequirements		Defines how an engine should behave if the requirements for provisioning publishing capabilities are not satisfied by the target site, required attribute.	Yes

DesignPackage

Defines a Design Package to import into the current Publishing site, optional element.

<pnp:DesignPackage
      DesignPackagePath="xsd:string"
      MajorVersion="xsd:int"
      MinorVersion="xsd:int"
      PackageGuid="pnp:GUID"
      PackageName="xsd:string">
</pnp:DesignPackage>

Here follow the available attributes for the element.

Attibute	Type	Description	Required
DesignPackagePath	xsd:string	Defines the path of the Design Package to import into the current Publishing site, required attribute.	Yes
MajorVersion	xsd:int	The Major Version of the Design Package to import into the current Publishing site, optional attribute.	No
MinorVersion	xsd:int	The Minor Version of the Design Package to import into the current Publishing site, optional attribute.	No
PackageGuid	GUID	The ID of the Design Package to import into the current Publishing site, optional attribute.	No
PackageName	xsd:string	The Name of the Design Package to import into the current Publishing site, required attribute.	Yes

AvailableWebTemplates

Defines the Available Web Templates for the current Publishing site, optional collection of elements.

<pnp:AvailableWebTemplates>
   <pnp:WebTemplate />
</pnp:AvailableWebTemplates>

Here follow the available child elements for the element.

Element	Type	Description
WebTemplate	WebTemplate	Defines an available Web Template for the current Publishing site.

PageLayouts

Defines the Available Page Layouts for the current Publishing site, optional collection of elements.

<pnp:PageLayouts
      Default="xsd:string">
   <pnp:PageLayout />
</pnp:PageLayouts>

Here follow the available child elements for the element.

Element	Type	Description
PageLayout	PageLayout	Defines an available Page Layout for the current Publishing site.

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
Default	xsd:string	Defines the URL of the Default Page Layout for the current Publishing site, if any. Optional attribute.	No

ImageRenditions

Defines the Image Renditions for the current Publishing site, optional collection of elements.

<pnp:ImageRenditions>
   <pnp:ImageRendition />
</pnp:ImageRenditions>

Here follow the available child elements for the element.

Element	Type	Description
ImageRendition	ImageRendition	Defines an available Image Rendition for the current Publishing site.

Provider

Defines an Extensibility Provider.

<pnp:Provider
      Enabled="xsd:boolean"
      HandlerType="xsd:string">
   <pnp:Configuration />
</pnp:Provider>

Here follow the available child elements for the Provider element.

Element	Type	Description
Configuration	Configuration	Defines an optional configuration section for the Extensibility Provider. The configuration section can be any XML.

Here follow the available attributes for the Provider element.

Attibute	Type	Description	Required	Default
Enabled	xsd:boolean	Defines whether the Extensibility Provider is enabled or not, optional attribute.	No	false
HandlerType	xsd:string	The type of the handler. It can be a FQN of a .NET type, the URL of a node.js file, or whatever else, required attribute.	Yes

Configuration

Defines an optional configuration section for the Extensibility Provider. The configuration section can be any XML.

<pnp:Configuration>
   <!-- Any other XML content -->
</pnp:Configuration>

ProvisioningTemplateFile

An element that references an external file.

<pnp:ProvisioningTemplateFile
      File="xsd:string"
      ID="xsd:ID">
</pnp:ProvisioningTemplateFile>

Here follow the available attributes for the ProvisioningTemplateFile element.

Attibute	Type	Description	Required
File	xsd:string	Absolute or relative path to the file, required attribute.	Yes
ID	xsd:ID	ID of the referenced template, required attribute.	Yes

ProvisioningTemplateReference

An element that references an external file.

<pnp:ProvisioningTemplateReference
      ID="xsd:IDREF">
</pnp:ProvisioningTemplateReference>

Here follow the available attributes for the ProvisioningTemplateReference element.

Attibute	Type	Description	Required	Default
ID	xsd:IDREF	ID of the referenced template, required attribute.	Yes

Sequence

Each Provisioning file is split into a set of Sequence elements. The Sequence element groups the artefacts to be provisioned into groups. The Sequences must be evaluated by the provisioning engine in the order in which they appear.

<pnp:Sequence
      ID="xsd:ID">
   <pnp:SiteCollections />
   <pnp:TermStore />
</pnp:Sequence>

Here follow the available child elements for the Sequence element.

Element	Type	Description
SiteCollections	SiteCollections	A collection of Site Collection elements to provision through a Sequence, optional element.
TermStore	TermStore	A Term Store to provision through a Sequence, optional element.

Here follow the available attributes for the Sequence element.

Attibute	Type	Description	Required	Default
ID	xsd:ID	A unique identifier of the Sequence, required attribute.	Yes

SiteCollections

A collection of Site Collection elements to provision through a Sequence, optional element.

<pnp:SiteCollections>
   <pnp:SiteCollection />
</pnp:SiteCollections>

Here follow the available child elements for the element.

Element	Type	Description
SiteCollection	SiteCollection	A Site Collection to provision through a Sequence, optional element.

SiteCollection

Defines the base element for a SiteCollection that will be created into the target tenant/farm.

<pnp:SiteCollection>
   <pnp:Templates />
   <pnp:Sites />
</pnp:SiteCollection>

Here follow the available child elements for the SiteCollection element.

Element	Type	Description
Templates	Templates	Templates that can be provisioned together with the Site Collection, optional collection of elements.
Sites	Sites	Allows to create sub-Sites under the current site

Templates

Templates that can be provisioned together with the Site Collection, optional collection of elements.

<pnp:Templates>
   <pnp:ProvisioningTemplateReference />
</pnp:Templates>

Here follow the available child elements for the element.

Element	Type	Description
ProvisioningTemplateReference	ProvisioningTemplateReference	Defines a reference to a Provisioning Template defined or imported in the current Provisioning File

Sites

Allows to create sub-Sites under the current site

<pnp:Sites>
   <pnp:Site />
</pnp:Sites>

Here follow the available child elements for the element.

Element	Type	Description
Site	Site	A Site to provision through a Sequence, optional element.

CommunicationSite

<pnp:CommunicationSite
      Url="pnp:ReplaceableString"
      Owner="pnp:ReplaceableString"
      SiteDesign="pnp:ReplaceableString"
      AllowFileSharingForGuestUsers="xsd:boolean"
      Classification="pnp:ReplaceableString"
      Language="pnp:ReplaceableString">
</pnp:CommunicationSite>

Here follow the available attributes for the CommunicationSite element.

Attibute	Type	Description	Required
Url	ReplaceableString	The URL of the target Site, required attribute.	Yes
Owner	ReplaceableString	Primary Owner of the target Site, required attribute.	Yes
SiteDesign	ReplaceableString	The ID of the SiteDesign, if any, to apply to the target Site, optional attribute.	No
AllowFileSharingForGuestUsers	xsd:boolean	Defines whether the target Site can be shared to guest users or not, optional attribute.	No
Classification	ReplaceableString	The Classification of the target Site, if any, optional attribute.	No
Language	ReplaceableString	Language of the target Site, optional attribute.	No

TeamSite

<pnp:TeamSite
      Alias="pnp:ReplaceableString"
      DisplayName="pnp:ReplaceableString"
      IsPublic="xsd:boolean"
      Classification="pnp:ReplaceableString"
      Teamify="xsd:boolean"
      HideTeamify="xsd:boolean"
      GroupLifecyclePolicyId="pnp:ReplaceableString"
      Language="pnp:ReplaceableString"
      SiteDesign="pnp:ReplaceableString">
</pnp:TeamSite>

Here follow the available attributes for the TeamSite element.

Attibute	Type	Description	Required	Default
Alias	ReplaceableString	The Alias of the target Site, required attribute.	Yes
DisplayName	ReplaceableString	The DisplayName of the target Site, required attribute.	Yes
IsPublic	xsd:boolean	Defines whether the Office 365 Group for the target Site is Public or Private, required attribute.	Yes
Classification	ReplaceableString	The Classification of the target Site, if any, optional attribute.	No
Teamify	xsd:boolean	Defines whether to create a Microsoft Team backing the modern Team Site, optional attribute.	No	false
HideTeamify	xsd:boolean	Defines whether to hide the create a Microsoft Team option in the UI of the Team Site, optional attribute.	No	false
GroupLifecyclePolicyId	ReplaceableString	Allows to associate the Office 365 Group associated with the Team Site to a Group Lifecycle Policy, optional attribute.	No
Language	ReplaceableString	Language of the target Site, optional attribute.	No
SiteDesign	ReplaceableString	The ID of the SiteDesign, if any, to apply to the target Site, optional attribute.	No

TeamSiteNoGroup

<pnp:TeamSiteNoGroup
      Url="pnp:ReplaceableString"
      Owner="pnp:ReplaceableString"
      TimeZoneId="pnp:ReplaceableString"
      Language="pnp:ReplaceableString"
      Groupify="xsd:boolean"
      Alias="pnp:ReplaceableString"
      Classification="pnp:ReplaceableString"
      IsPublic="xsd:boolean"
      KeepOldHomePage="xsd:boolean">
</pnp:TeamSiteNoGroup>

Here follow the available attributes for the TeamSiteNoGroup element.

Attibute	Type	Description	Required	Default
Url	ReplaceableString	The URL of the target Site, required attribute.	Yes
Owner	ReplaceableString	Primary Owner of the target Site, required attribute.	Yes
TimeZoneId	ReplaceableString	TimeZone of the target Site, optional attribute.	No
Language	ReplaceableString	Language of the target Site, optional attribute.	No
Groupify	xsd:boolean	Declare whether to groupify the team site after creation or not, optional attribute.	No
Alias	ReplaceableString	The Alias of the target Office 365 Group backing the Site, optional attribute. It is used if and only if the Groupify attribute has a value of True.	No
Classification	ReplaceableString	The Classification of the target groupified Site, if any, optional attribute. It is used if and only if the Groupify attribute has a value of True.	No
IsPublic	xsd:boolean	Defines whether the Office 365 Group for the target groupified Site is Public or Private, optional attribute. It is used if and only if the Groupify attribute has a value of True.	No	true
KeepOldHomePage	xsd:boolean	Defines whether to keep the old home page of the site after it gets groupified, optional attribute. It is used if and only if the Groupify attribute has a value of True.	No	false

ClassicSite

<pnp:ClassicSite
      Url="pnp:ReplaceableString"
      Owner="pnp:ReplaceableString"
      TimeZoneId="pnp:ReplaceableString"
      Language="pnp:ReplaceableString"
      WebTemplate="pnp:ReplaceableString"
      Classification="pnp:ReplaceableString">
</pnp:ClassicSite>

Here follow the available attributes for the ClassicSite element.

Attibute	Type	Description	Required
Url	ReplaceableString	The URL of the target Site, required attribute.	Yes
Owner	ReplaceableString	Primary Owner of the target Site, required attribute.	Yes
TimeZoneId	ReplaceableString	TimeZone of the target Site, optional attribute.	No
Language	ReplaceableString	Language of the target Site, optional attribute.	No
WebTemplate	ReplaceableString	The WebTemplate to be used to provision this site collection.	Yes
Classification	ReplaceableString	The Classification of the target groupified Site, if any, optional attribute. It is used if and only if the Groupify attribute has a value of True.	No

Site

Defines a Site that will be created into a target Site Collection.

<pnp:Site>
   <pnp:Sites />
   <pnp:Templates />
</pnp:Site>

Here follow the available child elements for the Site element.

Element	Type	Description
Sites	Sites	Allows to create sub-Sites under the current site
Templates	Templates	Templates that can be provisioned together with the Site Collection, optional collection of elements.

Sites

Allows to create sub-Sites under the current site

<pnp:Sites>
   <pnp:Site />
</pnp:Sites>

Here follow the available child elements for the element.

Element	Type	Description
Site	Site	A Site to provision through a Sequence, optional element.

Templates

Templates that can be provisioned together with the Site Collection, optional collection of elements.

<pnp:Templates>
   <pnp:ProvisioningTemplateReference />
</pnp:Templates>

Here follow the available child elements for the element.

Element	Type	Description
ProvisioningTemplateReference	ProvisioningTemplateReference	Defines a reference to a Provisioning Template defined or imported in the current Provisioning File

TeamSubSiteNoGroup

<pnp:TeamSubSiteNoGroup
      Url="pnp:ReplaceableString"
      TimeZoneId="pnp:ReplaceableString"
      Language="pnp:ReplaceableString">
</pnp:TeamSubSiteNoGroup>

Here follow the available attributes for the TeamSubSiteNoGroup element.

Attibute	Type	Description	Required
Url	ReplaceableString	The URL of the target Site, required attribute.	Yes
TimeZoneId	ReplaceableString	TimeZone of the target Site, optional attribute.	No
Language	ReplaceableString	Language of the target Site, optional attribute.	No

TermStore

A TermStore to use for provisioning of TermGroups.

<pnp:TermStore>
   <pnp:TermGroup />
</pnp:TermStore>

Here follow the available child elements for the TermStore element.

Element	Type	Description
TermGroup	TermGroup	The TermGroup element to provision into the target TermStore through, optional collection of elements.

TermGroup

A TermGroup to use for provisioning of TermSets and Terms.

<pnp:TermGroup
      Description="xsd:string"
      SiteCollectionTermGroup="xsd:boolean"
      UpdateBehavior=""
      Name="xsd:string"
      ID="pnp:GUID">
</pnp:TermGroup>

Here follow the available attributes for the TermGroup element.

Attibute	Type	Description	Required	Default
Description	xsd:string	The Description of the TermGroup to use for provisioning of TermSets and Terms, optional attribute.	No
SiteCollectionTermGroup	xsd:boolean	Declares if the TermGroup is the Site Collection Term Group, optional attribute.	No
UpdateBehavior		If the TermGroup already exists on target, this attribute defines whether the TermGroup will be overwritten or skipped.	No	Skip
Name	xsd:string	The Name of the Taxonomy Item, required attribute.	Yes
ID	GUID	The ID of the Taxonomy Item, optional attribute.	No

TermSetItem

Base type for TermSets and Terms

<pnp:TermSetItem
      Owner="pnp:ReplaceableString"
      Description="xsd:string"
      IsAvailableForTagging="xsd:boolean">
</pnp:TermSetItem>

Here follow the available attributes for the TermSetItem element.

Attibute	Type	Description	Required	Default
Owner	ReplaceableString	The Owner of the Term Set Item, optional attribute.	No
Description	xsd:string	The Description of the Term Set Item, optional attribute.	No
IsAvailableForTagging	xsd:boolean	Declares whether the Term Set Item is available for tagging, optional attribute.	No	true

TermSet

A TermSet to provision.

<pnp:TermSet
      Language="xsd:int"
      IsOpenForTermCreation="xsd:boolean">
</pnp:TermSet>

Here follow the available attributes for the TermSet element.

Attibute	Type	Description	Required	Default
Language	xsd:int	The reference Language for the Term Set, optional attribute.	No
IsOpenForTermCreation	xsd:boolean	Declares whether the Term Set is open for terms creation or not, optional attribute.	No	false

Term

A Term to provision into a TermSet or a hyerarchical Term.

<pnp:Term
      Language="xsd:int"
      CustomSortOrder="xsd:int"
      IsReused="xsd:boolean"
      IsSourceTerm="xsd:boolean"
      IsDeprecated="xsd:boolean"
      SourceTermId="pnp:GUID"
      ReuseChildren="xsd:boolean"
      IsPinned="xsd:boolean"
      IsPinnedRoot="xsd:boolean">
</pnp:Term>

Here follow the available attributes for the Term element.

Attibute	Type	Description	Required	Default
Language	xsd:int	The reference Language for the Term, optional attribute.	No
CustomSortOrder	xsd:int	The Custom Sort Order for the Term, optional attribute.	No	0
IsReused	xsd:boolean	Declares if this term is reused, optional attribute.	No	false
IsSourceTerm	xsd:boolean	If the IsReused property is set to false, the current Term is not reused and this property will always be true. If the current Term is reused (IsReused returns true), then this property should be set to true if it is the source Term.	No	true
IsDeprecated	xsd:boolean	Declares if this term is deprecated, optional attribute.	No	false
SourceTermId	GUID	The ID of the source term if this term is reused, optional attribute.	No
ReuseChildren	xsd:boolean	Declares if children of the source term should be reused, optional attribute.	No	false
IsPinned	xsd:boolean	Declares if this term is pinned, optional attribute. Requires IsReused set to true.	No	false
IsPinnedRoot	xsd:boolean	Declares if this term is the root of the pinned hierarchy, optional attribute. Requires IsPinned and IsReused set to true.	No	false

TaxonomyItemProperties

A collection of Term Properties.

<pnp:TaxonomyItemProperties>
   <pnp:Property />
</pnp:TaxonomyItemProperties>

Here follow the available child elements for the TaxonomyItemProperties element.

Element	Type	Description
Property	StringDictionaryItem	A Term Property, collection of elements.

TermLabels

A collection of Term Labels, in order to support multi-language terms.

<pnp:TermLabels>
   <pnp:Label />
</pnp:TermLabels>

Here follow the available child elements for the TermLabels element.

Element	Type	Description
Label	Label

Label

<pnp:Label
      Language="xsd:int"
      Value="xsd:string"
      IsDefaultForLanguage="xsd:boolean">
</pnp:Label>

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
Language	xsd:int	The reference Language for the Term Label, required attribute.	Yes
Value	xsd:string	The Value for the Term Label, required attribute.	Yes
IsDefaultForLanguage	xsd:boolean	Declares whether the current Label is the default for the specific Language, optional attribute.	No	false

TermSets

A collection of TermSets to provision.

<pnp:TermSets>
   <pnp:TermSet />
</pnp:TermSets>

Here follow the available child elements for the TermSets element.

Element	Type	Description
TermSet	TermSet	A Term Set, optional collection of elements.

Teams

Entry point to manage Microsoft Teams provisioning.

<pnp:Teams>
   <pnp:TeamTemplate />
   <pnp:Team />
   <pnp:Apps />
</pnp:Teams>

Here follow the available child elements for the Teams element.

Element	Type	Description
TeamTemplate	TeamTemplate	Defines a new Team to create starting from a JSON template.
Team	TeamWithSettings	Defines a new Team to create or update.
Apps	TeamsApps	Defines the Apps for Teams

BaseTeam

Defines the base information for a Team of Microsoft Teams.

<pnp:BaseTeam
      DisplayName="pnp:ReplaceableString"
      Description="pnp:ReplaceableString"
      Classification="pnp:ReplaceableString"
      Visibility=""
      Photo="pnp:ReplaceableString"
      HiddenGroupMembershipEnabled="xsd:boolean">
</pnp:BaseTeam>

Here follow the available attributes for the BaseTeam element.

Attibute	Type	Description	Required	Default
DisplayName	ReplaceableString	The Display Name of the Team, required attribute.	Yes
Description	ReplaceableString	The Description of the Team, required attribute.	Yes
Classification	ReplaceableString	The Classification for the Team, optional attribute.	No
Visibility		The Visibility for the Team, optional attribute.	Yes
Photo	ReplaceableString	Declares the Photo for the Team, optional attribute.	No
HiddenGroupMembershipEnabled	xsd:boolean	Specifies whether to hide the members of the Microsoft 365 Group from users who aren't members of the group, optional attribute.	No	false

TeamTemplate

<pnp:TeamTemplate>
</pnp:TeamTemplate>

TeamWithSettings

Defines a new Team to create or update

<pnp:TeamWithSettings
      GroupId="pnp:ReplaceableString"
      TargetSiteUrl="pnp:ReplaceableString"
      ProvisioningTemplateId="pnp:ReplaceableString"
      Specialization=""
      CloneFrom="pnp:ReplaceableString"
      Archived="xsd:boolean"
      MailNickname="pnp:ReplaceableString">
</pnp:TeamWithSettings>

Here follow the available attributes for the TeamWithSettings element.

Attibute	Type	Description	Required	Default
GroupId	ReplaceableString	Declares the ID of the targt Group/Team to update, optional attribute. Cannot be used together with CloneFrom or with ProvisioningTemplateId.	No
TargetSiteUrl	ReplaceableString	Declares the URL of the targt Site to teamify, optional attribute. Cannot be used together with CloneFrom or with ProvisioningTemplateId.	No
ProvisioningTemplateId	ReplaceableString	Declares the ID of a Provisioning Template to apply to the SharePoint Online site backing the current Team, optional attribute. Cannot be used together with CloneFrom or with TargetSiteUrl.	No
Specialization		The Specialization for the Team, optional attribute.	No
CloneFrom	ReplaceableString	Declares the ID of another Team to Clone the current Team from, optional attribute. Cannot be used together with GroupId, or with TargetSiteUrl.	No
Archived	xsd:boolean	Declares whether the Team is archived or not, optional attribute.	No	false
MailNickname	ReplaceableString	Declares the nickname for the Team, optional attribute. Required for new Teams.	No

TeamSecurity

Defines the Security settings for the Team, optional element.

<pnp:TeamSecurity
      AllowToAddGuests="xsd:boolean">
   <pnp:Owners />
   <pnp:Members />
</pnp:TeamSecurity>

Here follow the available child elements for the TeamSecurity element.

Element	Type	Description
Owners	TeamSecurityUsers	Defines the Owners of the Team, optional element.
Members	TeamSecurityUsers	Defines the Members of the Team, optional element.

Here follow the available attributes for the TeamSecurity element.

Attibute	Type	Description	Required	Default
AllowToAddGuests	xsd:boolean	Defines whether guests are allowed in the Team, optional attribute.	No	false

TeamSecurityUsers

Defines a list of users for a the Team, optional element.

<pnp:TeamSecurityUsers
      ClearExistingItems="xsd:boolean">
   <pnp:User />
</pnp:TeamSecurityUsers>

Here follow the available child elements for the TeamSecurityUsers element.

Element	Type	Description
User	User	Defines a user for a the Team, optional element.

Here follow the available attributes for the TeamSecurityUsers element.

Attibute	Type	Description	Required	Default
ClearExistingItems	xsd:boolean	Declares whether to clear existing users before adding new users, optional attribute.	No	false

User

Defines a user for a the Team, optional element.

<pnp:User
      UserPrincipalName="pnp:ReplaceableString">
</pnp:User>

Here follow the available attributes for the element.

Attibute	Type	Description	Required	Default
UserPrincipalName	ReplaceableString	Defines User Principal Name (UPN) of the target user, required attribute.	Yes

TeamChannel

Defines a Channel for a Team, optional element.

<pnp:TeamChannel
      DisplayName="pnp:ReplaceableString"
      Description="pnp:ReplaceableString"
      IsFavoriteByDefault="xsd:boolean"
      ID="pnp:ReplaceableString"
      Private="xsd:boolean">
   <pnp:Tabs />
   <pnp:TabResources />
   <pnp:Messages />
</pnp:TeamChannel>

Here follow the available child elements for the TeamChannel element.

Element	Type	Description
Tabs	TeamChannelTabs	Defines a collection of Tabs for a Channel in a Team, optional element.
TabResources	TeamTabResources	Defines a collection of Resources for Tabs in a Team Channel, optional element.
Messages	TeamChannelMessages	Defines a collection of Messages for a Team Channel, optional element.

Here follow the available attributes for the TeamChannel element.

Attibute	Type	Description	Required	Default
DisplayName	ReplaceableString	Defines the Display Name of the Channel, required attribute.	Yes
Description	ReplaceableString	Defines the Description of the Channel, required attribute.	Yes
IsFavoriteByDefault	xsd:boolean	Defines whether the Channel is Favorite by default for all members of the Team, optional attribute.	No	false
ID	ReplaceableString	Declares the ID for the Channel, optional attribute.	No
Private	xsd:boolean	Declares whether the Channel is private or not, optional attribute (default false).	No	false

TeamChannelTabs

Defines a collection of Tabs for a Channel in a Team, optional element.

<pnp:TeamChannelTabs>
   <pnp:Tab />
</pnp:TeamChannelTabs>

Here follow the available child elements for the TeamChannelTabs element.

Element	Type	Description
Tab	Tab	Defines a Tab for a Channel in a Team, optional element.

Tab

Defines a Tab for a Channel in a Team, optional element.

<pnp:Tab
      DisplayName="pnp:ReplaceableString"
      TeamsAppId="pnp:ReplaceableString"
      ID="pnp:ReplaceableString"
      Remove="xsd:boolean">
   <pnp:Configuration />
</pnp:Tab>

Here follow the available child elements for the element.

Element	Type	Description
Configuration	Configuration	Defines the Configuration for the Tab, required element.

Here follow the available attributes for the element.

Attibute	Type	Description	Required
DisplayName	ReplaceableString	Defines the Display Name of the Channel, required attribute.	Yes
TeamsAppId	ReplaceableString	App definition identifier of the tab, required attribute.	Yes
ID	ReplaceableString	Declares the ID for the Tab, optional attribute.	No
Remove	xsd:boolean	Allows to remove an already existing Tab, optional attribute.	No

TeamTabResources

Defines a collection of Resources for Tabs of a Channel in a Team.

<pnp:TeamTabResources>
   <pnp:TabResource />
</pnp:TeamTabResources>

Here follow the available child elements for the TeamTabResources element.

Element	Type	Description
TabResource	TabResource	Defines a Resource for a Tab in a Channel of a Team.

TabResource

Defines a Resource for a Tab in a Channel of a Team.

<pnp:TabResource
      Type=""
      TargetTabId="pnp:ReplaceableString">
   <pnp:TabResourceSettings />
</pnp:TabResource>

Here follow the available child elements for the element.

Element	Type	Description
TabResourceSettings	ReplaceableString	Defines the Configuration for the Tab Resource, optional element.

Here follow the available attributes for the element.

Attibute	Type	Description	Required
Type		Defines the Type of Resource for the Tab, required attribute.	Yes
TargetTabId	ReplaceableString	Defines the ID of the target Tab for the Resource, required attribute.	Yes

TeamChannelMessages

Defines a collection of Messages for a Channel in a Team, optional element.

<pnp:TeamChannelMessages>
   <pnp:Message />
</pnp:TeamChannelMessages>

Here follow the available child elements for the TeamChannelMessages element.

Element	Type	Description
Message	xsd:string	Defines a Message for a Channel in a Team, optional element.

TeamsApps

Defines the Apps for Teams

<pnp:TeamsApps>
   <pnp:App />
</pnp:TeamsApps>

Here follow the available child elements for the TeamsApps element.

Element	Type	Description
App	App	Defines a Teams App to add or update.

App

Defines a Teams App to add or update.

<pnp:App
      AppId="xsd:string"
      PackageUrl="pnp:ReplaceableString">
</pnp:App>

Here follow the available attributes for the element.

Attibute	Type	Description	Required
AppId	xsd:string	Unique ID - from PnP perspective - for the App, defined for further reference in the Provisioning Template, required attribute.	Yes
PackageUrl	ReplaceableString	The URL or path for the Teams App package, required attribute.	Yes

AzureActiveDirectory

Entry point to manage Microsoft Azure Active Directory provisioning.

<pnp:AzureActiveDirectory>
   <pnp:Users />
</pnp:AzureActiveDirectory>

Here follow the available child elements for the AzureActiveDirectory element.

Element	Type	Description
Users	AADUsers	Defines a list of users that will be created in the target tenant

AADUsers

Defines a list of users that will be created in the target tenant

<pnp:AADUsers>
   <pnp:User />
</pnp:AADUsers>

Here follow the available child elements for the AADUsers element.

Element	Type	Description
User	User

User

<pnp:User
      AccountEnabled="xsd:boolean"
      DisplayName="pnp:ReplaceableString"
      MailNickname="pnp:ReplaceableString"
      PasswordPolicies="pnp:ReplaceableString"
      UserPrincipalName="pnp:ReplaceableString"
      ProfilePhoto="pnp:ReplaceableString"
      GivenName="pnp:ReplaceableString"
      Surname="pnp:ReplaceableString"
      JobTitle="pnp:ReplaceableString"
      OfficeLocation="pnp:ReplaceableString"
      PreferredLanguage="pnp:ReplaceableString"
      MobilePhone="pnp:ReplaceableString"
      UsageLocation="pnp:ReplaceableString">
   <pnp:PasswordProfile />
   <pnp:Licenses />
</pnp:User>

Here follow the available child elements for the element.

Element	Type	Description
PasswordProfile	PasswordProfile	The Password Profile for the user, required element.
Licenses	Licenses	Defines a collection of licenses to activate/associate with the user, optional element.

Here follow the available attributes for the element.

Attibute	Type	Description	Required
AccountEnabled	xsd:boolean	Declares whether the user's account is enabled or not, required attribute.	Yes
DisplayName	ReplaceableString	The Display Name of the user, required attribute.	Yes
MailNickname	ReplaceableString	The Mail Nickname of the user, required attribute.	Yes
PasswordPolicies	ReplaceableString	The Password Policies for the user, optional attribute.	No
UserPrincipalName	ReplaceableString	The UPN for the user, required attribute.	Yes
ProfilePhoto	ReplaceableString	The URL of the Photo for the user, optional attribute.	No
GivenName	ReplaceableString	Declares the GivenName of the user, optional attribute.	No
Surname	ReplaceableString	Declares the Surname of the user, optional attribute.	No
JobTitle	ReplaceableString	Declares the Job Title of the user, optional attribute.	No
OfficeLocation	ReplaceableString	Declares the Office Location of the user, optional attribute.	No
PreferredLanguage	ReplaceableString	Declares the Preferred Language of the user, optional attribute.	No
MobilePhone	ReplaceableString	Declares the Mobile Phone of the user, optional attribute.	No
UsageLocation	ReplaceableString	Declares the Usage Location for licenses assigned to the user, required attribute.	Yes

Drive

Entry point to manage OneDrive for Business provisioning.

<pnp:Drive>
   <pnp:DriveRoot />
</pnp:Drive>

Here follow the available child elements for the Drive element.

Element	Type	Description
DriveRoot	DriveRoot	Defines a list of Drives in the target OneDrive for Business

DriveRoot

Entry point to manage OneDrive for Business Drives provisioning.

<pnp:DriveRoot
      DriveUrl="pnp:ReplaceableString">
   <pnp:DriveItems />
</pnp:DriveRoot>

Here follow the available child elements for the DriveRoot element.

Element	Type	Description
DriveItems	DriveItems	Defines a list of DriveItems to be uploaded/updated in the target OneDrive for Business drive

Here follow the available attributes for the DriveRoot element.

Attibute	Type	Description	Required	Default
DriveUrl	ReplaceableString	Defines the relative URL of the target Drive item in OneDrive for Business. The target Drive must exist and will not be created by the Provisioning Engine.	Yes

DriveItems

Entry point to define a collection of DriveItems in the OneDrive for Business provisioning.

<pnp:DriveItems>
   <pnp:DriveFolder />
   <pnp:DriveFile />
</pnp:DriveItems>

Here follow the available child elements for the DriveItems element.

Element	Type	Description
DriveFolder	DriveFolder	Defines DriveItem to be uploaded/updated in the target OneDrive for Business drive
DriveFile	DriveFile	Defines DriveItem to be uploaded/updated in the target OneDrive for Business drive

DriveFolder

Entry point to define a Folder in the OneDrive for Business provisioning.

<pnp:DriveFolder
      Name="pnp:ReplaceableString"
      Src="pnp:ReplaceableString"
      Overwrite="xsd:boolean"
      Recursive="xsd:boolean"
      IncludedExtensions="xsd:string"
      ExcludedExtensions="xsd:string">
   <pnp:DriveFolder />
   <pnp:DriveFile />
</pnp:DriveFolder>

Here follow the available child elements for the DriveFolder element.

Element	Type	Description
DriveFolder	DriveFolder	Defines DriveItem to be uploaded/updated in the target OneDrive for Business drive
DriveFile	DriveFile	Defines DriveItem to be uploaded/updated in the target OneDrive for Business drive

Here follow the available attributes for the DriveFolder element.

Attibute	Type	Description	Required	Default
Name	ReplaceableString	Defines the Name of the Folder in OneDrive for Business.	Yes
Src	ReplaceableString	Defines the Source path of the folder in OneDrive for Business. If provided, the whole folder will be uploaded.	No
Overwrite	xsd:boolean	The Overwrite flag for the File items in the Directory, optional attribute.	No	false
Recursive	xsd:boolean	Defines whether to recursively browse through all the child folders of the source Folder, optional attribute.	No	false
IncludedExtensions	xsd:string	The file Extensions (lower case) to include while uploading the source Folder, optional attribute.	No	.
ExcludedExtensions	xsd:string	The file Extensions (lower case) to exclude while uploading the source Folder, optional attribute.	No

DriveFile

Entry point to define a DriveItem in the OneDrive for Business provisioning.

<pnp:DriveFile
      Name="pnp:ReplaceableString"
      Src="pnp:ReplaceableString"
      Overwrite="xsd:boolean">
</pnp:DriveFile>

Here follow the available attributes for the DriveFile element.

Attibute	Type	Description	Required	Default
Name	ReplaceableString	Defines the Name of the DriveItem in OneDrive for Business.	Yes
Src	ReplaceableString	Defines the Source path of the file in OneDrive for Business.	Yes
Overwrite	xsd:boolean	The Overwrite flag for the File items in the Directory, optional attribute.	No	false

ProvisioningWebhooks

Allows to define one or more webhooks that will be invoked by the engine, while applying the provisioning

<pnp:ProvisioningWebhooks>
   <pnp:ProvisioningWebhook />
</pnp:ProvisioningWebhooks>

Here follow the available child elements for the ProvisioningWebhooks element.

Element	Type	Description
ProvisioningWebhook	ProvisioningWebhook	Defines a single Provisioning Webhook

Attibute	Type	Description	Required	Default
Src	ReplaceableString	The Src of the Directory, required attribute.	Yes
Folder	ReplaceableString	The TargetFolder of the Directory, required attribute.	Yes
Overwrite	xsd:boolean	The Overwrite flag for the File items in the Directory, optional attribute.	No	false
Level	FileLevel	The Level status for the File, optional attribute.	No
Recursive	xsd:boolean	Defines whether to recursively browse through all the child folders of the Directory, optional attribute.	No	false
IncludedExtensions	xsd:string	The file Extensions (lower case) to include while uploading the Directory, optional attribute.	No	.
ExcludedExtensions	xsd:string	The file Extensions (lower case) to exclude while uploading the Directory, optional attribute.	No
MetadataMappingFile	ReplaceableString	The file path of JSON mapping file with metadata for files to upload in the Directory, optional attribute.	No

Files

ProvisioningSchema-2021-03.md

Latest commit

History

ProvisioningSchema-2021-03.md

File metadata and controls

PnP Provisioning Schema

Namespace

Root Elements

Provisioning

ProvisioningTemplate

Child Elements and Complex Types

Preferences

Parameters

Localizations

Localization

Tenant

Office365GroupsSettings

WebApiPermissions

WebApiPermission

SiteDesigns

SiteDesign

SiteScripts

SiteScript

StorageEntities

StorageEntity

Themes

Theme

SPUsersProfiles

SPUserProfile

Office365GroupLifecyclePolicies

SharingSettings

Office365GroupLifecyclePolicy

Templates

SiteFields

ContentTypes

Lists

Files

TermGroups

SearchSettings

Providers

ProvisioningTemplateWebhooks

ProvisioningTemplateProperties

WebSettings

AlternateUICultures

SiteSettings

RegionalSettings

SupportedUILanguages

SupportedUILanguage

AuditSettings

Audit

PropertyBagEntries

Security

Permissions

Navigation

GlobalNavigation

CurrentNavigation

ManagedNavigation

StructuralNavigation

NavigationNode

Features

CustomActions

Pages

PropertyBagEntry

StringDictionaryItem

UsersList

User

SiteGroups

SiteGroup

RoleDefinitions

RoleDefinition

Permissions

RoleAssignments

RoleAssignment

ObjectSecurity

BreakRoleInheritance

ListInstance

DefaultColumnValues

ContentTypeBindings

Views