DeploymentPlanContributor Class

Definition

Namespace:

Microsoft.SqlServer.Dac.Deployment

Assembly:

Microsoft.SqlServer.Dac.Extensions.dll

Package:

Microsoft.SqlServer.DacFx v162.2.111

Represents a contributor to the deployment process

public abstract class DeploymentPlanContributor : Microsoft.SqlServer.Dac.Deployment.DeploymentContributor

type DeploymentPlanContributor = class
    inherit DeploymentContributor

Public MustInherit Class DeploymentPlanContributor
Inherits DeploymentContributor

Inheritance

Object

DeploymentContributor

DeploymentPlanContributor

Derived

Microsoft.SqlServer.Dac.Deployment.DeploymentPlanExecutor

Microsoft.SqlServer.Dac.Deployment.DeploymentPlanModifier

Constructors

DeploymentPlanContributor()

Properties

Canceled	Gets a value that indicates whether the contributor was canceled (Inherited from DeploymentContributor)
CancellationToken	The CancellationToken used to indicate whether contributor execution should be canceled (Inherited from DeploymentContributor)

Methods

Cancel()	Cancels execution of the contributor (Inherited from DeploymentContributor)
Dispose()	Inherited from Dispose() (Inherited from DeploymentContributor)
Dispose(Boolean)	(Inherited from DeploymentContributor)
OnApplyDeploymentConfiguration(DeploymentContributorContext, ICollection<DeploymentContributorConfigurationStream>)	Called by the deployment process in DacFx to give your code an opportunity to collect configuration information from the provided files. At the end of the method all streams will be disposed. Contributors that need to obtain data from the streams must read and cache the data during this method - attempts to read from the stream during a later method such as the OnExecute(DeploymentPlanContributorContext) method will fail. (Inherited from DeploymentContributor)
OnEstablishDeploymentConfiguration(DeploymentContributorConfigurationSetup)	Called by the build process in DacFx to give your code an opportunity to modify deployment configuration. (Inherited from DeploymentContributor)
OnExecute(DeploymentPlanContributorContext)	Called by the deployment engine to allow custom contributors to execute their unique tasks
PublishMessage(ExtensibilityError)	Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers. (Inherited from DeploymentContributor)