Partager via


IBuildDefinition Interface

This interface represents a build definition.

Namespace:  Microsoft.TeamFoundation.Build.Client
Assembly:  Microsoft.TeamFoundation.Build.Client (in Microsoft.TeamFoundation.Build.Client.dll)

Syntax

'Déclaration
Public Interface IBuildDefinition _
    Inherits IBuildGroupItem
public interface IBuildDefinition : IBuildGroupItem
public interface class IBuildDefinition : IBuildGroupItem
type IBuildDefinition =  
    interface
        interface IBuildGroupItem
    end
public interface IBuildDefinition extends IBuildGroupItem

The IBuildDefinition type exposes the following members.

Properties

  Name Description
Public property BuildController Gets or sets the build controller that builds this build definition.
Public property BuildControllerUri Gets the uniform resource identifier (URI) of the build controller that builds this build definition.
Public property BuildServer Gets the server or computer that is hosting the build definition.
Public property ConfigurationFolderPath Obsolete. Gets or sets the path of the version control folder that contains the build definition project files (TfsBuild.proj and TfsBuild.rsp).
Public property ContinuousIntegrationQuietPeriod Gets or sets the time (in minutes) of the quiet period that is associated with Batch type continuous integration builds.
Public property ContinuousIntegrationType Gets or sets the continuous integration type of the build definition.
Public property DefaultBuildAgent Obsolete. Gets or sets the default build agent to use for this build definition.
Public property DefaultBuildAgentUri Obsolete. Gets the URI of the default build agent.
Public property DefaultDropLocation Gets or sets the default drop location for builds generated by the build definition.
Public property Description Gets or sets the description for the build definition.
Public property Enabled Gets or sets the enabled status of the build definition.
Public property FullPath Gets the full path of this build group item. (Inherited from IBuildGroupItem.)
Public property Id Gets the ID of this build definition.
Public property LastBuildUri Gets the URI of the last build for the build definition, regardless of status.
Public property LastGoodBuildLabel Gets the name of the label for the last successful build for the build definition.
Public property LastGoodBuildUri Gets the URI for the last successful build for the build definition.
Public property Name Gets or sets the name of this build group item. (Inherited from IBuildGroupItem.)
Public property Process Gets or sets the build process template for this definition.
Public property ProcessParameters Gets an XML formatted string representing all the process parameters for this build.
Public property RetentionPolicies Obsolete. Gets a dictionary of the retention policies for the build definition. The dictionary is indexed by the build status.
Public property RetentionPolicyList Gets a list of retention policies for this build definition.
Public property Schedules Gets a list of schedules for the build definition.
Public property TeamProject Gets the team project that owns this build group item. (Inherited from IBuildGroupItem.)
Public property Uri Gets the uniform resource identifier (URI) of this build group item. (Inherited from IBuildGroupItem.)
Public property Workspace Gets the workspace template for the build definition.

Top

Methods

  Name Description
Public method AddRetentionPolicy Adds a retention policy to the list of retention policies of this build definition.
Public method AddSchedule Adds a schedule to the list of schedules for the build definition. The schedule has no effect if the ContinuousIntegrationType is not Schedule. Only one schedule is accepted in the list.
Public method CreateBuildRequest Creates a build request from the build definition that has values for IBuildAgent and drop location set to the default build agent and default drop location.
Public method CreateManualBuild(String) Creates a build detail record in the Team Foundation Server build database. Build information and other changes can be made to the returned IBuildDetail object.
Public method CreateManualBuild(String, String) Creates a build detail record in the Team Foundation Server build database. Build information and other changes can be made to the returned IBuildDetail object.
Public method CreateManualBuild(String, String, BuildStatus, IBuildController, String) Creates a build detail record in the Team Foundation Server build database.
Public method CreateProjectFile Obsolete. Creates an IProjectFile from the build definition with values for the obsolete properties set to values determined by the build definition.
Public method CreateSpec Creates a new build specification for the build definition.
Public method Delete Deletes the build definition and all its builds from the server.
Public method QueryBuilds Gets all the builds for this build definition.
Public method Refresh Refreshes this build group item by getting current property values from the build server. (Inherited from IBuildGroupItem.)
Public method Save Saves any changes that were made to the IBuildDefinition object to the server.

Top

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace