DeploymentContributor Class

Article
02/25/2014

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.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public MustInherit Class DeploymentContributor _
    Implements IDisposable
'Usage
Dim instance As DeploymentContributor

public abstract class DeploymentContributor : IDisposable

public ref class DeploymentContributor abstract : IDisposable

[<AbstractClassAttribute>]
type DeploymentContributor =  
    class 
        interface IDisposable 
    end

public abstract class DeploymentContributor implements IDisposable

The DeploymentContributor type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Canceled	Gets a value that indicates whether the contributor was canceled.
	CancellationToken	Gets the CancellationToken used to indicate whether contributor execution should be canceled.

Top

Methods

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

Top

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.

Share via