DeploymentPlanModifier Class
Represents a constributor that can modify a deployment plan.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Dac.Deployment.DeploymentContributor
Microsoft.SqlServer.Dac.Deployment.DeploymentPlanContributor
Microsoft.SqlServer.Dac.Deployment.DeploymentPlanModifier
Namespace: Microsoft.SqlServer.Dac.Deployment
Assembly: Microsoft.SqlServer.Dac.Extensions (in Microsoft.SqlServer.Dac.Extensions.dll)
Syntax
'Declaration
Public MustInherit Class DeploymentPlanModifier _
Inherits DeploymentPlanContributor
'Usage
Dim instance As DeploymentPlanModifier
public abstract class DeploymentPlanModifier : DeploymentPlanContributor
public ref class DeploymentPlanModifier abstract : public DeploymentPlanContributor
[<AbstractClassAttribute>]
type DeploymentPlanModifier =
class
inherit DeploymentPlanContributor
end
public abstract class DeploymentPlanModifier extends DeploymentPlanContributor
The DeploymentPlanModifier type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
DeploymentPlanModifier | Initializes a new instance of the DeploymentPlanModifier class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
Canceled | Gets a value that indicates whether the contributor was canceled. (Inherited from DeploymentContributor.) |
|
CancellationToken | Gets the CancellationToken used to indicate whether contributor execution should be canceled. (Inherited from DeploymentContributor.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
AddAfter | Provides a way to modify the existing plan by adding a step after the existing step. |
|
AddBefore | Provides a way for subclasses to modify the plan by adding a step after the specified step. |
.gif "Public method") |
Cancel | Cancels execution of the contributor. (Inherited from DeploymentContributor.) |
|
Dispose() | Releases all resources used by the current instance of the DeploymentContributor class. (Inherited from DeploymentContributor.) |
|
Dispose(Boolean) | Releases the unmanaged resources used by the DeploymentContributor and optionally releases the managed resources. (Inherited from DeploymentContributor.) |
|
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. (Inherited from DeploymentContributor.) |
|
OnEstablishDeploymentConfiguration | Indicates a member called by the build process in DacFx to give your code an opportunity to modify deployment configuration. (Inherited from DeploymentContributor.) |
|
OnExecute | Indicates a member called by the deployment engine to allow custom contributors to execute their unique tasks. (Inherited from DeploymentPlanContributor.) |
|
PublishMessage | Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers. (Inherited from DeploymentContributor.) |
|
Remove | Provides a way to remove the specified step from the plan. |
|
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.