Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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 | |
|---|---|---|
.gif "Public property") |
AttachedProperties | Attached properties |
|
BuildDirectory | Gets or sets a path of the build agent working directory. |
|
Controller | Gets or sets the build controller that owns this build agent. |
|
DateCreated | Gets the date and time that this agent was created. |
|
DateUpdated | Gets the date and time that this agent was last updated. |
|
Description | Gets or sets the description of the build agent. |
|
Enabled | Gets or sets a flag that describes whether the build agent is enabled. |
|
FullPath | Gets the full path of this build group item. (Inherited from IBuildGroupItem.) |
|
IsReserved | Gets a flag that describes whether this agent is currently being used by a build. |
|
MessageQueueUrl | Gets the message queue address. This field is for system use only. |
|
Name | Gets or sets the name of this build group item. (Inherited from IBuildGroupItem.) |
|
ReservedForBuild | Gets the identifier of the build that is currently using this agent. Returns null if the agent is not currently being used. |
|
ServiceHost | Gets the service host in which this build agent resides. |
|
Status | Gets or sets the build agent status. |
|
StatusMessage | Gets a message from the build computer about the build agent status. |
|
Tags | Gets or sets the tags that are defined for this build agent. |
|
TeamProject | Gets the team project that owns this build group item. (Inherited from IBuildGroupItem.) |
|
Uri | Gets the uniform resource identifier (URI) of this build group item. (Inherited from IBuildGroupItem.) |
|
Url | Gets the URL that is used to communicate with the build agent. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Delete | Deletes the build agent from the build computer. |
|
GetExpandedBuildDirectory | Gets the build directory for the build agent with all variable expansions evaluated according to the given build definition. |
|
Refresh() | Refreshes this build group item by getting current property values from the build server. (Inherited from IBuildGroupItem.) |
|
Refresh(array<String[]) | Refresh this build agent by getting updated property values from the server. |
|
Save | Saves any changes that were made to the build agent on the build computer. |
Top