Share via


AdministrationWebService4.QueryBuildControllersByUri Method

Queries the list of build controllers using the provided URIs. If a null or empty list is provided, then all of the build controllers to which the caller has the appropriate permissions will be returned. Agents may be conditionally returned based on the [includeAgents] flag.

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Function QueryBuildControllersByUri ( _
    controllerUris As String(), _
    propertyNameFilters As String(), _
    includeAgents As Boolean _
) As BuildControllerQueryResult
[WebMethodAttribute]
public BuildControllerQueryResult QueryBuildControllersByUri(
    string[] controllerUris,
    string[] propertyNameFilters,
    bool includeAgents
)
[WebMethodAttribute]
public:
BuildControllerQueryResult^ QueryBuildControllersByUri(
    array<String^>^ controllerUris, 
    array<String^>^ propertyNameFilters, 
    bool includeAgents
)
[<WebMethodAttribute>]
member QueryBuildControllersByUri : 
        controllerUris:string[] * 
        propertyNameFilters:string[] * 
        includeAgents:bool -> BuildControllerQueryResult
public function QueryBuildControllersByUri(
    controllerUris : String[], 
    propertyNameFilters : String[], 
    includeAgents : boolean
) : BuildControllerQueryResult

Parameters

  • controllerUris
    Type: array<System.String[]

    The list of controllers that should be queried.

  • propertyNameFilters
    Type: array<System.String[]

    A list of property names that should be included.

  • includeAgents
    Type: System.Boolean

    Controls whether the corresponding agents should be returned.

Return Value

Type: Microsoft.TeamFoundation.Build.Server.BuildControllerQueryResult
A list of build controllers queried to which the caller has appropriate permissions.

.NET Framework Security

See Also

Reference

AdministrationWebService4 Class

Microsoft.TeamFoundation.Build.Server Namespace