This documentation is archived and is not being maintained.

IBuildServer Interface

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)

public interface IBuildServer

The IBuildServer type exposes the following members.

  NameDescription
Public propertyBuildServerVersionGets the version of the build server.
Public propertyNoCICheckInCommentGets 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.
Public propertyTeamFoundationServer Obsolete. Gets the TeamFoundationServer object that created this IBuildServer.
Public propertyTeamProjectCollectionGets the TeamProjectCollection object that created this IBuildServer.
Top

  NameDescription
Public methodAddBuildQuality(String, String)Adds the build quality to the specified team project.
Public methodAddBuildQuality(String, String[])Adds the array of build qualities to the specified team project.
Public methodCancelBuilds(Int32[])Cancels queued builds with the provided IDs if they are currently in active or postponed states.
Public methodCancelBuilds(IQueuedBuild[])Cancels the provided queued builds if they are currently in the active or postponed states.
Public methodCreateBuildAgent Obsolete. Creates a new build agent owned by the build server.
Public methodCreateBuildAgentSpec()Creates a new build agent specification that can be used to query build agents.
Public methodCreateBuildAgentSpec(String) Obsolete. Creates a new build agent specification that can be used to query build agents.
Public methodCreateBuildAgentSpec(IBuildAgent)Creates a new build agent specification that can be used to query build agents.
Public methodCreateBuildAgentSpec(String, String) Obsolete. Creates a new build agent specification that can be used to query build agents.
Public methodCreateBuildAgentSpec(String, String, List<String>)Creates a new build agent specification that can be used to query build agents.
Public methodCreateBuildAgentSpec(String, String, String, Int32) Obsolete. Creates a new build agent specification that can be used to query build agents.
Public methodCreateBuildControllerSpec()Creates a new build controller specification that can be used to query build controllers.
Public methodCreateBuildControllerSpec(String, String)Creates a new build controller specification that can be used to query build controllers.
Public methodCreateBuildDefinitionCreates a new build definition owned by the build server.
Public methodCreateBuildDefinitionSpec(String)Creates a new build definition specification that can be used to query build definitions.
Public methodCreateBuildDefinitionSpec(IBuildDefinition)Creates a new build definition specification that can be used to query build definitions.
Public methodCreateBuildDefinitionSpec(String, String)Creates a new build definition specification that can be used to query build definitions.
Public methodCreateBuildDetailSpec(IEnumerable<Uri>)Creates a new build detail specification that can be used to query builds for the specified definitions.
Public methodCreateBuildDetailSpec(String)Creates a new build detail specification that can be used to query builds for a team project.
Public methodCreateBuildDetailSpec(IBuildDefinition)Creates a new build detail specification that can be used to query builds for a team project.
Public methodCreateBuildDetailSpec(IBuildDefinitionSpec)Creates a new build detail specification that can be used to query builds for a team project.
Public methodCreateBuildDetailSpec(String, String)Creates a new build detail specification that can be used to query builds for a team project.
Public methodCreateBuildQueueSpec(IEnumerable<Uri>)Creates a new build queue specification that can be used to query queued builds.
Public methodCreateBuildQueueSpec(String)Creates a new build queue specification that can be used to query queued builds.
Public methodCreateBuildQueueSpec(String, String)Creates a new build queue specification that can be used to query queued builds.
Public methodCreateBuildRequest(Uri)Creates a new build request for the specified build definition.
Public methodCreateBuildRequest(Uri, Uri)Creates a new build request for the specified build definition and controller.
Public methodCreateBuildServiceHost(String, Uri)Creates a new service host with the specified name and base URL.
Public methodCreateBuildServiceHost(String, String, String, Int32)Creates a new service host with the specified name, and with a base URL consisting of the specified scheme, host, port, and the default path.
Public methodCreateProcessTemplateCreates a new build process template, to be used by build definitions.
Public methodCreateQueuedBuildsView()Creates a queued builds view.</
Public methodCreateQueuedBuildsView(IEnumerable<Uri>)Creates a queued builds view filtered by the provided definitions.
Public methodCreateQueuedBuildsView(String)Creates a queued builds view filtered by team project.
Public methodCreateTeamProjectComponentsCreates the build components that are needed to create a TeamProject.
Public methodDeleteBuildAgents(Uri[])Deletes build agents from the server.
Public methodDeleteBuildAgents(IBuildAgent[])Deletes build agents from the server.
Public methodDeleteBuildControllers(Uri[])Deletes build controllers from the server.
Public methodDeleteBuildControllers(IBuildController[])Deletes build controllers from the server.
Public methodDeleteBuildDefinitions(Uri[])Deletes build definitions from the server.
Public methodDeleteBuildDefinitions(IBuildDefinition[])Deletes build definitions from the server.
Public methodDeleteBuildQuality(String, String)Deletes the specified build quality from the target team project.
Public methodDeleteBuildQuality(String, String[])Deletes the specified array of build qualities from the target team project.
Public methodDeleteBuilds(Uri[])Deletes builds from the server. All parts of the build are deleted.
Public methodDeleteBuilds(IBuildDetail[])Deletes builds from the server. All parts of the build are deleted.
Public methodDeleteBuilds(Uri[], DeleteOptions)Deletes builds from the server.
Public methodDeleteBuilds(IBuildDetail[], DeleteOptions)Deletes builds from the server.
Public methodDeleteBuildServiceHostDeletes the service host and all associated services from the server.
Public methodDeleteProcessTemplatesDeletes the build process templates from the server.
Public methodDestroyBuilds(Uri[])Destroys builds from the server.
Public methodDestroyBuilds(IBuildDetail[])Destroys builds from the server.
Public methodEvaluateSchedules Obsolete. This method is called by TfsServerScheduler.
Public methodGetAffectedBuildDefinitions(String[])Gets an array of all build definitions affected by the specified Version Control server paths.
Public methodGetAffectedBuildDefinitions(String[], ContinuousIntegrationType)Gets an array of all build definitions affected by the specified Version Control server paths and are configured with a trigger supplied in the filter.
Public methodGetAllBuildDetailsGets a single build with all details.
Public methodGetBuild(Uri)Gets a single build.
Public methodGetBuild(Uri, String[], QueryOptions)Gets a single build.
Public methodGetBuild(IBuildDefinitionSpec, String, String[], QueryOptions)Gets a single build.
Public methodGetBuildAgentGets a single build agent.
Public methodGetBuildController(String)
Public methodGetBuildController(Uri, Boolean)
Public methodGetBuildDefinition(Uri)Gets a single build definition.
Public methodGetBuildDefinition(String, String)Gets a single build definition.
Public methodGetBuildDefinition(Uri, QueryOptions)Gets a single build definition using the specified options to control the amount of data retrieved.
Public methodGetBuildDefinition(String, String, QueryOptions)Gets a single build definition using the specified options to control the amount of data retrieved.
Public methodGetBuildQualitiesGets the array of defined build qualities for the target team project.
Public methodGetBuildServiceHost(String)Gets the service host that matches the specified name.
Public methodGetBuildServiceHost(Uri)Gets the service host that matches the specified URI.
Public methodGetDisplayTextGets the localized display text for enumeration values, or the ToString() value.
Public methodGetDisplayTextValuesGets an array of the localized display text values for an enumeration, or the ToString value.
Public methodGetEnumValueGets an enumeration value from corresponding localized display text.
Public methodGetMinimalBuildDetailsGets a single build without agent, definition, or information nodes.
Public methodGetQueuedBuild(Int32, QueryOptions)Gets a single queued build for a specified ID.
Public methodGetQueuedBuild(Int32[], QueryOptions)Gets the queued builds for the specified IDs.
Public methodGetScheduleDaysFromDaysOfWeekTakes an array of DayOfWeek enumeration values and returns a ScheduleDays value that can be used to set ISchedule.DaysToBuild.
Public methodProcessChangeset Obsolete. Processes a changeset in Team Foundation version control and queues a new build for all items affected by the check-in and have continuous integration enabled.
Public methodQueryBuildAgents(String) Obsolete. Obsolete. Gets the build agents for the specified team project.
Public methodQueryBuildAgents(IBuildAgentSpec)Gets a single build agent query result for a specified build agent specification.
Public methodQueryBuildAgents(IBuildAgentSpec[])Gets the build agent query results for the specified build agent specifications.
Public methodQueryBuildAgentsByUriGets the build agents that match the specified URIs.
Public methodQueryBuildControllers()Gets all build controllers and their associated agents.
Public methodQueryBuildControllers(Boolean)Gets all build controllers.
Public methodQueryBuildControllers(IBuildControllerSpec)Gets a single build controller query result for a specified build controller specification.
Public methodQueryBuildControllers(IBuildControllerSpec[])Gets the build controller query results for the specified build controller specifications.
Public methodQueryBuildControllersByUriGets the build controllers that match the specified URIs.
Public methodQueryBuildDefinitions(String)Gets the build definitions for the specified team project.
Public methodQueryBuildDefinitions(IBuildDefinitionSpec)Gets a single build definition query result for a specified build definition specification.
Public methodQueryBuildDefinitions(IBuildDefinitionSpec[])Gets the build definition query results for a specified array of build definition specifications.
Public methodQueryBuildDefinitions(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.
Public methodQueryBuildDefinitionsByUri(Uri[])Gets the build definitions that match the specified URIs.
Public methodQueryBuildDefinitionsByUri(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.
Public methodQueryBuilds(String)Gets all builds for a team project.
Public methodQueryBuilds(IBuildDefinition)Gets all builds for a build definition.
Public methodQueryBuilds(IBuildDefinitionSpec)Gets all builds for a build definition specification.
Public methodQueryBuilds(IBuildDetailSpec)Gets a single build query result for the specified build specification.
Public methodQueryBuilds(IBuildDetailSpec[])Gets the build query results for the specified list of build specifications.
Public methodQueryBuilds(String, String)Gets all builds for a team project and definition.
Public methodQueryBuildsByUri(Uri[], String[], QueryOptions)Gets the builds that match the specified URIs.
Public methodQueryBuildsByUri(Uri[], String[], QueryOptions, QueryDeletedOption)Gets the builds that match the specified URIs.
Public methodQueryBuildServiceHostsGets an array of all build service hosts that are hosted on the specified computers.
Public methodQueryBuildServiceHostsByUriGets the build service hosts that match the specified URIs.
Public methodQueryProcessTemplates(String)Gets all build process templates for a Team Project.
Public methodQueryProcessTemplates(String, ProcessTemplateType[])Gets all build process templates for a Team Project of a specified type or types.
Public methodQueryQueuedBuilds(IQueuedBuildSpec)Gets a single build query result for a specified queued build specification.
Public methodQueryQueuedBuilds(IQueuedBuildSpec[])Gets the build query results for a specified array of queued build specifications.
Public methodQueueBuild(IBuildDefinition)Queues a build for the specified build definition with all default options.
Public methodQueueBuild(IBuildRequest)Queues a build for the specified build request with default QueueOptions.
Public methodQueueBuild(IBuildRequest, QueueOptions)Queues a build for the specified build request.
Public methodSaveBuildAgentsSaves any changes made to the build agents to the server.
Public methodSaveBuildControllersSaves any changes made to the build controllers to the server.
Public methodSaveBuildDefinitionsSaves any changes made to the build definitions to the server.
Public methodSaveBuildsSaves any changes made on the builds to the server.
Public methodSaveBuildServiceHostSaves the service host changes to the server.
Public methodSaveProcessTemplatesSaves any changes made to the build process templates to the server.
Public methodSaveQueuedBuildsSaves any changes made to the queued builds to the server.
Public methodStopBuilds(Uri[])Stops all builds with the specified URIs.
Public methodStopBuilds(IBuildDetail[])Stops the specified builds.
Public methodTestConnectionForBuildAgentInstructs application-tier to test connection for build agent and updates the agent status messages.
Public methodTestConnectionForBuildControllerInstructs application-tier to test connection for build controller and updates the controller status messages.
Public methodTestConnectionsForBuildMachineInstructs application-tier to test connection for build machine resources and update resource status messages.
Top
Show: