AgentPools
Retrieves a list of agent pools.
Table Specific Information
Select
The driver uses the Azure DevOps API to process WHERE clause conditions built with the following columns and operators:
- Id supports the '=,in' operators.
- PoolType supports the '=' operator.
- Action supports the '=' operator.
- Properties supports the 'in' operator.
For example:
SELECT * FROM AgentPools WHERE Id IN (1,2,3) SELECT * FROM AgentPools WHERE Id = 9 SELECT * FROM AgentPools WHERE PoolType = 'deployment' SELECT * FROM AgentPools WHERE Action = 'manage'
Insert
The following are examples of inserting into an AgentPools table:
INSERT INTO AgentPools (Name) VALUES ('PoolA')
INSERT INTO AgentPools (IsHosted,CreatedByDisplayName,AgentCloudId,Name) VALUES (false,'Cdata',1,'Cdata_Ecity')
Update
The following is an example of updating an AgentPools table:
UPDATE AgentPools SET Name = 'Data1' WHERE Id = 1
Delete
The following is an example of deleting data in an AgentPools table:
DELETE FROM AgentPools WHERE Id = '1'
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Integer | True |
Id of the agent pool. | |
| AgentCloudId | Integer | False |
The ID of the associated agent cloud. | |
| AutoProvision | Boolean | False |
Whether or not a queue should be automatically provisioned for each project collection. | |
| AutoSize | Boolean | False |
Whether or not the pool should autosize itself based on the agent cloud provider settings. | |
| AutoUpdate | Boolean | False |
Whether or not a pool should be automatically updated. | |
| CreatedByDescriptor | String | False |
The descriptor is the primary way to reference the creator while the system is running. | |
| CreatedByDisplayName | String | False |
This is the non-unique display name of the creator. | |
| CreatedById | String | False |
Id of the creator. | |
| CreatedByImageUrl | String | False |
The Image Url of the creator. | |
| CreatedByUniqueName | String | False |
The Unique name of the creator. | |
| CreatedByUrl | String | False |
Full http link to the creator. | |
| CreatedOn | Datetime | False |
The date/time of the pool creation. | |
| IsHosted | Boolean | False |
Indicates whether or not this pool is managed by the service. | |
| IsLegacy | Boolean | False |
Determines whether the pool is legacy. | |
| Name | String | False |
The name of the agent pool. | |
| OwnerDescriptor | String | False |
The descriptor is the primary way to reference the owner while the system is running. | |
| OwnerDisplayName | String | False |
This is the non-unique display name of the owner. | |
| OwnerId | String | False |
Id of the owner. | |
| OwnerImageUrl | String | False |
The Image Url of the owner. | |
| OwnerUniqueName | String | False |
The unique name of the owner. | |
| OwnerUrl | String | False |
Full Http Link to the owner. | |
| PoolType | String | False |
The type of the pool. The allowed values are automation, deployment. | |
| Properties | String | False |
Represents a property bag as a collection of key-value pairs. | |
| Scope | String | False |
The scope of the pool. | |
| Size | Integer | False |
The current size of the pool. | |
| TargetSize | Integer | False |
Target parallelism. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Action | String |
Filter by whether the calling user has use or manage permissions. The allowed values are manage, none, use. |