IBuildAgent Interface
This interface defines methods for accessing the build agent on the Team Foundation Build computer.
Assembly: Microsoft.TeamFoundation.Build.Client (in Microsoft.TeamFoundation.Build.Client.dll)
The IBuildAgent type exposes the following members.
| Name | Description | |
|---|---|---|
|
BuildDirectory | Gets or sets a path of the build agent working directory. |
|
|
BuildServer | Obsolete. Gets an IBuildServer of the server that owns the build agent. |
|
|
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. |
|
|
MachineName | Obsolete. Gets or sets the computer name for the build agent. |
|
|
MaxProcesses | Obsolete. Gets or sets the maximum number of processes to use for the build agent. |
|
|
Name | Gets or sets the name of this build group item. (Inherited from IBuildGroupItem.) |
|
|
Port | Obsolete. Gets or sets the port number for the build agent. |
|
|
QueueCount | Obsolete. Gets the current queue count for the build agent. All queue statuses are included in this count. |
|
|
RequireSecureChannel | Obsolete. Obsolete. Do not use. |
|
|
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. |
| Name | Description | |
|---|---|---|
|
CopyTo | Obsolete. Creates a copy of the build agent in the specified team project. |
|
|
CreateSpec | Obsolete. Creates a new build agent specification for this build agent. |
|
|
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.) |
|
|
Save | Saves any changes that were made to the build agent on the build computer. |
