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.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Build.Server.TeamFoundationBuildService

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

Syntax

'Declaration
Public NotInheritable Class TeamFoundationBuildService _
    Implements ITeamFoundationService

public sealed class TeamFoundationBuildService : ITeamFoundationService

public ref class TeamFoundationBuildService sealed : ITeamFoundationService

[<Sealed>]
type TeamFoundationBuildService =  
    class 
        interface ITeamFoundationService 
    end

public final class TeamFoundationBuildService implements ITeamFoundationService

The TeamFoundationBuildService type exposes the following members.

Methods

	Name	Description
	AddBuildDefinitions	Adds build definitions to the build server. The returned list of build definitions matches the input list so the caller may associate the generated identifiers.
	AddBuildQualities	Adds the specified build qualities to the team project.
	AddProcessTemplates	Adds the specified process templates to the database. The returned list of templates matches the input list so the caller may associate the generated identifiers.
	CancelBuilds	Attempts 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.
	CreateTeamProject	Sets up the permissions and structures needed for a new team project.
	DeleteBuildDefinitions	Deletes build definitions from the server.
	DeleteBuildQualities	Deletes build qualities from the specified team project.
	DeleteBuilds	Deletes 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.
	DeleteProcessTemplates	Deletes process templates from the server.
	DeleteTeamProject	Deletes all objects that belong to the specified team project.
	DestroyBuilds	Permanently removes the specified builds from the database. This operation is destructive. This means that destroyed builds cannot be recovered.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetAffectedBuildDefinitions	Gets 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.
	GetBuildQualities	Retrieves the list of build qualities for the specified team project.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	NotifyBuildCompleted	Notifies the server that the build with the provided URI has completed.
	QueryBuildDefinitions(TeamFoundationRequestContext, BuildDefinitionSpec)	Queries build definitions using the provided query specification.
	QueryBuildDefinitions(TeamFoundationRequestContext, IList<BuildDefinitionSpec>)
	QueryBuildDefinitionsByUri
	QueryBuilds
	QueryBuildsByUri
	QueryProcessTemplates	Queries for the list of process templates in the specified team project.
	QueryProcessTemplatesById	Queries process templates by ID.
	QueryQueuedBuilds	Queries the build queue using the input specifications.
	QueryQueuedBuildsById	Queries the build queue by ID.
	QueueBuilds	Queues builds using the requests and specified options. If any requests fail for any reason, the whole method fails and no requests are queued.
	RequestIntermediateLogs	Requests the intermediate diagnostics logs to be available under the drop location.
	StartQueuedBuildsNow
	StopBuilds	Stops builds with the provided URIs if they are currently in progress.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateBuildDefinitions	Updates existing build definitions. The [Process] and [WorkspaceTemplate] properties may be left null if they should remain unchanged.
	UpdateBuildInformation	Adds, updates, or deletes build information for a set of builds. The output list is indexed parallel to the input list for easy association.
	UpdateBuilds	Updates existing builds using the provided updates.
	UpdateProcessTemplates	Updates existing process templates using the provided objects.
	UpdateQueuedBuilds	Updates the build queue using the provided updates.

Top

Explicit Interface Implementations

	Name	Description
	ITeamFoundationService.ServiceEnd
	ITeamFoundationService.ServiceStart

Top

Thread Safety

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

See Also

Reference

Microsoft.TeamFoundation.Build.Server Namespace