TeamFoundationBuildService Class

  • Article

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
Public method 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.
Public method AddBuildQualities Adds the specified build qualities to the team project.
Public method 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.
Public method 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.
Public method CreateBuiltInProcessTemplates Creates the built-in process templates. NOTE: Do not call this method to replace existing templates. This code is for adding new templates only.
Public method CreateTeamProject Sets up the permissions and structures needed for a new team project.
Public method DeleteBuildDefinitions Deletes build definitions from the server.
Public method DeleteBuildQualities Deletes build qualities from the specified team project.
Public method 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.
Public method DeleteProcessTemplates Deletes process templates from the server.
Public method DeleteTeamProject Deletes all objects that belong to the specified team project.
Public method DeployTemplateToTfs Deploys 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 method DestroyBuilds Permanently removes the specified builds from the database. This operation is destructive. This means that destroyed builds cannot be recovered.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method 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.
Public method GetBuildQualities Retrieves the list of build qualities for the specified team project.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method NotifyBuildCompleted Notifies the server that the build with the provided URI has completed.
Public method QueryBuildDefinitions(TeamFoundationRequestContext, BuildDefinitionSpec, Boolean)
Public method QueryBuildDefinitions(TeamFoundationRequestContext, IList<BuildDefinitionSpec>, Boolean)
Public method QueryBuildDefinitionsByUri
Public method QueryBuilds
Public method QueryBuildsByUri
Public method QueryProcessTemplates Queries for the list of process templates in the specified team project.
Public method QueryProcessTemplatesById Queries process templates by ID.
Public method QueryQueuedBuilds Queries the build queue using the input specifications.
Public method QueryQueuedBuildsById Queries the build queue by ID.
Public method 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.
Public method RequestIntermediateLogs Requests the intermediate diagnostics logs to be available under the drop location.
Public method StartQueuedBuildsNow
Public method StopBuildRequest
Public method StopBuilds Stops builds with the provided URIs if they are currently in progress.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UpdateBuildDefinitions Updates existing build definitions. The Process and WorkspaceTemplate properties may be left null if they should remain unchanged.
Public method 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.
Public method UpdateBuilds Updates existing builds using the provided updates.
Public method UpdateProcessTemplates Updates existing process templates using the provided objects.
Public method UpdateQueuedBuilds Updates the build queue using the provided updates.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ITeamFoundationService.ServiceEnd
Explicit interface implemetationPrivate method 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