Update an agent
Request
PUT https://{hostname}:{port}
/build/rest2/agents/{id}
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | true | The identifier to use when looking up an agent. This can be the name or ID of the agent |
This command takes a JSON request string or file. Use the following template for the request:
{
"agentPools": [{
"dynamic": "Whether or not the agent pool is dynamic
agent pool",
"name": "The name of the agent pool"
}],
"description": "The agent description",
"ignored": "Whether or not the server is ignoring the
agent.",
"maxJobs": "The Maximum number of jobs that can run on
this Agent at any single time.",
"name": "The name of the agent",
"properties": [{
"name": "Property name",
"value": "Property value"
}],
"throughput": "The throughput metric setting is used to
determine how likely an agent is to be used for another
job.A weight is applied to the agent using a formula based
on the throughput and the number of active jobs for the
agent.A higher weight means that the agent is more likely
to be chosen for an additional job.The formula is as
follows: Weight = Throughput / (Number of Active Jobs + 1)"
}
