Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

DeploymentPlanModifier Class

 

Represents a constributor that can modify a deployment plan.

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


public abstract class DeploymentPlanModifier : DeploymentPlanContributor

NameDescription
System_CAPS_protmethodDeploymentPlanModifier()

Initializes a new instance of the DeploymentPlanModifier class.

NameDescription
System_CAPS_protpropertyCanceled

Gets a value that indicates whether the contributor was canceled. (Inherited from DeploymentContributor.)

System_CAPS_protpropertyCancellationToken

Gets a notification that the contributor execution should be cancelled. (Inherited from DeploymentContributor.)

NameDescription
System_CAPS_protmethodAddAfter(DeploymentPlanHandle, DeploymentStep, DeploymentStep)

Provides a way to modify the existing plan by adding a step after the existing step.

System_CAPS_protmethodAddBefore(DeploymentPlanHandle, DeploymentStep, DeploymentStep)

Provides a way for subclasses to modify the plan by adding a step after the specified step.

System_CAPS_pubmethodCancel()

Cancels execution of the contributor (Inherited from DeploymentContributor.)

System_CAPS_pubmethodDispose()

Releases the resources used by the current instance of the DeploymentContributor class. (Inherited from DeploymentContributor.)

System_CAPS_protmethodDispose(Boolean)

Releases the resources used by the current instance of the DeploymentContributor class. (Inherited from DeploymentContributor.)

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. (Inherited from DeploymentContributor.)

System_CAPS_protmethodOnEstablishDeploymentConfiguration(DeploymentContributorConfigurationSetup)

Called by the build process in DacFx to give your code an opportunity to modify deployment configuration. (Inherited from DeploymentContributor.)

System_CAPS_protmethodOnExecute(DeploymentPlanContributorContext)

Called by the deployment engine to allow custom contributors to execute their unique tasks. (Inherited from DeploymentPlanContributor.)

System_CAPS_protmethodPublishMessage(ExtensibilityError)

Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers. (Inherited from DeploymentContributor.)

System_CAPS_protmethodRemove(DeploymentPlanHandle, DeploymentStep)

Provides a way to remove the specified step from the plan.

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