DeploymentContributor Class

SQL Server 2014

SQL Server 2012

Updated: April 20, 2017

Represents the base class for deployment contributors. Subclasses of this class participate in a deployment by modifying a deployment plan or by executing the plan.

Namespace: Microsoft.SqlServer.Dac.Deployment
Assembly: Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)

Inheritance Hierarchy

System::Object
Microsoft.SqlServer.Dac.Deployment::DeploymentContributor
Microsoft.SqlServer.Dac.Deployment::DeploymentPlanContributor

Syntax

C++

public ref class DeploymentContributor abstract : IDisposable

Constructors

	Name	Description
	DeploymentContributor()	Initializes a new instance of the DeploymentContributor class.

Properties

	Name	Description
	Canceled	Gets a value that indicates whether the contributor was canceled.
	CancellationToken	Gets a notification that the contributor execution should be cancelled.

Methods

	Name	Description
	Cancel()	Cancels execution of the contributor
	Dispose()	Releases the resources used by the current instance of the DeploymentContributor class.
	Dispose(Boolean)	Releases the resources used by the current instance of the DeploymentContributor class.
	Equals(Object^)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	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 method will fail.
	OnEstablishDeploymentConfiguration(DeploymentContributorConfigurationSetup^)	Called by the build process in DacFx to give your code an opportunity to modify deployment configuration.
	PublishMessage(ExtensibilityError^)	Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers.
	ToString()	(Inherited from Object.)

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD