IBuildAgent Interface

This interface defines methods for accessing the build agent on the Team Foundation Build computer.

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

Syntax

'Declaration
Public Interface IBuildAgent _
    Inherits IBuildGroupItem
public interface IBuildAgent : IBuildGroupItem
public interface class IBuildAgent : IBuildGroupItem
type IBuildAgent =  
    interface 
        interface IBuildGroupItem 
    end
public interface IBuildAgent extends IBuildGroupItem

The IBuildAgent type exposes the following members.

Properties

Name Description
Public property AttachedProperties Attached properties
Public property BuildDirectory Gets or sets a path of the build agent working directory.
Public property Controller Gets or sets the build controller that owns this build agent.
Public property DateCreated Gets the date and time that this agent was created.
Public property DateUpdated Gets the date and time that this agent was last updated.
Public property Description Gets or sets the description of the build agent.
Public property Enabled Gets or sets a flag that describes whether the build agent is enabled.
Public property FullPath Gets the full path of this build group item. (Inherited from IBuildGroupItem.)
Public property IsReserved Gets a flag that describes whether this agent is currently being used by a build.
Public property MessageQueueUrl Gets the message queue address. This field is for system use only.
Public property Name Gets or sets the name of this build group item. (Inherited from IBuildGroupItem.)
Public property ReservedForBuild Gets the identifier of the build that is currently using this agent. Returns null if the agent is not currently being used.
Public property ServiceHost Gets the service host in which this build agent resides.
Public property Status Gets or sets the build agent status.
Public property StatusMessage Gets a message from the build computer about the build agent status.
Public property Tags Gets or sets the tags that are defined for this build agent.
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 Url Gets the URL that is used to communicate with the build agent.

Top

Methods

Name Description
Public method Delete Deletes the build agent from the build computer.
Public method GetExpandedBuildDirectory Gets the build directory for the build agent with all variable expansions evaluated according to the given build definition.
Public method Refresh() Refreshes this build group item by getting current property values from the build server. (Inherited from IBuildGroupItem.)
Public method Refresh(array<String[]) Refresh this build agent by getting updated property values from the server.
Public method Save Saves any changes that were made to the build agent on the build computer.

Top

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace