Class ExtensibilityManager

Provisioning Framework Component that is used for invoking custom providers during the provisioning process.

Inheritance
System.Object
ExtensibilityManager
Namespace: PnP.Framework.Provisioning.Extensibility
Assembly: PnP.Framework.dll
Syntax
public class ExtensibilityManager : object

Methods

ExecuteExtensibilityCallOut(ClientContext, ExtensibilityHandler, ProvisioningTemplate)

Method to Invoke Custom Provisioning Providers. Ensure the ClientContext is not disposed in the custom provider.

Declaration
public void ExecuteExtensibilityCallOut(ClientContext ctx, ExtensibilityHandler handler, ProvisioningTemplate template)
Parameters
ClientContext ctx

Authenticated ClientContext that is passed to the custom provider.
ExtensibilityHandler handler

A custom Extensibility Provisioning Provider
ProvisioningTemplate template

ProvisioningTemplate that is passed to the custom provider
Exceptions
ExtensiblityPipelineException

ExecuteExtensibilityExtractionCallOut(ClientContext, ExtensibilityHandler, ProvisioningTemplate, ProvisioningTemplateCreationInformation, PnPMonitoredScope)

Method to Invoke Custom Extraction Handlers.

Declaration
public ProvisioningTemplate ExecuteExtensibilityExtractionCallOut(ClientContext ctx, ExtensibilityHandler handler, ProvisioningTemplate template, ProvisioningTemplateCreationInformation creationInformation, PnPMonitoredScope scope)
Parameters
ClientContext ctx

Authenticated ClientContext that is passed to the custom provider.
ExtensibilityHandler handler

A custom Extensibility Provisioning Provider
ProvisioningTemplate template

ProvisioningTemplate that is passed to the custom provider
ProvisioningTemplateCreationInformation creationInformation

The Provisioning Template creation information object
PnPMonitoredScope scope

The PnPMonitoredScope of the current step in the pipeline
Returns
ProvisioningTemplate

Remarks

Ensure the ClientContext is not disposed in the custom provider.

Exceptions
ExtensiblityPipelineException

ExecuteExtensibilityProvisionCallOut(ClientContext, ExtensibilityHandler, ProvisioningTemplate, ProvisioningTemplateApplyingInformation, TokenParser, PnPMonitoredScope)

Method to Invoke Custom Provisioning Handlers.

Declaration
public void ExecuteExtensibilityProvisionCallOut(ClientContext ctx, ExtensibilityHandler handler, ProvisioningTemplate template, ProvisioningTemplateApplyingInformation applyingInformation, TokenParser tokenParser, PnPMonitoredScope scope)
Parameters
ClientContext ctx

Authenticated ClientContext that is passed to the custom provider.
ExtensibilityHandler handler

A custom Extensibility Provisioning Provider
ProvisioningTemplate template

ProvisioningTemplate that is passed to the custom provider
ProvisioningTemplateApplyingInformation applyingInformation

The Provisioning Template application information object
TokenParser tokenParser

The Token Parser used by the engine during template provisioning
PnPMonitoredScope scope

The PnPMonitoredScope of the current step in the pipeline
Remarks

Ensure the ClientContext is not disposed in the custom provider.

Exceptions
ExtensiblityPipelineException

ExecuteTokenProviderCallOut(ClientContext, ExtensibilityHandler, ProvisioningTemplate)

Method to Invoke Custom Provisioning Token Providers which implement the IProvisioningExtensibilityTokenProvider interface. Ensure the ClientContext is not disposed in the custom provider.

Declaration
public IEnumerable<TokenDefinition> ExecuteTokenProviderCallOut(ClientContext ctx, ExtensibilityHandler provider, ProvisioningTemplate template)
Parameters
ClientContext ctx

Authenticated ClientContext that is passed to the custom provider.
ExtensibilityHandler provider

A custom Extensibility Provisioning Provider
ProvisioningTemplate template

ProvisioningTemplate that is passed to the custom provider
Returns
IEnumerable<TokenDefinition>

Exceptions
ExtensiblityPipelineException

Extension Methods