IBuildServiceHost Interface

Interface for a build service host in the server that is running Team Foundation Build.

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

Syntax

'Declaration
Public Interface IBuildServiceHost
public interface IBuildServiceHost
public interface class IBuildServiceHost
type IBuildServiceHost =  interface end
public interface IBuildServiceHost

The IBuildServiceHost type exposes the following members.

Properties

  Name Description
Public property AcquiredOn Gets the date and time of registration with TFS if this service host is online, else returns DateTime.MinValue.
Public property Agents Gets a read-only collection of agents that is associated with this service host.
Public property BaseUrl Gets or sets the base URL for this service host.
Public property BuildServer Gets the build server for this service host.
Public property ConnectedOn Gets the date and time of connection to the message queue if this service host is online, else returns DateTime.MinValue.
Public property Controller Gets the build controller that is associated with this service host.
Public property IsVirtual Gets a value indicating whether this service host is virtual. A virtual service host is dynamically allocated to computers on demand instead of statically at installation time.
Public property MessageQueueUrl Gets the message queue address. This field is for system use only.
Public property Name Gets or sets the name for this service host.
Public property RequireClientCertificates Gets or sets a flag that describes whether the service host requires client certificates for incoming calls.
Public property Status Gets the online status of the service host.
Public property StatusChangedOn Gets the date and time of the last online/offline status change of the service host.
Public property Uri Gets the uniform resource identifier (URI) for this service host.

Top

Methods

  Name Description
Public method AddBuildAgent Adds a build agent to the collection of agents that are associated with this service host.
Public method CreateBuildAgent(String, String) Creates a build agent that is associated with the current service host and adds it to the collection of agents.
Public method CreateBuildAgent(String, String, IBuildController) Creates a build agent that is associated with the current service host and adds it to the collection of agents.
Public method CreateBuildController Creates a build controller that is associated with the current service host.
Public method Delete Deletes the service host together with all associated controllers and agents.
Public method DeleteBuildAgent Deletes the specified build agent from this service host.
Public method DeleteBuildController Deletes the build controller that is associated with this service host.
Public method FindBuildAgent Gets the build agent that has the specified name and that is associated with the specified build controller.
Public method ReleaseOwnership Releases ownership of the service host.
Public method Save Saves any changes that were made since the last time that the save method was called.
Public method SetBuildAgentStatus Sets the build agent status.
Public method SetBuildController Switches the build controller that is associated with this service host.
Public method SetBuildControllerStatus Sets the build controller status.
Public method TakeOwnership Takes ownership of the service host.

Top

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace