Reserves an agent for use by a build that matches the input name specification and required tags.
Namespace: Microsoft.TeamFoundation.Build.Server
Assembly: Microsoft.TeamFoundation.Build.Server (in Microsoft.TeamFoundation.Build.Server.dll)
Syntax
'Declaration
<WebMethodAttribute> _
<ClientServiceMethodAttribute(AsyncPattern := True, SyncPattern := True)> _
Public Function ReserveAgent ( _
buildUri As String, _
name As String, _
requiredTags As List(Of String), _
tagComparison As TagComparison _
) As AgentReservation
[WebMethodAttribute]
[ClientServiceMethodAttribute(AsyncPattern = true, SyncPattern = true)]
public AgentReservation ReserveAgent(
string buildUri,
string name,
List<string> requiredTags,
TagComparison tagComparison
)
[WebMethodAttribute]
[ClientServiceMethodAttribute(AsyncPattern = true, SyncPattern = true)]
public:
AgentReservation^ ReserveAgent(
String^ buildUri,
String^ name,
List<String^>^ requiredTags,
TagComparison tagComparison
)
[<WebMethodAttribute>]
[<ClientServiceMethodAttribute(AsyncPattern = true, SyncPattern = true)>]
member ReserveAgent :
buildUri:string *
name:string *
requiredTags:List<string> *
tagComparison:TagComparison -> AgentReservation
public function ReserveAgent(
buildUri : String,
name : String,
requiredTags : List<String>,
tagComparison : TagComparison
) : AgentReservation
Parameters
buildUri
Type: System.StringThe build that is making the reservation.
name
Type: System.StringThe name of the agent to reserve (wildcard character supported).
requiredTags
Type: System.Collections.Generic.List<String>The list of required tags for the reservation (optional).
- tagComparison
Type: Microsoft.TeamFoundation.Build.Server.TagComparison
Return Value
Type: Microsoft.TeamFoundation.Build.Server.AgentReservation
An agent reservation that represents the agent request.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.