AdministrationWebService Class

Inheritance Hierarchy


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


<ClientServiceAttribute(ComponentName := "TeamBuild", RegistrationName := "Build",  _
    ServiceName := "AdministrationService", CollectionServiceIdentifier := "d1e9471d-7e69-4210-ad4c-3c941b245e2f")> _
<WebServiceAttribute> _
Public NotInheritable Class AdministrationWebService _
    Inherits BuildWebServiceBase
[ClientServiceAttribute(ComponentName = "TeamBuild", RegistrationName = "Build", 
    ServiceName = "AdministrationService", CollectionServiceIdentifier = "d1e9471d-7e69-4210-ad4c-3c941b245e2f")]
public sealed class AdministrationWebService : BuildWebServiceBase
[ClientServiceAttribute(ComponentName = L"TeamBuild", RegistrationName = L"Build", 
    ServiceName = L"AdministrationService", CollectionServiceIdentifier = L"d1e9471d-7e69-4210-ad4c-3c941b245e2f")]
public ref class AdministrationWebService sealed : public BuildWebServiceBase
[<ClientServiceAttribute(ComponentName = "TeamBuild", RegistrationName = "Build", 
    ServiceName = "AdministrationService", CollectionServiceIdentifier = "d1e9471d-7e69-4210-ad4c-3c941b245e2f")>]
type AdministrationWebService =  
        inherit BuildWebServiceBase 
public final class AdministrationWebService extends BuildWebServiceBase

The AdministrationWebService type exposes the following members.


  Name Description
Public method AdministrationWebService



  Name Description
Public property Application Gets the application object for the current HTTP request. (Inherited from WebService.)
Public property Container Gets the container for the component. (Inherited from MarshalByValueComponent.)
Public property Context Gets the ASP.NET HttpContext for the current request, which encapsulates all HTTP-specific context used by the HTTP server to process Web requests. (Inherited from WebService.)
Public property DesignMode Gets a value indicating whether the component is currently in design mode. (Inherited from MarshalByValueComponent.)
Public property Server Gets the HttpServerUtility for the current request. (Inherited from WebService.)
Public property Session Gets the HttpSessionState instance for the current request. (Inherited from WebService.)
Public property Site Gets or sets the site of the component. (Inherited from MarshalByValueComponent.)
Public property SoapVersion Gets the version of the SOAP protocol used to make the SOAP request to the XML Web service. (Inherited from WebService.)
Public property User Gets the ASP.NET server User object. Can be used to authenticate whether a user is authorized to execute the request. (Inherited from WebService.)



  Name Description
Public method AddBuildAgents Adds build agents with the specified parameters to the system. The build agents that are added must have unique names in the containing service host. Agents can optionally be associated with a build controller when they are added to the system.
Public method AddBuildControllers Adds build controllers with the specified parameters to the system. Only one build controller can be associated with a service host at a time. An attempt to define more than one build controller on a service host causes an exception.
Public method AddBuildServiceHost
Public method DeleteBuildAgents
Public method DeleteBuildControllers
Public method DeleteBuildServiceHost
Public method Dispose Releases all resources used by the MarshalByValueComponent. (Inherited from MarshalByValueComponent.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetService Gets the implementer of the IServiceProvider. (Inherited from MarshalByValueComponent.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method QueryBuildAgents Queries the list of build agents that match the provided specifications. The output list result sets will match up to the index of the spec that produced the result.
Public method QueryBuildAgentsByUri Queries the list of build agents using the provided URIs. If a null or empty list is provided, all of the build agents to which the caller has the appropriate permissions will be returned.
Public method QueryBuildControllers Queries for a set of build controllers given a query specification. The query specification can include wildcard characters for both the controller name and the computer name.
Public method QueryBuildControllersByUri Queries the list of build controllers using the provided URIs. If a null or empty list is provided, all of the build controllers to which the caller has the appropriate permissions will be returned. Agents can be conditionally returned based on the [includeAgents] flag.
Public method QueryBuildServiceHosts
Public method QueryBuildServiceHostsByUri
Public method TestBuildAgentConnection
Public method TestBuildControllerConnection
Public method TestBuildServiceHostConnections
Public method ToString Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from MarshalByValueComponent.)
Public method UpdateBuildAgents Updates build agents using the specified update structure to determine which fields are to be updated on the agent. The only required field is the URI for update, which specifies the agent that should be updated in the call. No results are returned. Therefore a successful update is indirectly signaled by the lack of an exception being thrown.
Public method UpdateBuildControllers Updates the build controllers on the server by using the specified properties. The new object properties overwrite the old properties that existed before the update. If no exception is generated from this method, the passed-in properties are reflected in the database.
Public method UpdateBuildServiceHost



  Name Description
Public event Disposed Adds an event handler to listen to the Disposed event on the component. (Inherited from MarshalByValueComponent.)


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


Microsoft.TeamFoundation.Build.Server.Compatibility Namespace