通过

Pools - Get Agent Pools

  • 参考
服务:
Distributed Task
API 版本:
7.1

获取代理池的列表。

GET https://dev.azure.com/{organization}/_apis/distributedtask/pools?api-version=7.1
具有可选参数: 
GET https://dev.azure.com/{organization}/_apis/distributedtask/pools?poolName={poolName}&properties={properties}&poolType={poolType}&actionFilter={actionFilter}&api-version=7.1

URI 参数

名称 在 必需 类型 说明
organization
 path True

string

Azure DevOps 组织的名称。
api-version
 query True

string

要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。
actionFilter
 query

TaskAgentPoolActionFilter

按呼叫用户是否具有使用或管理权限进行筛选
poolName
 query

string

按名称筛选
poolType
 query

TaskAgentPoolType

按池类型进行筛选
properties
 query

string (array (string))

按代理池属性进行筛选（逗号分隔）

响应

名称 类型 说明
200 OK

TaskAgentPool[]

成功作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

作用域

名称 说明
vso.agentpools 授予查看代理的任务、池、队列、代理以及当前正在运行或最近完成的代理作业的功能

定义

名称 说明
IdentityRef
PropertiesCollection

类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
ReferenceLinks

表示 REST 引用链接集合的类。
TaskAgentPool

代理的组织级分组。
TaskAgentPoolActionFilter

按呼叫用户是否具有使用或管理权限进行筛选
TaskAgentPoolOptions

其他池设置和详细信息
TaskAgentPoolType

获取或设置池的类型

IdentityRef

Object
名称 类型 说明
_links

ReferenceLinks

此字段包含有关图形主题的零个或多个有趣的链接。 可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。
descriptor

string

描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias

string

已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName

string

这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。
id

string

imageUrl

string

已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用
inactive

boolean

已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity

boolean

已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType）
isContainer

boolean

已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType）
isDeletedInOrigin

boolean

profileUrl

string

已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName

string

已弃用 - 请改用 Domain+PrincipalName
url

string

此 URL 是指向此图形主题的源资源的完整路由。

PropertiesCollection

Object

类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。

名称 类型 说明
count

integer (int32)

集合中的属性计数。
item

object

keys

string[]

集合中的键集。
values

string[]

集合中的值集。
Object

表示 REST 引用链接集合的类。

名称 类型 说明
links

object

链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。

TaskAgentPool

Object

代理的组织级分组。

名称 类型 说明
agentCloudId

integer (int32)

关联的代理云的 ID。
autoProvision

boolean

是否应为每个项目集合自动预配队列。
autoSize

boolean

池是否应根据代理云提供程序设置自动调整自身大小。
autoUpdate

boolean

是否允许此池中的代理自动更新
createdBy

IdentityRef

池的创建者。 池的创建者会自动添加到创建池的管理员组中。
createdOn

string (date-time)

池创建的日期/时间。
id

integer (int32)

isHosted

boolean

获取或设置一个值，该值指示此池是否由服务管理。
isLegacy

boolean

确定池是否为旧池。
name

string

options

TaskAgentPoolOptions

其他池设置和详细信息
owner

IdentityRef

池的所有者或管理员。
poolType

TaskAgentPoolType

获取或设置池的类型
properties

PropertiesCollection

类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。
scope

string (uuid)

size

integer (int32)

获取池的当前大小。
targetSize

integer (int32)

目标并行度 - 仅适用于池提供程序支持的代理池。 常规池将为 null。

TaskAgentPoolActionFilter

枚举

按呼叫用户是否具有使用或管理权限进行筛选

值 说明
manage
none
use

TaskAgentPoolOptions

枚举

其他池设置和详细信息

值 说明
elasticPool

由弹性池服务支持的 TaskAgentPool
none
preserveAgentOnJobFailure

如果在 TaskAgentJobRequest 失败后保留代理进行调查，则设置为 true
singleUseAgents

如果代理在每个 TaskAgentJobRequest 之后重新映像，则设置为 true

TaskAgentPoolType

枚举

获取或设置池的类型

值 说明
automation

任务代理的典型池
deployment

部署池