DeploymentPlanContributor Class

  • Article

Represents a contributor to the deployment process in Visual Studio Application Lifecycle Management (ALM).

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.Build.DeploymentContributor
    Microsoft.Data.Schema.Build.DeploymentPlanContributor
      Microsoft.Data.Schema.Build.DeploymentPlanExecutor
      Microsoft.Data.Schema.Build.DeploymentPlanModifier

Namespace:  Microsoft.Data.Schema.Build
Assembly:  Microsoft.Data.Schema (in Microsoft.Data.Schema.dll)

Syntax

'Declaration
Public MustInherit Class DeploymentPlanContributor _
    Inherits DeploymentContributor

public abstract class DeploymentPlanContributor : DeploymentContributor

public ref class DeploymentPlanContributor abstract : public DeploymentContributor

[<AbstractClass>]
type DeploymentPlanContributor =  
    class
        inherit DeploymentContributor
    end

public abstract class DeploymentPlanContributor extends DeploymentContributor

The DeploymentPlanContributor type exposes the following members.

Constructors

  Name Description
Protected method DeploymentPlanContributor Initializes a new instance of the DeploymentPlanContributor class.

Top

Properties

  Name Description
Protected property Canceled Gets a value that indicates whether the contributor was canceled. (Inherited from DeploymentContributor.)

Top

Methods

  Name Description
Public method Cancel Cancels execution of the contributor. (Inherited from DeploymentContributor.)
Public method Dispose() Releases resources. (Inherited from DeploymentContributor.)
Protected method Dispose(Boolean) Releases resources, as specified. (Inherited from DeploymentContributor.)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnApplyDeploymentConfiguration Called by the deployment process in Visual Studio to give your code an opportunity to collect configuration information from the provided files. (Inherited from DeploymentContributor.)
Protected method OnEstablishDeploymentConfiguration Called by the deployment process in Visual Studio to give your code an opportunity to modify deployment configuration. (Inherited from DeploymentContributor.)
Protected method OnExecute Called by the Visual Studio Application Lifecycle Management (ALM) deployment engine to allow custom contributors to execute their unique tasks.
Protected method OnPopulateArguments Called by the Visual Studio Application Lifecycle Management (ALM) deployment engine to allow custom contributors to populate the command line arguments.
Protected method PublishMessage Publishes a message to the deployment engine. The deployment engine will process and report the message to consumers. (Inherited from DeploymentContributor.)
Public method ToString Returns a string that represents the current object. (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.

See Also

Reference

Microsoft.Data.Schema.Build Namespace

DeploymentContributor

BuildContributor

DatabaseSchemaProvider