DeploymentContributor Class

Definition

The base class for deployment contributors. Subclasses of this class participate in a deployment by modifying a deployment plan or by executing the plan

public abstract class DeploymentContributor : IDisposable
type DeploymentContributor = class
    interface IDisposable
Public MustInherit Class DeploymentContributor
Implements IDisposable
Inheritance
DeploymentContributor
Derived
Implements

Constructors

DeploymentContributor()

Initializes a new instance of the DeploymentContributor class.

Properties

Canceled

Gets a value that indicates whether the contributor was canceled

CancellationToken

The CancellationToken used to indicate whether contributor execution should be canceled

Methods

Cancel()

Cancels execution of the contributor

Dispose()

Inherited from Dispose()

Dispose(Boolean)
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.

OnEstablishDeploymentConfiguration(DeploymentContributorConfigurationSetup)

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

PublishMessage(ExtensibilityError)

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

Applies to