AgentsController Class

Article
07/02/2014

Controller to handle all REST calls against build agents

Inheritance Hierarchy

System.Object
  System.Web.Http.ApiController
    Microsoft.TeamFoundation.Framework.Server.TfsApiController
      Microsoft.TeamFoundation.Build.Server.Rest.AgentsController

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

Syntax

'Declaration
<ControllerApiVersionAttribute()> _
<VersionedApiControllerCustomNameAttribute(Area := "Build", ResourceName := "Agents")> _
Public Class AgentsController _
    Inherits TfsApiController

[ControllerApiVersionAttribute()]
[VersionedApiControllerCustomNameAttribute(Area = "Build", ResourceName = "Agents")]
public class AgentsController : TfsApiController

[ControllerApiVersionAttribute()]
[VersionedApiControllerCustomNameAttribute(Area = L"Build", ResourceName = L"Agents")]
public ref class AgentsController : public TfsApiController

[<ControllerApiVersionAttribute()>]
[<VersionedApiControllerCustomNameAttribute(Area = "Build", ResourceName = "Agents")>]
type AgentsController =  
    class 
        inherit TfsApiController 
    end

public class AgentsController extends TfsApiController

The AgentsController type exposes the following members.

Constructors

	Name	Description
	AgentsController

Top

Properties

	Name	Description
	BaseHttpExceptions	(Inherited from TfsApiController.)
	Configuration	(Inherited from ApiController.)
	ControllerContext	(Inherited from ApiController.)
	HttpExceptions	(Overrides TfsApiController.HttpExceptions.)
	ModelState	(Inherited from ApiController.)
	Request	(Inherited from ApiController.)
	RequestContext	The Setter is only for Unit testing purposes (Inherited from TfsApiController.)
	TraceArea	(Overrides TfsApiController.TraceArea.)
	Url	(Inherited from ApiController.)
	User	(Inherited from ApiController.)

Top

Methods

	Name	Description
	DeleteAgentById	Delete a specific build agent
	Dispose()	(Inherited from ApiController.)
	Dispose(Boolean)	(Inherited from ApiController.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExecuteAsync	(Inherited from ApiController.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAgentById	Get a specific build agent
	GetAgents	Get build agents
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	(Inherited from TfsApiController.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	GenerateResponse	(Defined by TfsApiControllerExtensions.)

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.

Partager via