Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IProvisioningConfig

This defines how provisioning templates should be applied to a site collection (or optionally to the tenant in the Cloud Version).

MatchPoint Workspaces uses PnP Provisioning Templates.

In the Cloud Version, PnP Tenant Templates are also supported ( See templateNames for more information on how to configure Tenant Templates).

Hierarchy

  • IProvisioningConfig

Properties

Optional customParameters

customParameters: object

A dictionary of parameters which will be forwarded to the PNP provisioning template. When using the custom parameters they are referenced with the prefix customParameter_.

Example:

{
  "needsReviewing": "true",
  "highlightColor": "#1CB954",
  "replyEmail": "internal_suggestions@contoso.com",
}

Referencing the parameters from the previous example in a PNP provisioning template:

  • customParameter_needsReviewing
  • customParameter_highlightColor
  • customParameter_replyEmail

Type declaration

  • [key: string]: string

templateContainer

templateContainer: string

The document library where your provisioning templates have been uploaded relative to the templateWebUrl.

e.g.: "/ProvisioningTemplates/"

templateNames

templateNames: object

A dictionary of provisioning templates or tenant provisioning templates that should be provisioned if the [[key]] matches the site template, with the value being an array of filenames of provisioning templates within the templateContainer.

Example:

{
  "STS#0": ["template1.xml"],
  "GROUP#0": ["template2.xml", "template3.xml"]
}

(Cloud Version only):

PnP Provisioning Tenant Templates are supported and detected by templateName naming convention. If a Tenant Template should be provisioned, the name of the template needs to end with ".tenant.xml"

Example:

{
  "GROUP#0": ["Team.tenant.xml"]
}

Type declaration

  • [key: string]: string[]

templateWebUrl

templateWebUrl: string

The web url where your provisioning templates have been uploaded.

e.g.: "https://tenant.sharepoint.com/"