This documentation is archived and is not being maintained.

TeamFoundationBuildService Class

Provides methods for manipulating builds, build definitions, process templates, and the build queue. Use TeamFoundationServiceHost.GetService<T>() or TeamFoundationRequestContext.GetService<T>() to obtain an instance of this class.


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

public sealed class TeamFoundationBuildService : ITeamFoundationService

The TeamFoundationBuildService type exposes the following members.

Public methodAddBuildDefinitionsAdds build definitions to the build server. The returned list of build definitions matches the input list so the caller may associate the generated identifiers.
Public methodAddBuildQualitiesAdds the specified build qualities to the team project.
Public methodAddProcessTemplatesAdds the specified process templates to the database. The returned list of templates matches the input list so the caller may associate the generated identifiers.
Public methodCancelBuildsAttempts to cancel queued builds with the provided IDs. If the build has already started, is already completed, or does not exist, an exception is thrown.
Public methodCreateBuiltInProcessTemplatesCreates the built-in process templates. NOTE: Do not call this method to replace existing templates. This code is for adding new templates only.
Public methodCreateTeamProjectSets up the permissions and structures needed for a new team project.
Public methodDeleteBuildDefinitionsDeletes build definitions from the server.
Public methodDeleteBuildQualitiesDeletes build qualities from the specified team project.
Public methodDeleteBuildsDeletes builds and supporting data. Labels, test results, and test impact data are deleted synchronously.Build binaries and symbols are queued and deleted as a background job.
Public methodDeleteProcessTemplatesDeletes process templates from the server.
Public methodDeleteTeamProjectDeletes all objects that belong to the specified team project.
Public methodDeployTemplateToTfsDeploys the passed in Build Process Template XAML to the File Container Service. It will create a new File Container and Container Item if necessary, then upload the file.
Public methodDestroyBuildsPermanently removes the specified builds from the database. This operation is destructive. This means that destroyed builds cannot be recovered.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetAffectedBuildDefinitionsGets the list of build definitions affected by the provided version control server paths. The continuous integration type is an optional filter to additionally restrict the build definitions that are returned.
Public methodGetBuildQualitiesRetrieves the list of build qualities for the specified team project.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodNotifyBuildCompletedNotifies the server that the build with the provided URI has completed.
Public methodQueryBuildDefinitions(TeamFoundationRequestContext, BuildDefinitionSpec, Boolean)
Public methodQueryBuildDefinitions(TeamFoundationRequestContext, IList<BuildDefinitionSpec>, Boolean)
Public methodQueryBuildDefinitionsByUri
Public methodQueryBuilds
Public methodQueryBuildsByUri
Public methodQueryProcessTemplatesQueries for the list of process templates in the specified team project.
Public methodQueryProcessTemplatesByIdQueries process templates by ID.
Public methodQueryQueuedBuildsQueries the build queue using the input specifications.
Public methodQueryQueuedBuildsByIdQueries the build queue by ID.
Public methodQueueBuildsQueues builds using the requests and specified options. If any requests fail for any reason, the whole method fails and no requests are queued.
Public methodRequestIntermediateLogsRequests the intermediate diagnostics logs to be available under the drop location.
Public methodStartQueuedBuildsNow
Public methodStopBuildRequest
Public methodStopBuildsStops builds with the provided URIs if they are currently in progress.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUpdateBuildDefinitionsUpdates existing build definitions. The Process and WorkspaceTemplate properties may be left null if they should remain unchanged.
Public methodUpdateBuildInformationAdds, updates, or deletes build information for a set of builds. The output list is indexed parallel to the input list for easy association.
Public methodUpdateBuildsUpdates existing builds using the provided updates.
Public methodUpdateProcessTemplatesUpdates existing process templates using the provided objects.
Public methodUpdateQueuedBuildsUpdates the build queue using the provided updates.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.