Interface IProvisioningExtensibilityHandler

Defines an interface which allows to plugin custom Provisioning Extensibility Handlers to the template extraction/provisioning pipeline

Inherited Members

IProvisioningExtensibilityTokenProvider.GetTokens(ClientContext, ProvisioningTemplate, String)

Namespace: PnP.Framework.Provisioning.Extensibility

Assembly: PnP.Framework.dll

Syntax

public interface IProvisioningExtensibilityHandler : IProvisioningExtensibilityTokenProvider

Methods

Extract(ClientContext, ProvisioningTemplate, ProvisioningTemplateCreationInformation, PnPMonitoredScope, String)

Execute custom actions during extraction of a template

Declaration

ProvisioningTemplate Extract(ClientContext ctx, ProvisioningTemplate template, ProvisioningTemplateCreationInformation creationInformation, PnPMonitoredScope scope, string configurationData)

Parameters

ClientContext ctx

The target ClientContext

ProvisioningTemplate template

The current Provisioning Template

ProvisioningTemplateCreationInformation creationInformation

The Provisioning Template creation information object

PnPMonitoredScope scope

The PnPMonitoredScope of the current step in the pipeline

System.String configurationData

The configuration data, if any, for the handler

Returns

ProvisioningTemplate

The Provisioning Template eventually enriched by the handler during extraction

Provision(ClientContext, ProvisioningTemplate, ProvisioningTemplateApplyingInformation, TokenParser, PnPMonitoredScope, String)

Execute custom actions during provisioning of a template

Declaration

void Provision(ClientContext ctx, ProvisioningTemplate template, ProvisioningTemplateApplyingInformation applyingInformation, TokenParser tokenParser, PnPMonitoredScope scope, string configurationData)