DeploymentPlanContributor Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a contributor to the deployment process
public abstract class DeploymentPlanContributor : Microsoft.SqlServer.Dac.Deployment.DeploymentContributortype DeploymentPlanContributor = class
inherit DeploymentContributorPublic MustInherit Class DeploymentPlanContributor
Inherits DeploymentContributor- Inheritance
- Derived
Constructors
| DeploymentPlanContributor() |
Properties
| Canceled |
Gets a value that indicates whether the contributor was canceled (Inherited from DeploymentContributor) |
| CancellationToken |
The CancellationToken used to indicate whether contributor execution should be canceled (Inherited from DeploymentContributor) |
Methods
| Cancel() |
Cancels execution of the contributor (Inherited from DeploymentContributor) |
| Dispose() |
Inherited from Dispose() (Inherited from DeploymentContributor) |
| Dispose(Boolean) | (Inherited from DeploymentContributor) |
| 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(DeploymentPlanContributorContext) method will fail. (Inherited from DeploymentContributor) |
| OnEstablishDeploymentConfiguration(DeploymentContributorConfigurationSetup) |
Called by the build process in DacFx to give your code an opportunity to modify deployment configuration. (Inherited from DeploymentContributor) |
| OnExecute(DeploymentPlanContributorContext) |
Called by the deployment engine to allow custom contributors to execute their unique tasks |
| PublishMessage(ExtensibilityError) |
Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers. (Inherited from DeploymentContributor) |