Share via

IBuildServer Interface

  • Article

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)

Syntax

'Declaration
Public Interface IBuildServer

public interface IBuildServer

public interface class IBuildServer

type IBuildServer =  interface end

public interface IBuildServer

The IBuildServer type exposes the following members.

Properties

  Name Description
Public property BuildServerVersion Gets the version of the build server.
Public property 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.
Public property TeamProjectCollection Gets the TeamProjectCollection object that created this IBuildServer.

Top

Methods

  Name Description
Public method AddBuildQuality(String, String) Adds the build quality to the specified team project.
Public method AddBuildQuality(String, array<String[]) Adds the array of build qualities to the specified team project.
Public method BeginQueryBuildDefinitions Gets the build definition query results for a given array of build definition specifications.
Public method BeginQueryBuildDefinitionsByUri Begins an asynchronous operation to query build definitions by uniform resource identifier.
Public method BeginQueryBuilds Begins an asynchronous operation to query builds using an array of specifications.
Public method BeginQueryBuildsByUri Gets the builds that match the given URIs.
Public method BeginQueryQueuedBuilds Begins an asynchronous operation to query the build queue.
Public method CancelBuilds(array<Int32[]) Cancels queued builds with the provided IDs if they are currently in active or postponed states.
Public method CancelBuilds(array<IQueuedBuild[]) Cancels the provided queued builds if they are currently in the active or postponed states.
Public method CreateBuildAgentSpec() Creates a new build agent specification that can be used to query build agents.
Public method CreateBuildAgentSpec(IBuildAgent) Creates a new build agent specification that can be used to query build agents.
Public method CreateBuildAgentSpec(String, String, List<String>) Creates a new build agent specification that can be used to query build agents.
Public method CreateBuildAgentSpec(String, String, array<String[], List<String>) Creates a new build agent specification that can be used to query build agents.
Public method CreateBuildControllerSpec() Creates a new build controller specification that can be used to query build controllers.
Public method CreateBuildControllerSpec(String, String) Creates a new build controller specification that can be used to query build controllers.
Public method CreateBuildControllerSpec(String, String, array<String[], Boolean) Creates a new build controller specification that can be used to query build controllers.
Public method CreateBuildDefinition Creates a new build definition owned by the build server.
Public method CreateBuildDefinitionSpec(String) Creates a new build definition specification that can be used to query build definitions.
Public method CreateBuildDefinitionSpec(IBuildDefinition) Creates a new build definition specification that can be used to query build definitions.
Public method CreateBuildDefinitionSpec(String, String) Creates a new build definition specification that can be used to query build definitions.
Public method CreateBuildDefinitionSpec(String, String, array<String[]) Creates a new build definition specification that can be used to query build definitions.
Public method CreateBuildDetailSpec(IEnumerable<Uri>) Creates a new build detail specification that can be used to query builds for the specified definitions.
Public method CreateBuildDetailSpec(String) Creates a new build detail specification that can be used to query builds for a team project.
Public method CreateBuildDetailSpec(IBuildDefinition) Creates a new build detail specification that can be used to query builds for a team project.
Public method CreateBuildDetailSpec(IBuildDefinitionSpec) Creates a new build detail specification that can be used to query builds for a team project.
Public method CreateBuildDetailSpec(String, String) Creates a new build detail specification that can be used to query builds for a team project.
Public method CreateBuildQueueSpec(IEnumerable<Uri>) Creates a new build queue specification that can be used to query queued builds.
Public method CreateBuildQueueSpec(String) Creates a new build queue specification that can be used to query queued builds.
Public method CreateBuildQueueSpec(String, String) Creates a new build queue specification that can be used to query queued builds.
Public method CreateBuildRequest(Uri) Creates a new build request for the specified build definition.
Public method CreateBuildRequest(Uri, Uri) Creates a new build request for the specified build definition and controller.
Public method CreateBuildServiceHost(String, Uri) Creates a new service host with the specified name and base URL.
Public method 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.
Public method CreateProcessTemplate Creates a new build process template, which will be used by build definitions.
Public method CreateQueuedBuildsView() Creates a queued builds view.</
Public method CreateQueuedBuildsView(IEnumerable<Uri>) Creates a queued builds view filtered by the provided definitions.
Public method CreateQueuedBuildsView(String) Creates a queued builds view filtered by team project.
Public method CreateTeamProjectComponents Creates the build components that are needed to create a TeamProject.
Public method DeleteBuildAgents(array<Uri[]) Deletes build agents from the server.
Public method DeleteBuildAgents(array<IBuildAgent[]) Deletes build agents from the server.
Public method DeleteBuildControllers(array<Uri[]) Deletes build controllers from the server.
Public method DeleteBuildControllers(array<IBuildController[]) Deletes build controllers from the server.
Public method DeleteBuildDefinitions(array<Uri[]) Deletes build definitions from the server.
Public method DeleteBuildDefinitions(array<IBuildDefinition[]) Deletes build definitions from the server.
Public method DeleteBuildQuality(String, String) Deletes the specified build quality from the target team project.
Public method DeleteBuildQuality(String, array<String[]) Deletes the specified array of build qualities from the target team project.
Public method DeleteBuilds(array<Uri[]) Deletes builds from the server. All parts of the build are deleted.
Public method DeleteBuilds(array<IBuildDetail[]) Deletes builds from the server. All parts of the build are deleted.
Public method DeleteBuilds(array<Uri[], DeleteOptions) Deletes builds from the server.
Public method DeleteBuilds(array<IBuildDetail[], DeleteOptions) Deletes builds from the server.
Public method DeleteBuildServiceHost Deletes the service host and all associated services from the server.
Public method DeleteProcessTemplates Deletes the build process templates from the server.
Public method DestroyBuilds(array<Uri[]) Destroys builds from the server.
Public method DestroyBuilds(array<IBuildDetail[]) Destroys builds from the server.
Public method EndQueryBuildDefinitions Ends an asynchronous operation to query build definitions.
Public method EndQueryBuildDefinitionsByUri Ends an asynchronous operation to query build definitions.
Public method EndQueryBuilds Ends an asynchronous operation to query builds.
Public method EndQueryBuildsByUri
Public method EndQueryQueuedBuilds Ends an asynchronous operation to query the build queue.
Public method GetAffectedBuildDefinitions(array<String[]) Gets an array of all build definitions affected by the specified Version Control server paths.
Public method GetAffectedBuildDefinitions(array<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.
Public method GetAffectedBuildDefinitions(array<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.
Public method GetAllBuildDetails Gets a single build with all details.
Public method GetBuild(Uri) Gets a single build.
Public method GetBuild(Uri, array<String[], QueryOptions) Gets a single build.
Public method GetBuild(Uri, array<String[], QueryOptions, QueryDeletedOption) Gets a single build by Uri.
Public method GetBuild(IBuildDefinitionSpec, String, array<String[], QueryOptions) Gets a single build.
Public method GetBuildAgent(Uri) Gets a single build agent.
Public method GetBuildAgent(Uri, array<String[]) Gets a single build agent.
Public method 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.
Public method GetBuildController(Uri, Boolean) Gets a single build controller.
Public method GetBuildController(Uri, array<String[], Boolean) Gets a single build controller.
Public method GetBuildDefinition(Uri) Gets a single build definition.
Public method GetBuildDefinition(String, String) Gets a single build definition.
Public method GetBuildDefinition(Uri, QueryOptions) Gets a single build definition using the specified options to control the amount of data retrieved.
Public method GetBuildDefinition(String, String, QueryOptions) Gets a single build definition using the specified options to control the amount of data retrieved.
Public method GetBuildDefinition(Uri, array<String[], QueryOptions) Gets a single build definition using the specified options to control the amount of data retrieved.
Public method GetBuildQualities Gets the array of defined build qualities for the target team project.
Public method GetBuildServiceHost(String) Gets the service host that matches the specified name.
Public method GetBuildServiceHost(Uri) Gets the service host that matches the specified URI.
Public method GetDisplayText Gets the localized display text for enumeration values, or the ToString() value.
Public method GetDisplayTextValues Gets an array of the localized display text values for an enumeration, or the ToString value.
Public method GetEnumValue Gets an enumeration value from corresponding localized display text.
Public method GetMinimalBuildDetails Gets a single build without agent, definition, or information nodes.
Public method GetQueuedBuild(Int32, QueryOptions) Gets a single queued build for a specified ID.
Public method GetQueuedBuild(array<Int32[], QueryOptions) Gets the queued builds for the specified IDs.
Public method GetScheduleDaysFromDaysOfWeek Takes an array of DayOfWeek enumeration values and returns a ScheduleDays value that can be used to set ISchedule.DaysToBuild.
Public method QueryBuildAgents(IBuildAgentSpec) Gets a single build agent query result for a specified build agent specification.
Public method QueryBuildAgents(array<IBuildAgentSpec[]) Gets the build agent query results for the specified build agent specifications.
Public method QueryBuildAgentsByUri(array<Uri[]) Gets the build agents that match the specified URIs.
Public method QueryBuildAgentsByUri(array<Uri[], array<String[]) Gets the build agents that match the given URIs.
Public method QueryBuildControllers() Gets all build controllers and their associated agents.
Public method QueryBuildControllers(Boolean) Gets all build controllers.
Public method QueryBuildControllers(IBuildControllerSpec) Gets a single build controller query result for a specified build controller specification.
Public method QueryBuildControllers(array<IBuildControllerSpec[]) Gets the build controller query results for the specified build controller specifications.
Public method QueryBuildControllersByUri(array<Uri[], Boolean) Gets the build controllers that match the specified URIs.
Public method QueryBuildControllersByUri(array<Uri[], array<String[], Boolean) Gets the build controllers that match the given URIs.
Public method QueryBuildDefinitions(String) Gets the build definitions for the specified team project.
Public method QueryBuildDefinitions(IBuildDefinitionSpec) Gets a single build definition query result for a specified build definition specification.
Public method QueryBuildDefinitions(array<IBuildDefinitionSpec[]) Gets the build definition query results for a specified array of build definition specifications.
Public method 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.
Public method QueryBuildDefinitionsByUri(array<Uri[]) Gets the build definitions that match the specified URIs.
Public method QueryBuildDefinitionsByUri(array<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 method QueryBuildDefinitionsByUri(array<Uri[], array<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.
Public method QueryBuilds(String) Gets all builds for a team project.
Public method QueryBuilds(IBuildDefinition) Gets all builds for a build definition.
Public method QueryBuilds(IBuildDefinitionSpec) Gets all builds for a build definition specification.
Public method QueryBuilds(IBuildDetailSpec) Gets a single build query result for the specified build specification.
Public method QueryBuilds(array<IBuildDetailSpec[]) Gets the build query results for the specified list of build specifications.
Public method QueryBuilds(String, String) Gets all builds for a team project and definition.
Public method QueryBuildsByUri(array<Uri[], array<String[], QueryOptions) Gets the builds that match the specified URIs.
Public method QueryBuildsByUri(array<Uri[], array<String[], QueryOptions, QueryDeletedOption) Gets the builds that match the specified URIs.
Public method QueryBuildServiceHosts Gets an array of all build service hosts that are hosted on the specified computers.
Public method QueryBuildServiceHostsByUri Gets the build service hosts that match the specified URIs.
Public method QueryProcessTemplates(String) Gets all build process templates for a Team Project.
Public method QueryProcessTemplates(String, array<ProcessTemplateType[]) Gets all build process templates for a Team Project of a specified type or types.
Public method QueryQueuedBuilds(IQueuedBuildSpec) Gets a single build query result for a specified queued build specification.
Public method QueryQueuedBuilds(array<IQueuedBuildSpec[]) Gets the build query results for a specified array of queued build specifications.
Public method QueueBuild(IBuildDefinition) Queues a build for the specified build definition with all default options.
Public method QueueBuild(IBuildRequest) Queues a build for the specified build request with default QueueOptions.
Public method QueueBuild(IBuildRequest, QueueOptions) Queues a build for the specified build request.
Public method QueueBuild(IEnumerable<IBuildRequest>, QueueOptions) Queues builds for the given build requests.
Public method RetryQueuedBuilds(array<IQueuedBuild[]) Retries the specified builds and puts them into a batch together.
Public method RetryQueuedBuilds(array<IQueuedBuild[], Guid) Retries the specified builds and puts them into a batch together.
Public method RetryQueuedBuilds(array<IQueuedBuild[], Guid, QueuedBuildRetryOption) Retries the specified builds with the specific retry option and puts all specified builds into a batch together.
Public method SaveBuildAgents Saves any changes that were made to the build agents to the server.
Public method SaveBuildControllers Saves any changes that were made to the build controllers to the server.
Public method SaveBuildDefinitions Saves any changes that were made to the build definitions to the server.
Public method SaveBuilds Saves any changes that were made on the builds to the server.
Public method SaveBuildServiceHost Saves the service host changes to the server.
Public method SaveProcessTemplates Saves any changes that were made to the build process templates to the server.
Public method SaveQueuedBuilds Saves any changes that were made to the queued builds to the server.
Public method StartQueuedBuildsNow(array<Int32[]) Starts queued builds with the provided IDs if they are in a paused definition queue and have a status of Queued.
Public method StartQueuedBuildsNow(array<IQueuedBuild[]) Starts the provided queued builds if they are in a paused definition queue and have a status of Queued.
Public method StopBuilds(array<Uri[]) Stops all builds with the specified URIs.
Public method StopBuilds(array<IBuildDetail[]) Stops the specified builds.
Public method TestConnectionForBuildAgent Instructs application-tier to test connection for build agent and updates the agent status messages.
Public method TestConnectionForBuildController Instructs application-tier to test connection for build controller and updates the controller status messages.
Public method TestConnectionsForBuildMachine Instructs application-tier to test connection for build computer resources and update resource status messages.

Top

See Also

Reference

Microsoft.TeamFoundation.Build.Client Namespace