This documentation is archived and is not being maintained.
IBuildServer Interface
Visual Studio 2013
Interface for the server that is running Team Foundation Build.
Namespace: Microsoft.TeamFoundation.Build.Client
Assembly: Microsoft.TeamFoundation.Build.Client (in Microsoft.TeamFoundation.Build.Client.dll)
The IBuildServer type exposes the following members.
| Name | Description | |
|---|---|---|
 | BuildServerVersion | Gets the version of the build server. |
| NoCICheckInComment | Gets the comment string that signals the continuous integration system to ignore a check-in. Any check-in with this string in its comment will not trigger a new build. |
| TeamProjectCollection | Gets the TeamProjectCollection object that created this IBuildServer. |
| Name | Description | |
|---|---|---|
| AddBuildQuality(String, String) | Adds the build quality to the specified team project. |
| AddBuildQuality(String, String()) | Adds the array of build qualities to the specified team project. |
| BeginQueryBuildDefinitions(IBuildDefinitionSpec(), AsyncCallback, Object) | Gets the build definition query results for a given array of build definition specifications. |
| BeginQueryBuildDefinitions(IBuildDefinitionSpec(), Boolean, AsyncCallback, Object) | |
| BeginQueryBuildDefinitionsByUri | Begins an asynchronous operation to query build definitions by uniform resource identifier. |
| BeginQueryBuilds | Begins an asynchronous operation to query builds using an array of specifications. |
| BeginQueryBuildsByUri | Gets the builds that match the given URIs. |
| BeginQueryQueuedBuilds | Begins an asynchronous operation to query the build queue. |
| CancelBuilds(Int32()) | Cancels queued builds with the provided IDs if they are currently in active or postponed states. |
| CancelBuilds(IQueuedBuild()) | Cancels the provided queued builds if they are currently in the active or postponed states. |
| CreateBuildAgentSpec | Creates a new build agent specification that can be used to query build agents. |
| CreateBuildAgentSpec(IBuildAgent) | Creates a new build agent specification that can be used to query build agents. |
| CreateBuildAgentSpec(String, String, List(Of String)) | Creates a new build agent specification that can be used to query build agents. |
| CreateBuildAgentSpec(String, String, String(), List(Of String)) | Creates a new build agent specification that can be used to query build agents. |
| CreateBuildControllerSpec | Creates a new build controller specification that can be used to query build controllers. |
| CreateBuildControllerSpec(String, String) | Creates a new build controller specification that can be used to query build controllers. |
| CreateBuildControllerSpec(String, String, String(), Boolean) | Creates a new build controller specification that can be used to query build controllers. |
| CreateBuildDefinition | Creates a new build definition owned by the build server. |
| CreateBuildDefinitionSpec(String) | Creates a new build definition specification that can be used to query build definitions. |
| CreateBuildDefinitionSpec(IBuildDefinition) | Creates a new build definition specification that can be used to query build definitions. |
| CreateBuildDefinitionSpec(String, String) | Creates a new build definition specification that can be used to query build definitions. |
| CreateBuildDefinitionSpec(String, String, String()) | Creates a new build definition specification that can be used to query build definitions. |
| CreateBuildDetailSpec(IEnumerable(Of Uri)) | Creates a new build detail specification that can be used to query builds for the specified definitions. |
| CreateBuildDetailSpec(String) | Creates a new build detail specification that can be used to query builds for a team project. |
| CreateBuildDetailSpec(IBuildDefinition) | Creates a new build detail specification that can be used to query builds for a team project. |
| CreateBuildDetailSpec(IBuildDefinitionSpec) | Creates a new build detail specification that can be used to query builds for a team project. |
| CreateBuildDetailSpec(String, String) | Creates a new build detail specification that can be used to query builds for a team project. |
| CreateBuildQueueSpec(IEnumerable(Of Uri)) | Creates a new build queue specification that can be used to query queued builds. |
| CreateBuildQueueSpec(String) | Creates a new build queue specification that can be used to query queued builds. |
| CreateBuildQueueSpec(String, String) | Creates a new build queue specification that can be used to query queued builds. |
| CreateBuildRequest(Uri) | Creates a new build request for the specified build definition. |
| CreateBuildRequest(Uri, Uri) | Creates a new build request for the specified build definition and controller. |
| CreateBuildServiceHost(String, Uri) | Creates a new service host with the specified name and base URL. |
| CreateBuildServiceHost(String, String, String, Int32) | Creates a new service host with the specified name, and with a base URL that consists of the specified scheme, host, port, and the default path. |
| CreateProcessTemplate | Creates a new build process template, which will be used by build definitions. |
| CreateQueuedBuildsView | Creates a queued builds view.</ |
| CreateQueuedBuildsView(IEnumerable(Of Uri)) | Creates a queued builds view filtered by the provided definitions. |
| CreateQueuedBuildsView(String) | Creates a queued builds view filtered by team project. |
| CreateTeamProjectComponents | Creates the build components that are needed to create a TeamProject. |
| DeleteBuildAgents(Uri()) | Deletes build agents from the server. |
| DeleteBuildAgents(IBuildAgent()) | Deletes build agents from the server. |
| DeleteBuildControllers(Uri()) | Deletes build controllers from the server. |
| DeleteBuildControllers(IBuildController()) | Deletes build controllers from the server. |
| DeleteBuildDefinitions(Uri()) | Deletes build definitions from the server. |
| DeleteBuildDefinitions(IBuildDefinition()) | Deletes build definitions from the server. |
| DeleteBuildQuality(String, String) | Deletes the specified build quality from the target team project. |
| DeleteBuildQuality(String, String()) | Deletes the specified array of build qualities from the target team project. |
| DeleteBuilds(Uri()) | Deletes builds from the server. All parts of the build are deleted. |
| DeleteBuilds(IBuildDetail()) | Deletes builds from the server. All parts of the build are deleted. |
| DeleteBuilds(Uri(), DeleteOptions) | Deletes builds from the server. |
| DeleteBuilds(IBuildDetail(), DeleteOptions) | Deletes builds from the server. |
| DeleteBuildServiceHost | Deletes the service host and all associated services from the server. |
| DeleteProcessTemplates | Deletes the build process templates from the server. |
| DestroyBuilds(Uri()) | Destroys builds from the server. |
| DestroyBuilds(IBuildDetail()) | Destroys builds from the server. |
| EndQueryBuildDefinitions | Ends an asynchronous operation to query build definitions. |
| EndQueryBuildDefinitionsByUri | Ends an asynchronous operation to query build definitions. |
| EndQueryBuilds | Ends an asynchronous operation to query builds. |
| EndQueryBuildsByUri | |
| EndQueryQueuedBuilds | Ends an asynchronous operation to query the build queue. |
| GetAffectedBuildDefinitions(String()) | Gets an array of all build definitions affected by the specified Version Control server paths. |
| GetAffectedBuildDefinitions(String(), ContinuousIntegrationType) | Obsolete. Gets an array of all build definitions affected by the specified Version Control server paths and are configured to have a trigger supplied in the filter. |
| GetAffectedBuildDefinitions(String(), DefinitionTriggerType) | Gets a list of all build definitions which are affected by the provided TFS Version Control server paths and are configured to have a trigger supplied in the filter. |
| GetAllBuildDetails | Gets a single build with all details. |
| GetBuild(Uri) | Gets a single build. |
| GetBuild(Uri, String(), QueryOptions) | Gets a single build. |
| GetBuild(Uri, String(), QueryOptions, QueryDeletedOption) | Gets a single build by Uri. |
| GetBuild(IBuildDefinitionSpec, String, String(), QueryOptions) | Gets a single build. |
| GetBuildAgent(Uri) | Gets a single build agent. |
| GetBuildAgent(Uri, String()) | Gets a single build agent. |
| GetBuildController(String) | Retrieves a single build controller using the specified display name. A wildcard character may be specified, but if more than one controller is matched than an exception is thrown. |
| GetBuildController(Uri, Boolean) | Gets a single build controller. |
| GetBuildController(Uri, String(), Boolean) | Gets a single build controller. |
| GetBuildDefinition(Uri) | Gets a single build definition. |
| GetBuildDefinition(String, String) | Gets a single build definition. |
| GetBuildDefinition(Uri, QueryOptions) | Gets a single build definition using the specified options to control the amount of data retrieved. |
| GetBuildDefinition(String, String, QueryOptions) | Gets a single build definition using the specified options to control the amount of data retrieved. |
| GetBuildDefinition(Uri, String(), QueryOptions) | Gets a single build definition using the specified options to control the amount of data retrieved. |
| GetBuildQualities | Gets the array of defined build qualities for the target team project. |
| GetBuildServiceHost(String) | Gets the service host that matches the specified name. |
| GetBuildServiceHost(Uri) | Gets the service host that matches the specified URI. |
| GetDisplayText | Gets the localized display text for enumeration values, or the ToString() value. |
| GetDisplayTextValues | Gets an array of the localized display text values for an enumeration, or the ToString value. |
| GetEnumValue | Gets an enumeration value from corresponding localized display text. |
| GetMinimalBuildDetails | Gets a single build without agent, definition, or information nodes. |
| GetQueuedBuild(Int32, QueryOptions) | Gets a single queued build for a specified ID. |
| GetQueuedBuild(Int32(), QueryOptions) | Gets the queued builds for the specified IDs. |
| GetScheduleDaysFromDaysOfWeek | Takes an array of DayOfWeek enumeration values and returns a ScheduleDays value that can be used to set ISchedule.DaysToBuild. |
| QueryBuildAgents(IBuildAgentSpec) | Gets a single build agent query result for a specified build agent specification. |
| QueryBuildAgents(IBuildAgentSpec()) | Gets the build agent query results for the specified build agent specifications. |
| QueryBuildAgentsByUri(Uri()) | Gets the build agents that match the specified URIs. |
| QueryBuildAgentsByUri(Uri(), String()) | Gets the build agents that match the given URIs. |
| QueryBuildControllers | Gets all build controllers and their associated agents. |
| QueryBuildControllers(Boolean) | Gets all build controllers. |
| QueryBuildControllers(IBuildControllerSpec) | Gets a single build controller query result for a specified build controller specification. |
| QueryBuildControllers(IBuildControllerSpec()) | Gets the build controller query results for the specified build controller specifications. |
| QueryBuildControllersByUri(Uri(), Boolean) | Gets the build controllers that match the specified URIs. |
| QueryBuildControllersByUri(Uri(), String(), Boolean) | Gets the build controllers that match the given URIs. |
| QueryBuildDefinitions(String) | Gets the build definitions for the specified team project. |
| QueryBuildDefinitions(IBuildDefinitionSpec) | Gets a single build definition query result for a specified build definition specification. |
| QueryBuildDefinitions(IBuildDefinitionSpec()) | Gets the build definition query results for a specified array of build definition specifications. |
| QueryBuildDefinitions(String, QueryOptions) | Gets the build definitions for the specified team project. The specified query options determine the amount of data that is retrieved in the query. |
| QueryBuildDefinitions(IBuildDefinitionSpec, Boolean) | |
| QueryBuildDefinitions(IBuildDefinitionSpec(), Boolean) | |
| QueryBuildDefinitions(String, QueryOptions, Boolean) | |
| QueryBuildDefinitionsByUri(Uri()) | Gets the build definitions that match the specified URIs. |
| QueryBuildDefinitionsByUri(Uri(), QueryOptions) | Gets the build definitions that match the given URIs. The specified query options determine the amount of data that is retrieved in the query. |
| QueryBuildDefinitionsByUri(Uri(), String(), QueryOptions) | Gets the build definitions that match the given URIs. The specified query options determine the amount of data that is retrieved in the query. |
| QueryBuilds(String) | Gets all builds for a team project. |
| QueryBuilds(IBuildDefinition) | Gets all builds for a build definition. |
| QueryBuilds(IBuildDefinitionSpec) | Gets all builds for a build definition specification. |
| QueryBuilds(IBuildDetailSpec) | Gets a single build query result for the specified build specification. |
| QueryBuilds(IBuildDetailSpec()) | Gets the build query results for the specified list of build specifications. |
| QueryBuilds(String, String) | Gets all builds for a team project and definition. |
| QueryBuildsByUri(Uri(), String(), QueryOptions) | Gets the builds that match the specified URIs. |
| QueryBuildsByUri(Uri(), String(), QueryOptions, QueryDeletedOption) | Gets the builds that match the specified URIs. |
| QueryBuildServiceHosts | Gets an array of all build service hosts that are hosted on the specified computers. |
| QueryBuildServiceHostsByUri | Gets the build service hosts that match the specified URIs. |
| QueryProcessTemplates(String) | Gets all build process templates for a Team Project. |
| QueryProcessTemplates(String, ProcessTemplateType()) | Gets all build process templates for a Team Project of a specified type or types. |
| QueryQueuedBuilds(IQueuedBuildSpec) | Gets a single build query result for a specified queued build specification. |
| QueryQueuedBuilds(IQueuedBuildSpec()) | Gets the build query results for a specified array of queued build specifications. |
| QueueBuild(IBuildDefinition) | Queues a build for the specified build definition with all default options. |
| QueueBuild(IBuildRequest) | Queues a build for the specified build request with default QueueOptions. |
| QueueBuild(IBuildRequest, QueueOptions) | Queues a build for the specified build request. |
| QueueBuild(IEnumerable(Of IBuildRequest), QueueOptions) | Queues builds for the given build requests. |
| RetryQueuedBuilds(IQueuedBuild()) | Retries the specified builds and puts them into a batch together. |
| RetryQueuedBuilds(IQueuedBuild(), Guid) | Retries the specified builds and puts them into a batch together. |
| RetryQueuedBuilds(IQueuedBuild(), Guid, QueuedBuildRetryOption) | Retries the specified builds with the specific retry option and puts all specified builds into a batch together. |
| SaveBuildAgents | Saves any changes that were made to the build agents to the server. |
| SaveBuildControllers | Saves any changes that were made to the build controllers to the server. |
| SaveBuildDefinitions | Saves any changes that were made to the build definitions to the server. |
| SaveBuilds | Saves any changes that were made on the builds to the server. |
| SaveBuildServiceHost | Saves the service host changes to the server. |
| SaveProcessTemplates | Saves any changes that were made to the build process templates to the server. |
| SaveQueuedBuilds | Saves any changes that were made to the queued builds to the server. |
| StartQueuedBuildsNow(Int32()) | Starts queued builds with the provided IDs if they are in a paused definition queue and have a status of Queued. |
| StartQueuedBuildsNow(IQueuedBuild()) | Starts the provided queued builds if they are in a paused definition queue and have a status of Queued. |
| StopBuilds(Uri()) | Stops all builds with the specified URIs. |
| StopBuilds(IBuildDetail()) | Stops the specified builds. |
| TestConnectionForBuildAgent | Instructs application-tier to test connection for build agent and updates the agent status messages. |
| TestConnectionForBuildController | Instructs application-tier to test connection for build controller and updates the controller status messages. |
| TestConnectionsForBuildMachine | Instructs application-tier to test connection for build computer resources and update resource status messages. |
Show: