Export (0) Print
Expand All

DeploymentContributor Class

 

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)

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

public abstract class DeploymentContributor : IDisposable

NameDescription
System_CAPS_protmethodDeploymentContributor()

Initializes a new instance of the DeploymentContributor class.

NameDescription
System_CAPS_protpropertyCanceled

Gets a value that indicates whether the contributor was canceled.

System_CAPS_protpropertyCancellationToken

Gets a notification that the contributor execution should be cancelled.

NameDescription
System_CAPS_pubmethodCancel()

Cancels execution of the contributor

System_CAPS_pubmethodDispose()

Releases the resources used by the current instance of the DeploymentContributor class.

System_CAPS_protmethodDispose(Boolean)

Releases the resources used by the current instance of the DeploymentContributor class.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodOnApplyDeploymentConfiguration(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.

System_CAPS_protmethodOnEstablishDeploymentConfiguration(DeploymentContributorConfigurationSetup)

Called by the build process in DacFx to give your code an opportunity to modify deployment configuration.

System_CAPS_protmethodPublishMessage(ExtensibilityError)

Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers.

System_CAPS_pubmethodToString()

(Inherited from Object.)

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

Return to top

Community Additions

ADD
Show:
© 2015 Microsoft