Export (0) Print
Expand All

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)

public interface IBuildAgent extends IBuildGroupItem

The IBuildAgent type exposes the following members.

  NameDescription
Public propertyAttachedPropertiesAttached properties
Public propertyBuildDirectoryGets or sets a path of the build agent working directory.
Public propertyControllerGets or sets the build controller that owns this build agent.
Public propertyDateCreatedGets the date and time that this agent was created.
Public propertyDateUpdatedGets the date and time that this agent was last updated.
Public propertyDescriptionGets or sets the description of the build agent.
Public propertyEnabledGets or sets a flag that describes whether the build agent is enabled.
Public propertyFullPathGets the full path of this build group item. (Inherited from IBuildGroupItem.)
Public propertyIsReservedGets a flag that describes whether this agent is currently being used by a build.
Public propertyMessageQueueUrlGets the message queue address. This field is for system use only.
Public propertyNameGets or sets the name of this build group item. (Inherited from IBuildGroupItem.)
Public propertyReservedForBuildGets the identifier of the build that is currently using this agent. Returns null if the agent is not currently being used.
Public propertyServiceHostGets the service host in which this build agent resides.
Public propertyStatusGets or sets the build agent status.
Public propertyStatusMessageGets a message from the build computer about the build agent status.
Public propertyTagsGets or sets the tags that are defined for this build agent.
Public propertyTeamProjectGets the team project that owns this build group item. (Inherited from IBuildGroupItem.)
Public propertyUriGets the uniform resource identifier (URI) of this build group item. (Inherited from IBuildGroupItem.)
Public propertyUrlGets the URL that is used to communicate with the build agent.
Top

  NameDescription
Public methodDeleteDeletes the build agent from the build computer.
Public methodGetExpandedBuildDirectoryGets the build directory for the build agent with all variable expansions evaluated according to the given build definition.
Public methodRefresh()Refreshes this build group item by getting current property values from the build server. (Inherited from IBuildGroupItem.)
Public methodRefresh(String[])Refresh this build agent by getting updated property values from the server.
Public methodSaveSaves any changes that were made to the build agent on the build computer.
Top
Show:
© 2014 Microsoft