TaskAgentRestClient class

参考

包:: azure-devops-extension-api

应使用 (派生自) 的基类向 VSS REST API 发出请求

Extends: RestClientBase

构造函数

TaskAgentRestClient(IVssRestClientOptions)

属性

RESOURCE_AREA_ID

方法

addAgent(TaskAgent, number)	将代理添加到池。你可能不希望直接调用此终结点。而是使用代理下载包配置代理。
addAgentCloud(TaskAgentCloud)
addAgentPool(TaskAgentPool)	Create代理池。
addAgentQueue(TaskAgentQueue, string, boolean)	Create新的代理队列，将项目连接到代理池。
addDeploymentGroup(DeploymentGroupCreateParameter, string)	Create部署组。
addDeploymentMachine(DeploymentMachine, string, number)
addDeploymentMachineGroup(DeploymentMachineGroup, string)
addDeploymentTarget(DeploymentMachine, string, number)	将部署目标注册到部署组。通常，这由代理配置工具调用。
addEnvironment(EnvironmentCreateParameter, string)	创建环境。
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
addTaskGroup(TaskGroupCreateParameter, string)	Create任务组。
addVariableGroup(VariableGroupParameters)	添加变量组。
addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)
createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)
createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)
createAgentSession(TaskAgentSession, number)
createTeamProject(string)	Create新的团队项目。
deleteAgent(number, number)	删除代理。你可能不想直接调用此终结点。请改用代理配置脚本从组织中删除代理。
deleteAgentCloud(number)
deleteAgentPool(number)	删除代理池。
deleteAgentPoolMaintenanceDefinition(number, number)
deleteAgentPoolMaintenanceJob(number, number)
deleteAgentQueue(number, string)	从项目中删除代理队列。
deleteAgentRequest(number, number, string, TaskResult, boolean)
deleteAgentSession(number, string)
deleteDeploymentGroup(string, number)	删除部署组。
deleteDeploymentMachine(string, number, number)
deleteDeploymentMachineGroup(string, number)
deleteDeploymentTarget(string, number, number)	删除部署组中的部署目标。这也会从关联的部署池中删除代理。
deleteEnvironment(string, number)	删除指定的环境。
deleteKubernetesResource(string, number, number)
deleteMessage(number, number, string)
deleteSecureFile(string, string)	删除安全文件
deleteTaskDefinition(string)
deleteTaskGroup(string, string, string)	删除任务组。
deleteVariableGroup(number, string[])	删除变量组
deleteVirtualMachineGroup(string, number, number)
downloadSecureFile(string, string, string, boolean)	按 ID 下载安全文件
generateDeploymentGroupAccessToken(string, number)	获取 PAT 令牌，用于管理 (在部署组中配置、删除、标记) 部署目标。
generateDeploymentMachineGroupAccessToken(string, number)
generateDeploymentPoolAccessToken(number)	获取 PAT 令牌，用于管理 (在部署池中配置、删除、标记) 部署代理。
getAgent(number, number, boolean, boolean, boolean, string[])	获取有关代理的信息。
getAgentCloud(number)
getAgentCloudRequests(number)
getAgentClouds()
getAgentCloudTypes()	获取代理云类型。
getAgentPool(number, string[], TaskAgentPoolActionFilter)	获取有关代理池的信息。
getAgentPoolMaintenanceDefinition(number, number)
getAgentPoolMaintenanceDefinitions(number)
getAgentPoolMaintenanceJob(number, number)
getAgentPoolMaintenanceJobLogs(number, number)
getAgentPoolMaintenanceJobs(number, number)
getAgentPoolMetadata(number)
getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)	获取代理池的列表。
getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)	获取代理池的列表。
getAgentQueue(number, string, TaskAgentQueueActionFilter)	获取有关代理队列的信息。
getAgentQueues(string, string, TaskAgentQueueActionFilter)	获取代理队列的列表。
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)	按代理 ID 获取代理队列列表
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)	按名称获取代理队列列表
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)	按池 ID 获取代理队列列表
getAgentRequest(number, number, boolean)
getAgentRequests(number, number, string)
getAgentRequestsForAgent(number, number, number)
getAgentRequestsForAgents(number, number[], number)
getAgentRequestsForDeploymentMachine(string, number, number, number)
getAgentRequestsForDeploymentMachines(string, number, number[], number)
getAgentRequestsForDeploymentTarget(string, number, number, number)	获取针对部署目标的代理请求。
getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)	获取列表部署目标的代理请求。
getAgentRequestsForPlan(number, string, string)
getAgentRequestsForQueue(string, number, number, string)
getAgents(number, string, boolean, boolean, boolean, string[], string[])	获取代理列表。
getAzureManagementGroups()	返回 Azure 订阅的列表
getAzureSubscriptions()	返回 Azure 订阅的列表
getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)	按 ID 获取部署组。
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])	按名称或 ID 获取部署组的列表。
getDeploymentGroupsMetrics(string, string, string, number)	获取部署组指标的列表。
getDeploymentMachine(string, number, number, DeploymentMachineExpands)
getDeploymentMachineGroup(string, number, MachineGroupActionFilter)
getDeploymentMachineGroupMachines(string, number, string[])
getDeploymentMachineGroups(string, string, MachineGroupActionFilter)
getDeploymentMachines(string, number, string[], string, DeploymentMachineExpands)
getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])	获取部署池摘要列表。
getDeploymentTarget(string, number, number, DeploymentTargetExpands)	按部署组中的 ID 获取部署目标
getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])	获取部署组中的部署目标列表。
getEnvironmentById(string, number, EnvironmentExpands)	按 ID 获取环境。
getEnvironmentDeploymentExecutionRecords(string, number, string, number)	获取环境部署执行历史记录
getEnvironments(string, string, string, number)	获取所有环境。
getKubernetesResource(string, number, number)
getMessage(number, string, number)
getPackage(string, string, string)
getPackages(string, string, number)
getResourceLimits()
getResourceUsage(string, boolean, boolean)
getSecureFile(string, string, boolean, SecureFileActionFilter)	获取安全文件
getSecureFiles(string, string, boolean, SecureFileActionFilter)	获取安全文件
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)	获取安全文件
getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)	获取安全文件
getTaskContentZip(string, string, string[], boolean)
getTaskDefinition(string, string, string[], boolean)
getTaskDefinitions(string, string[], boolean, boolean)
getTaskGroup(string, string, string, TaskGroupExpands)	获取任务组。
getTaskGroupHistory(string, string)
getTaskGroupRevision(string, string, number)
getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)	列出任务组。
getTaskHubLicenseDetails(string, boolean, boolean)
getVariableGroup(string, number)	获取变量组。
getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)	获取变量组。
getVariableGroupsById(string, number[], boolean)	按 ID 获取变量组。
getVirtualMachineGroup(string, number, number)
getVirtualMachines(string, number, number, string, string, boolean, string[], number)
getVstsAadTenantId()
getYamlSchema(boolean)	获取用于 Yaml 文件验证的 Yaml 架构。
hasPoolPermissions(number, number)	检查当前标识是否已传递对池的权限。
publishTaskGroup(PublishTaskGroupMetadata, string, string)
queryEndpoint(TaskDefinitionEndpoint)	由“终结点”定义的 GET 请求的代理。请求使用服务连接进行授权。使用基于 XPath/Json 的选择器筛选响应。
querySecureFilesByProperties(string, string, string)	使用名称模式和文件属性条件查询安全文件。
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
queueAgentRequest(TaskAgentJobRequest, string, number)
queueAgentRequestByPool(TaskAgentJobRequest, number)
refreshAgent(number, number)
refreshAgents(number)
refreshDeploymentMachines(string, number)
refreshDeploymentTargets(string, number)	升级部署组中的部署目标。
replaceAgent(TaskAgent, number, number)	替换代理。你可能不想直接调用此终结点。请改用代理配置脚本从组织中删除和重新配置代理。
replaceDeploymentMachine(DeploymentMachine, string, number, number)
replaceDeploymentTarget(DeploymentMachine, string, number, number)	替换部署组中的部署目标。通常，这由代理配置工具调用。
sendMessage(TaskAgentMessage, number, number)
setAgentPoolMetadata(any, number)
shareVariableGroup(VariableGroupProjectReference[], number)	添加变量组。
undeleteTaskGroup(TaskGroup, string)
updateAgent(TaskAgent, number, number)	更新代理详细信息。
updateAgentCloud(TaskAgentCloud, number)
updateAgentPool(TaskAgentPool, number)	更新代理池的属性
updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)
updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)
updateAgentRequest(TaskAgentJobRequest, number, number, string, TaskAgentRequestUpdateOptions)
updateAgentUpdateState(number, number, string)
updateAgentUserCapabilities({[key: string]: string}, number, number)
updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)	更新部署组。
updateDeploymentMachine(DeploymentMachine, string, number, number)
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
updateDeploymentMachines(DeploymentMachine[], string, number)
updateDeploymentTarget(DeploymentMachine, string, number, number)	更新部署组中的部署目标及其代理属性。通常，这由代理配置工具调用。
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)	更新部署组中部署目标列表的标记。
updateEnvironment(EnvironmentUpdateParameter, string, number)	更新指定的环境。
updateSecureFile(SecureFile, string, string)	更新现有安全文件的名称或属性
updateSecureFiles(SecureFile[], string)	更新一组安全文件的属性和/或名称。文件由其 ID 标识。提供的属性将完全替代现有属性，即不合并。
updateTaskGroup(TaskGroupUpdateParameter, string, string)	更新任务组。
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)
updateVariableGroup(VariableGroupParameters, number)	更新变量组。
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
updateVirtualMachines(VirtualMachine[], string, number, number)
uploadSecureFile(any, string, string, boolean)	上传安全文件，在请求正文中包含文件流
validateInputs(InputValidationRequest)

构造函数详细信息

TaskAgentRestClient(IVssRestClientOptions)

new TaskAgentRestClient(options: IVssRestClientOptions)

参数

options: IVssRestClientOptions

属性详细信息

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

属性值

string

方法详细信息

addAgent(TaskAgent, number)

将代理添加到池。你可能不希望直接调用此终结点。而是使用代理下载包配置代理。

function addAgent(agent: TaskAgent, poolId: number): Promise<TaskAgent>

参数

agent: TaskAgent

有关要添加的代理的详细信息

poolId: number

要在其中添加代理的代理池

Promise<TaskAgent>

addAgentCloud(TaskAgentCloud)

function addAgentCloud(agentCloud: TaskAgentCloud): Promise<TaskAgentCloud>

参数

agentCloud: TaskAgentCloud

Promise<TaskAgentCloud>

addAgentPool(TaskAgentPool)

Create代理池。

function addAgentPool(pool: TaskAgentPool): Promise<TaskAgentPool>

参数

pool: TaskAgentPool

有关新代理池的详细信息

Promise<TaskAgentPool>

addAgentQueue(TaskAgentQueue, string, boolean)

Create新的代理队列，将项目连接到代理池。

function addAgentQueue(queue: TaskAgentQueue, project?: string, authorizePipelines?: boolean): Promise<TaskAgentQueue>

参数

queue: TaskAgentQueue

有关要创建的队列的详细信息

project: string

项目 ID 或项目名称

authorizePipelines: boolean

使用 YAML 时自动授权此队列

Promise<TaskAgentQueue>

addDeploymentGroup(DeploymentGroupCreateParameter, string)

Create部署组。

function addDeploymentGroup(deploymentGroup: DeploymentGroupCreateParameter, project: string): Promise<DeploymentGroup>

参数

deploymentGroup: DeploymentGroupCreateParameter

要创建的部署组。

project: string

项目 ID 或项目名称

Promise<DeploymentGroup>

addDeploymentMachine(DeploymentMachine, string, number)

function addDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number): Promise<DeploymentMachine>

参数

machine: DeploymentMachine

project: string

项目 ID 或项目名称

deploymentGroupId: number

Promise<DeploymentMachine>

addDeploymentMachineGroup(DeploymentMachineGroup, string)

function addDeploymentMachineGroup(machineGroup: DeploymentMachineGroup, project: string): Promise<DeploymentMachineGroup>

参数

machineGroup: DeploymentMachineGroup

project: string

项目 ID 或项目名称

Promise<DeploymentMachineGroup>

addDeploymentTarget(DeploymentMachine, string, number)

将部署目标注册到部署组。通常，这由代理配置工具调用。

function addDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number): Promise<DeploymentMachine>

参数

machine: DeploymentMachine

要注册的部署目标。

project: string

项目 ID 或项目名称

deploymentGroupId: number

部署目标注册到的部署组的 ID。

Promise<DeploymentMachine>

addEnvironment(EnvironmentCreateParameter, string)

创建环境。

function addEnvironment(environmentCreateParameter: EnvironmentCreateParameter, project: string): Promise<EnvironmentInstance>

参数

environmentCreateParameter: EnvironmentCreateParameter

要创建的环境。

project: string

项目 ID 或项目名称

Promise<EnvironmentInstance>

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

function addKubernetesResource(createParameters: KubernetesResourceCreateParameters, project: string, environmentId: number): Promise<KubernetesResource>

参数

createParameters: KubernetesResourceCreateParameters

project: string

项目 ID 或项目名称

environmentId: number

Promise<KubernetesResource>

addTaskGroup(TaskGroupCreateParameter, string)

Create任务组。

function addTaskGroup(taskGroup: TaskGroupCreateParameter, project: string): Promise<TaskGroup>

参数

taskGroup: TaskGroupCreateParameter

要创建的任务组对象。

project: string

项目 ID 或项目名称

Promise<TaskGroup>

addVariableGroup(VariableGroupParameters)

添加变量组。

function addVariableGroup(variableGroupParameters: VariableGroupParameters): Promise<VariableGroup>

参数

variableGroupParameters: VariableGroupParameters

Promise<VariableGroup>

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

function addVirtualMachineGroup(createParameters: VirtualMachineGroupCreateParameters, project: string, environmentId: number): Promise<VirtualMachineGroup>

参数

createParameters: VirtualMachineGroupCreateParameters

project: string

项目 ID 或项目名称

environmentId: number

Promise<VirtualMachineGroup>

createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)

function createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>

参数

tenantId: string

redirectUri: string

promptOption: AadLoginPromptOption

completeCallbackPayload: string

completeCallbackByAuthCode: boolean

Promise<string>

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

function createAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number): Promise<TaskAgentPoolMaintenanceDefinition>

参数

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession(TaskAgentSession, number)

function createAgentSession(session: TaskAgentSession, poolId: number): Promise<TaskAgentSession>

参数

session: TaskAgentSession

poolId: number

Promise<TaskAgentSession>

createTeamProject(string)

Create新的团队项目。

function createTeamProject(project?: string): Promise<void>

参数

project: string

项目 ID 或项目名称

Promise<void>

deleteAgent(number, number)

删除代理。你可能不想直接调用此终结点。请改用代理配置脚本从组织中删除代理。

function deleteAgent(poolId: number, agentId: number): Promise<void>

参数

poolId: number

要从中删除代理的池 ID

agentId: number

要删除的代理 ID

Promise<void>

deleteAgentCloud(number)

function deleteAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>

参数

agentCloudId: number

Promise<TaskAgentCloud>

deleteAgentPool(number)

删除代理池。

function deleteAgentPool(poolId: number): Promise<void>

参数

poolId: number

要删除的代理池的 ID

Promise<void>

deleteAgentPoolMaintenanceDefinition(number, number)

function deleteAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<void>

参数

poolId: number

definitionId: number

Promise<void>

deleteAgentPoolMaintenanceJob(number, number)

function deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<void>

参数

poolId: number

jobId: number

Promise<void>

deleteAgentQueue(number, string)

从项目中删除代理队列。

function deleteAgentQueue(queueId: number, project?: string): Promise<void>

参数

queueId: number

要删除的代理队列

project: string

项目 ID 或项目名称

Promise<void>

deleteAgentRequest(number, number, string, TaskResult, boolean)

function deleteAgentRequest(poolId: number, requestId: number, lockToken: string, result?: TaskResult, agentShuttingDown?: boolean): Promise<void>

参数

poolId: number

requestId: number

lockToken: string

result: TaskResult

agentShuttingDown: boolean

Promise<void>

deleteAgentSession(number, string)

function deleteAgentSession(poolId: number, sessionId: string): Promise<void>

参数

poolId: number

sessionId: string

Promise<void>

deleteDeploymentGroup(string, number)

删除部署组。

function deleteDeploymentGroup(project: string, deploymentGroupId: number): Promise<void>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

要删除的部署组的 ID。

Promise<void>

deleteDeploymentMachine(string, number, number)

function deleteDeploymentMachine(project: string, deploymentGroupId: number, machineId: number): Promise<void>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

machineId: number

Promise<void>

deleteDeploymentMachineGroup(string, number)

function deleteDeploymentMachineGroup(project: string, machineGroupId: number): Promise<void>

参数

project: string

项目 ID 或项目名称

machineGroupId: number

Promise<void>

deleteDeploymentTarget(string, number, number)

删除部署组中的部署目标。这也会从关联的部署池中删除代理。

function deleteDeploymentTarget(project: string, deploymentGroupId: number, targetId: number): Promise<void>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

在其中删除部署目标的部署组的 ID。

targetId: number

要删除的部署目标的 ID。

Promise<void>

deleteEnvironment(string, number)

删除指定的环境。

function deleteEnvironment(project: string, environmentId: number): Promise<void>

参数

project: string

项目 ID 或项目名称

environmentId: number

环境的 ID。

Promise<void>

deleteKubernetesResource(string, number, number)

function deleteKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<void>

参数

project: string

项目 ID 或项目名称

environmentId: number

resourceId: number

Promise<void>

deleteMessage(number, number, string)

function deleteMessage(poolId: number, messageId: number, sessionId: string): Promise<void>

参数

poolId: number

messageId: number

sessionId: string

Promise<void>

deleteSecureFile(string, string)

删除安全文件

function deleteSecureFile(project: string, secureFileId: string): Promise<void>

参数

project: string

项目 ID 或项目名称

secureFileId: string

唯一的安全文件 ID

Promise<void>

deleteTaskDefinition(string)

function deleteTaskDefinition(taskId: string): Promise<void>

参数

taskId: string

Promise<void>

deleteTaskGroup(string, string, string)

删除任务组。

function deleteTaskGroup(project: string, taskGroupId: string, comment?: string): Promise<void>

参数

project: string

项目 ID 或项目名称

taskGroupId: string

要删除的任务组的 ID。

comment: string

要删除的注释。

Promise<void>

deleteVariableGroup(number, string[])

删除变量组

function deleteVariableGroup(groupId: number, projectIds: string[]): Promise<void>

参数

groupId: number

变量组的 ID。

projectIds: string[]

Promise<void>

deleteVirtualMachineGroup(string, number, number)

function deleteVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<void>

参数

project: string

项目 ID 或项目名称

environmentId: number

resourceId: number

Promise<void>

downloadSecureFile(string, string, string, boolean)

按 ID 下载安全文件

function downloadSecureFile(project: string, secureFileId: string, ticket: string, download?: boolean): Promise<ArrayBuffer>

参数

project: string

项目 ID 或项目名称

secureFileId: string

唯一的安全文件 ID

ticket: string

有效的下载票证

download: boolean

如果下载为 true，则会在响应正文中将文件作为附加发送。如果 download 为 false，则响应正文包含文件流。

Promise<ArrayBuffer>

generateDeploymentGroupAccessToken(string, number)

获取 PAT 令牌，用于管理 (在部署组中配置、删除、标记) 部署目标。

function generateDeploymentGroupAccessToken(project: string, deploymentGroupId: number): Promise<string>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

在其中管理部署目标的部署组的 ID。

Promise<string>

generateDeploymentMachineGroupAccessToken(string, number)

function generateDeploymentMachineGroupAccessToken(project: string, machineGroupId: number): Promise<string>

参数

project: string

项目 ID 或项目名称

machineGroupId: number

Promise<string>

generateDeploymentPoolAccessToken(number)

获取 PAT 令牌，用于管理 (在部署池中配置、删除、标记) 部署代理。

function generateDeploymentPoolAccessToken(poolId: number): Promise<string>

参数

poolId: number

在其中托管部署代理的部署池的 ID。

Promise<string>

getAgent(number, number, boolean, boolean, boolean, string[])

获取有关代理的信息。

function getAgent(poolId: number, agentId: number, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[]): Promise<TaskAgent>

参数

poolId: number

包含代理的代理池

agentId: number

用于获取相关信息的代理 ID

includeCapabilities: boolean

是否在响应中包含代理的功能

includeAssignedRequest: boolean

是否包含有关代理当前工作的详细信息

includeLastCompletedRequest: boolean

是否包含有关代理最近已完成工作的详细信息

propertyFilters: string[]

筛选将返回的自定义属性

Promise<TaskAgent>

getAgentCloud(number)

function getAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>

参数

agentCloudId: number

Promise<TaskAgentCloud>

getAgentCloudRequests(number)

function getAgentCloudRequests(agentCloudId: number): Promise<TaskAgentCloudRequest[]>

参数

agentCloudId: number

Promise<TaskAgentCloudRequest[]>

getAgentClouds()

function getAgentClouds(): Promise<TaskAgentCloud[]>

Promise<TaskAgentCloud[]>

getAgentCloudTypes()

获取代理云类型。

function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>

Promise<TaskAgentCloudType[]>

getAgentPool(number, string[], TaskAgentPoolActionFilter)

获取有关代理池的信息。

function getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool>

参数

poolId: number

代理池 ID

properties: string[]

代理池属性 (逗号分隔)

actionFilter: TaskAgentPoolActionFilter

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

Promise<TaskAgentPool>

getAgentPoolMaintenanceDefinition(number, number)

function getAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>

参数

poolId: number

definitionId: number

Promise<TaskAgentPoolMaintenanceDefinition>

getAgentPoolMaintenanceDefinitions(number)

function getAgentPoolMaintenanceDefinitions(poolId: number): Promise<TaskAgentPoolMaintenanceDefinition[]>

参数

poolId: number

Promise<TaskAgentPoolMaintenanceDefinition[]>

getAgentPoolMaintenanceJob(number, number)

function getAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>

参数

poolId: number

jobId: number

Promise<TaskAgentPoolMaintenanceJob>

getAgentPoolMaintenanceJobLogs(number, number)

function getAgentPoolMaintenanceJobLogs(poolId: number, jobId: number): Promise<ArrayBuffer>

参数

poolId: number

jobId: number

Promise<ArrayBuffer>

getAgentPoolMaintenanceJobs(number, number)

function getAgentPoolMaintenanceJobs(poolId: number, definitionId?: number): Promise<TaskAgentPoolMaintenanceJob[]>

参数

poolId: number

definitionId: number

Promise<TaskAgentPoolMaintenanceJob[]>

getAgentPoolMetadata(number)

function getAgentPoolMetadata(poolId: number): Promise<string>

参数

poolId: number

Promise<string>

getAgentPools(string, string[], TaskAgentPoolType, TaskAgentPoolActionFilter)

获取代理池的列表。

function getAgentPools(poolName?: string, properties?: string[], poolType?: TaskAgentPoolType, actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>

参数

poolName: string

按名称筛选

properties: string[]

按代理池属性筛选 (逗号分隔)

poolType: TaskAgentPoolType

按池类型筛选

actionFilter: TaskAgentPoolActionFilter

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

Promise<TaskAgentPool[]>

getAgentPoolsByIds(number[], TaskAgentPoolActionFilter)

获取代理池的列表。

function getAgentPoolsByIds(poolIds: number[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool[]>

参数

poolIds: number[]

要提取的池 ID

actionFilter: TaskAgentPoolActionFilter

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

Promise<TaskAgentPool[]>

getAgentQueue(number, string, TaskAgentQueueActionFilter)

获取有关代理队列的信息。

function getAgentQueue(queueId: number, project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue>

参数

queueId: number

用于获取相关信息的代理队列

project: string

项目 ID 或项目名称

actionFilter: TaskAgentQueueActionFilter

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

Promise<TaskAgentQueue>

getAgentQueues(string, string, TaskAgentQueueActionFilter)

获取代理队列的列表。

function getAgentQueues(project?: string, queueName?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>

参数

project: string

项目 ID 或项目名称

queueName: string

筛选代理队列名称

actionFilter: TaskAgentQueueActionFilter

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

Promise<TaskAgentQueue[]>

getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)

按代理 ID 获取代理队列列表

function getAgentQueuesByIds(queueIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>

参数

queueIds: number[]

要检索的代理队列 ID 的逗号分隔列表

project: string

项目 ID 或项目名称

actionFilter: TaskAgentQueueActionFilter

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

Promise<TaskAgentQueue[]>

getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)

按名称获取代理队列列表

function getAgentQueuesByNames(queueNames: string[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>

参数

queueNames: string[]

要检索的代理名称的逗号分隔列表

project: string

项目 ID 或项目名称

actionFilter: TaskAgentQueueActionFilter

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

Promise<TaskAgentQueue[]>

getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)

按池 ID 获取代理队列列表

function getAgentQueuesForPools(poolIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>

参数

poolIds: number[]

池 ID 的逗号分隔列表，用于获取对应的队列

project: string

项目 ID 或项目名称

actionFilter: TaskAgentQueueActionFilter

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

Promise<TaskAgentQueue[]>

getAgentRequest(number, number, boolean)

function getAgentRequest(poolId: number, requestId: number, includeStatus?: boolean): Promise<TaskAgentJobRequest>

参数

poolId: number

requestId: number

includeStatus: boolean

Promise<TaskAgentJobRequest>

getAgentRequests(number, number, string)

function getAgentRequests(poolId: number, top: number, continuationToken?: string): Promise<PagedList<TaskAgentJobRequest>>

参数

poolId: number

top: number

continuationToken: string

Promise<PagedList<TaskAgentJobRequest>>

getAgentRequestsForAgent(number, number, number)

function getAgentRequestsForAgent(poolId: number, agentId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

参数

poolId: number

agentId: number

completedRequestCount: number

Promise<TaskAgentJobRequest[]>

getAgentRequestsForAgents(number, number[], number)

function getAgentRequestsForAgents(poolId: number, agentIds?: number[], completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

参数

poolId: number

agentIds: number[]

completedRequestCount: number

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachine(string, number, number, number)

function getAgentRequestsForDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

machineId: number

completedRequestCount: number

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentMachines(string, number, number[], number)

function getAgentRequestsForDeploymentMachines(project: string, deploymentGroupId: number, machineIds?: number[], completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

machineIds: number[]

completedRequestCount: number

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTarget(string, number, number, number)

获取针对部署目标的代理请求。

function getAgentRequestsForDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

目标所属的部署组的 ID。

targetId: number

部署目标的 ID。

completedRequestCount: number

要返回的已完成请求的最大数目。默认值为 50

Promise<TaskAgentJobRequest[]>

getAgentRequestsForDeploymentTargets(string, number, number[], number, Date, number)

获取列表部署目标的代理请求。

function getAgentRequestsForDeploymentTargets(project: string, deploymentGroupId: number, targetIds?: number[], ownerId?: number, completedOn?: Date, completedRequestCount?: number): Promise<TaskAgentJobRequest[]>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

目标所属的部署组的 ID。

targetIds: number[]

部署目标的 ID 的逗号分隔列表。

ownerId: number

代理作业请求所有者的 ID。

completedOn: Date

在此时间之后返回请求的日期时间。

completedRequestCount: number

要为每个目标返回的已完成请求的最大数目。默认值为 50

Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan(number, string, string)

function getAgentRequestsForPlan(poolId: number, planId: string, jobId?: string): Promise<TaskAgentJobRequest[]>

参数

poolId: number

planId: string

jobId: string

Promise<TaskAgentJobRequest[]>

getAgentRequestsForQueue(string, number, number, string)

function getAgentRequestsForQueue(project: string, queueId: number, top: number, continuationToken?: string): Promise<PagedList<TaskAgentJobRequest>>

参数

project: string

项目 ID 或项目名称

queueId: number

top: number

continuationToken: string

Promise<PagedList<TaskAgentJobRequest>>

getAgents(number, string, boolean, boolean, boolean, string[], string[])

获取代理列表。

function getAgents(poolId: number, agentName?: string, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[], demands?: string[]): Promise<TaskAgent[]>

参数

poolId: number

包含代理的代理池

agentName: string

筛选代理名称

includeCapabilities: boolean

是否在响应中包含代理的功能

includeAssignedRequest: boolean

是否包括有关代理当前工作的详细信息

includeLastCompletedRequest: boolean

是否包含有关代理最近完成的工作的详细信息

propertyFilters: string[]

筛选将返回的自定义属性

demands: string[]

按代理可以满足的要求进行筛选

Promise<TaskAgent[]>

getAzureManagementGroups()

返回 Azure 订阅的列表

function getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>

Promise<AzureManagementGroupQueryResult>

getAzureSubscriptions()

返回 Azure 订阅的列表

function getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>

Promise<AzureSubscriptionQueryResult>

getDeploymentGroup(string, number, DeploymentGroupActionFilter, DeploymentGroupExpands)

按 ID 获取部署组。

function getDeploymentGroup(project: string, deploymentGroupId: number, actionFilter?: DeploymentGroupActionFilter, expand?: DeploymentGroupExpands): Promise<DeploymentGroup>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

部署组的 ID。

actionFilter: DeploymentGroupActionFilter

仅当可以对此组执行此操作时，才获取部署组。

expand: DeploymentGroupExpands

在返回的对象中包含这些附加详细信息。

Promise<DeploymentGroup>

getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])

按名称或 ID 获取部署组的列表。

function getDeploymentGroups(project: string, name?: string, actionFilter?: DeploymentGroupActionFilter, expand?: DeploymentGroupExpands, continuationToken?: string, top?: number, ids?: number[]): Promise<PagedList<DeploymentGroup>>

参数

project: string

项目 ID 或项目名称

name: string

部署组的名称。

actionFilter: DeploymentGroupActionFilter

仅获取可对其执行此操作的部署组。

expand: DeploymentGroupExpands

在返回的对象中包含这些附加详细信息。

continuationToken: string

按字典顺序获取名称大于此 continuationToken 的部署组。

top: number

要返回的最大部署组数。默认值为 1000。

ids: number[]

部署组的 ID 的逗号分隔列表。

Promise<PagedList<DeploymentGroup>>

getDeploymentGroupsMetrics(string, string, string, number)

获取部署组指标的列表。

function getDeploymentGroupsMetrics(project: string, deploymentGroupName?: string, continuationToken?: string, top?: number): Promise<PagedList<DeploymentGroupMetrics>>

参数

project: string

项目 ID 或项目名称

deploymentGroupName: string

部署组的名称。

continuationToken: string

按字典顺序获取名称大于此 continuationToken 的部署组的指标。

top: number

要返回的最大部署组指标数。默认值为 50。

Promise<PagedList<DeploymentGroupMetrics>>

getDeploymentMachine(string, number, number, DeploymentMachineExpands)

function getDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, expand?: DeploymentMachineExpands): Promise<DeploymentMachine>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

machineId: number

expand: DeploymentMachineExpands

Promise<DeploymentMachine>

getDeploymentMachineGroup(string, number, MachineGroupActionFilter)

function getDeploymentMachineGroup(project: string, machineGroupId: number, actionFilter?: MachineGroupActionFilter): Promise<DeploymentMachineGroup>

参数

project: string

项目 ID 或项目名称

machineGroupId: number

actionFilter: MachineGroupActionFilter

Promise<DeploymentMachineGroup>

getDeploymentMachineGroupMachines(string, number, string[])

function getDeploymentMachineGroupMachines(project: string, machineGroupId: number, tagFilters?: string[]): Promise<DeploymentMachine[]>

参数

project: string

项目 ID 或项目名称

machineGroupId: number

tagFilters: string[]

Promise<DeploymentMachine[]>

getDeploymentMachineGroups(string, string, MachineGroupActionFilter)

function getDeploymentMachineGroups(project: string, machineGroupName?: string, actionFilter?: MachineGroupActionFilter): Promise<DeploymentMachineGroup[]>

参数

project: string

项目 ID 或项目名称

machineGroupName: string

actionFilter: MachineGroupActionFilter

Promise<DeploymentMachineGroup[]>

getDeploymentMachines(string, number, string[], string, DeploymentMachineExpands)

function getDeploymentMachines(project: string, deploymentGroupId: number, tags?: string[], name?: string, expand?: DeploymentMachineExpands): Promise<DeploymentMachine[]>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

tags: string[]

name: string

expand: DeploymentMachineExpands

Promise<DeploymentMachine[]>

getDeploymentPoolsSummary(string, DeploymentPoolSummaryExpands, number[])

获取部署池摘要列表。

function getDeploymentPoolsSummary(poolName?: string, expands?: DeploymentPoolSummaryExpands, poolIds?: number[]): Promise<DeploymentPoolSummary[]>

参数

poolName: string

部署池的名称。

expands: DeploymentPoolSummaryExpands

在返回的对象中包含这些附加详细信息。

poolIds: number[]

部署池 ID 的列表。

Promise<DeploymentPoolSummary[]>

getDeploymentTarget(string, number, number, DeploymentTargetExpands)

按部署组中的 ID 获取部署目标

function getDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, expand?: DeploymentTargetExpands): Promise<DeploymentMachine>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

部署目标所属的部署组的 ID。

targetId: number

要返回的部署目标的 ID。

expand: DeploymentTargetExpands

在返回的对象中包含这些附加详细信息。

Promise<DeploymentMachine>

getDeploymentTargets(string, number, string[], string, boolean, DeploymentTargetExpands, TaskAgentStatusFilter, TaskAgentJobResultFilter, string, number, boolean, string[])

获取部署组中的部署目标列表。

function getDeploymentTargets(project: string, deploymentGroupId: number, tags?: string[], name?: string, partialNameMatch?: boolean, expand?: DeploymentTargetExpands, agentStatus?: TaskAgentStatusFilter, agentJobResult?: TaskAgentJobResultFilter, continuationToken?: string, top?: number, enabled?: boolean, propertyFilters?: string[]): Promise<PagedList<DeploymentMachine>>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

部署组的 ID。

tags: string[]

仅获取包含所有这些以逗号分隔的标记列表的部署目标。

name: string

要返回的部署目标的名称模式。

partialNameMatch: boolean

设置为 true 时，将名称视为模式。否则将其视为绝对匹配。默认值为 false。

expand: DeploymentTargetExpands

在返回的对象中包含这些附加详细信息。

agentStatus: TaskAgentStatusFilter

仅获取具有此状态的部署目标。

agentJobResult: TaskAgentJobResultFilter

仅获取具有此最后一个作业结果的部署目标。

continuationToken: string

按字典顺序获取名称大于此 continuationToken 的部署目标。

top: number

要返回的最大部署目标数。默认值为 1000。

enabled: boolean

仅获取启用或禁用的部署目标。默认值为“null”，返回所有目标。

propertyFilters: string[]

Promise<PagedList<DeploymentMachine>>

getEnvironmentById(string, number, EnvironmentExpands)

按 ID 获取环境。

function getEnvironmentById(project: string, environmentId: number, expands?: EnvironmentExpands): Promise<EnvironmentInstance>

参数

project: string

项目 ID 或项目名称

environmentId: number

环境的 ID。

expands: EnvironmentExpands

在返回的对象中包含这些附加详细信息。

Promise<EnvironmentInstance>

getEnvironmentDeploymentExecutionRecords(string, number, string, number)

获取环境部署执行历史记录

function getEnvironmentDeploymentExecutionRecords(project: string, environmentId: number, continuationToken?: string, top?: number): Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

参数

project: string

项目 ID 或项目名称

environmentId: number

continuationToken: string

top: number

Promise<PagedList<EnvironmentDeploymentExecutionRecord>>

getEnvironments(string, string, string, number)

获取所有环境。

function getEnvironments(project: string, name?: string, continuationToken?: string, top?: number): Promise<PagedList<EnvironmentInstance>>

参数

project: string

项目 ID 或项目名称

name: string

continuationToken: string

top: number

Promise<PagedList<EnvironmentInstance>>

getKubernetesResource(string, number, number)

function getKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<KubernetesResource>

参数

project: string

项目 ID 或项目名称

environmentId: number

resourceId: number

Promise<KubernetesResource>

getMessage(number, string, number)

function getMessage(poolId: number, sessionId: string, lastMessageId?: number): Promise<TaskAgentMessage>

参数

poolId: number

sessionId: string

lastMessageId: number

Promise<TaskAgentMessage>

getPackage(string, string, string)

function getPackage(packageType: string, platform: string, version: string): Promise<PackageMetadata>

参数

packageType: string

platform: string

version: string

Promise<PackageMetadata>

getPackages(string, string, number)

function getPackages(packageType: string, platform?: string, top?: number): Promise<PackageMetadata[]>

参数

packageType: string

platform: string

top: number

Promise<PackageMetadata[]>

getResourceLimits()

function getResourceLimits(): Promise<ResourceLimit[]>

Promise<ResourceLimit[]>

getResourceUsage(string, boolean, boolean)

function getResourceUsage(parallelismTag?: string, poolIsHosted?: boolean, includeRunningRequests?: boolean): Promise<ResourceUsage>

参数

parallelismTag: string

poolIsHosted: boolean

includeRunningRequests: boolean

Promise<ResourceUsage>

getSecureFile(string, string, boolean, SecureFileActionFilter)

获取安全文件

function getSecureFile(project: string, secureFileId: string, includeDownloadTicket?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile>

参数

project: string

项目 ID 或项目名称

secureFileId: string

唯一的安全文件 ID

includeDownloadTicket: boolean

如果 includeDownloadTicket 为 true 且调用方具有权限，则响应中包括下载票证。

actionFilter: SecureFileActionFilter

Promise<SecureFile>

getSecureFiles(string, string, boolean, SecureFileActionFilter)

获取安全文件

function getSecureFiles(project: string, namePattern?: string, includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>

参数

project: string

项目 ID 或项目名称

namePattern: string

要匹配的安全文件的名称。可以包含通配符以匹配多个文件。

includeDownloadTickets: boolean

如果 includeDownloadTickets 为 true 且调用方具有权限，则响应中包括每个安全文件的下载票证。

actionFilter: SecureFileActionFilter

按查看、管理或使用操作的安全文件权限进行筛选。默认为 View。

Promise<SecureFile[]>

getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)

获取安全文件

function getSecureFilesByIds(project: string, secureFileIds: string[], includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>

参数

project: string

项目 ID 或项目名称

secureFileIds: string[]

安全文件 ID 的列表

includeDownloadTickets: boolean

如果 includeDownloadTickets 为 true 且调用方具有权限，则响应中包括每个安全文件的下载票证。

actionFilter: SecureFileActionFilter

Promise<SecureFile[]>

getSecureFilesByNames(string, string[], boolean, SecureFileActionFilter)

获取安全文件

function getSecureFilesByNames(project: string, secureFileNames: string[], includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>

参数

project: string

项目 ID 或项目名称

secureFileNames: string[]

安全文件 ID 的列表

includeDownloadTickets: boolean

如果 includeDownloadTickets 为 true 且调用方具有权限，则响应中包括每个安全文件的下载票证。

actionFilter: SecureFileActionFilter

Promise<SecureFile[]>

getTaskContentZip(string, string, string[], boolean)

function getTaskContentZip(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<ArrayBuffer>

参数

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Promise<ArrayBuffer>

getTaskDefinition(string, string, string[], boolean)

function getTaskDefinition(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<TaskDefinition>

参数

taskId: string

versionString: string

visibility: string[]

scopeLocal: boolean

Promise<TaskDefinition>

getTaskDefinitions(string, string[], boolean, boolean)

function getTaskDefinitions(taskId?: string, visibility?: string[], scopeLocal?: boolean, allVersions?: boolean): Promise<TaskDefinition[]>

参数

taskId: string

visibility: string[]

scopeLocal: boolean

allVersions: boolean

Promise<TaskDefinition[]>

getTaskGroup(string, string, string, TaskGroupExpands)

获取任务组。

function getTaskGroup(project: string, taskGroupId: string, versionSpec: string, expand?: TaskGroupExpands): Promise<TaskGroup>

参数

project: string

项目 ID 或项目名称

taskGroupId: string

任务组的 ID。

versionSpec: string

任务组的版本规范。示例：1、1.0。

expand: TaskGroupExpands

应展开的属性。示例 $expand=Tasks 将展开嵌套任务组。

Promise<TaskGroup>

getTaskGroupHistory(string, string)

function getTaskGroupHistory(project: string, taskGroupId: string): Promise<TaskGroupRevision[]>

参数

project: string

项目 ID 或项目名称

taskGroupId: string

Promise<TaskGroupRevision[]>

getTaskGroupRevision(string, string, number)

function getTaskGroupRevision(project: string, taskGroupId: string, revision: number): Promise<string>

参数

project: string

项目 ID 或项目名称

taskGroupId: string

revision: number

Promise<string>

getTaskGroups(string, string, boolean, string, boolean, number, Date, TaskGroupQueryOrder)

列出任务组。

function getTaskGroups(project: string, taskGroupId?: string, expanded?: boolean, taskIdFilter?: string, deleted?: boolean, top?: number, continuationToken?: Date, queryOrder?: TaskGroupQueryOrder): Promise<TaskGroup[]>

参数

project: string

项目 ID 或项目名称

taskGroupId: string

任务组的 ID。

expanded: boolean

“true”表示以递归方式展开任务组。默认值为“false”。

taskIdFilter: string

要筛选的 taskId 的 Guid。

deleted: boolean

“true”表示包含已删除的任务组。默认值为“false”。

top: number

要获取的任务组数。

continuationToken: Date

获取提供延续标记后的任务组。

queryOrder: TaskGroupQueryOrder

按定义的顺序获取结果。默认值为“CreatedOnDescending”。

Promise<TaskGroup[]>

getTaskHubLicenseDetails(string, boolean, boolean)

function getTaskHubLicenseDetails(hubName: string, includeEnterpriseUsersCount?: boolean, includeHostedAgentMinutesCount?: boolean): Promise<TaskHubLicenseDetails>

参数

hubName: string

includeEnterpriseUsersCount: boolean

includeHostedAgentMinutesCount: boolean

Promise<TaskHubLicenseDetails>

getVariableGroup(string, number)

获取变量组。

function getVariableGroup(project: string, groupId: number): Promise<VariableGroup>

参数

project: string

项目 ID 或项目名称

groupId: number

变量组的 ID。

Promise<VariableGroup>

getVariableGroups(string, string, VariableGroupActionFilter, number, number, VariableGroupQueryOrder)

获取变量组。

function getVariableGroups(project: string, groupName?: string, actionFilter?: VariableGroupActionFilter, top?: number, continuationToken?: number, queryOrder?: VariableGroupQueryOrder): Promise<VariableGroup[]>

参数

project: string

项目 ID 或项目名称

groupName: string

变量组的名称。

actionFilter: VariableGroupActionFilter

变量组的操作筛选器。它指定可以对变量组执行的操作。

top: number

要获取的变量组数。

continuationToken: number

获取提供的继续标记之后的变量组。

queryOrder: VariableGroupQueryOrder

按定义的顺序获取结果。默认值为“IdDescending”。

Promise<VariableGroup[]>

getVariableGroupsById(string, number[], boolean)

按 ID 获取变量组。

function getVariableGroupsById(project: string, groupIds: number[], loadSecrets?: boolean): Promise<VariableGroup[]>

参数

project: string

项目 ID 或项目名称

groupIds: number[]

以逗号分隔的变量组 ID 列表。

loadSecrets: boolean

指示是否应加载变量组中的机密的标志。

Promise<VariableGroup[]>

getVirtualMachineGroup(string, number, number)

function getVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<VirtualMachineGroup>

参数

project: string

项目 ID 或项目名称

environmentId: number

resourceId: number

Promise<VirtualMachineGroup>

getVirtualMachines(string, number, number, string, string, boolean, string[], number)

function getVirtualMachines(project: string, environmentId: number, resourceId: number, continuationToken?: string, name?: string, partialNameMatch?: boolean, tags?: string[], top?: number): Promise<PagedList<VirtualMachine>>

参数

project: string

项目 ID 或项目名称

environmentId: number

resourceId: number

continuationToken: string

name: string

partialNameMatch: boolean

tags: string[]

top: number

Promise<PagedList<VirtualMachine>>

getVstsAadTenantId()

function getVstsAadTenantId(): Promise<string>

Promise<string>

getYamlSchema(boolean)

获取用于 Yaml 文件验证的 Yaml 架构。

function getYamlSchema(validateTaskNames?: boolean): Promise<any>

参数

validateTaskNames: boolean

架构是否应验证任务是否实际安装 (对不需要验证) 的脱机工具有用。

Promise<any>

hasPoolPermissions(number, number)

检查当前标识是否已传递对池的权限。

function hasPoolPermissions(poolId: number, permissions: number): Promise<boolean>

参数

poolId: number

要检查的池的 ID

permissions: number

检查的权限。可以使用按位 OR 运算符 (多个权限合并为单个值，例如 AgentPoolPermissions.Manage |AgentPoolPermissions.View)

Promise<boolean>

publishTaskGroup(PublishTaskGroupMetadata, string, string)

function publishTaskGroup(taskGroupMetadata: PublishTaskGroupMetadata, project: string, parentTaskGroupId: string): Promise<TaskGroup[]>

参数

taskGroupMetadata: PublishTaskGroupMetadata

project: string

项目 ID 或项目名称

parentTaskGroupId: string

Promise<TaskGroup[]>

queryEndpoint(TaskDefinitionEndpoint)

由“终结点”定义的 GET 请求的代理。请求使用服务连接进行授权。使用基于 XPath/Json 的选择器筛选响应。

function queryEndpoint(endpoint: TaskDefinitionEndpoint): Promise<string[]>

参数

endpoint: TaskDefinitionEndpoint

描述要提取的 URL。

Promise<string[]>

querySecureFilesByProperties(string, string, string)

使用名称模式和文件属性条件查询安全文件。

function querySecureFilesByProperties(condition: string, project: string, namePattern?: string): Promise<SecureFile[]>

参数

condition: string

此处介绍了main条件语法。使用 属性 ('property-name') 函数访问安全文件的指定属性的值。如果未设置属性，则返回 null。例如 and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )

project: string

项目 ID 或项目名称

namePattern: string

要匹配的安全文件的名称。可以包含通配符以匹配多个文件。

Promise<SecureFile[]>

queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)

function queueAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number): Promise<TaskAgentPoolMaintenanceJob>

参数

job: TaskAgentPoolMaintenanceJob

poolId: number

Promise<TaskAgentPoolMaintenanceJob>

queueAgentRequest(TaskAgentJobRequest, string, number)

function queueAgentRequest(request: TaskAgentJobRequest, project: string, queueId: number): Promise<TaskAgentJobRequest>

参数

request: TaskAgentJobRequest

project: string

项目 ID 或项目名称

queueId: number

Promise<TaskAgentJobRequest>

queueAgentRequestByPool(TaskAgentJobRequest, number)

function queueAgentRequestByPool(request: TaskAgentJobRequest, poolId: number): Promise<TaskAgentJobRequest>

参数

request: TaskAgentJobRequest

poolId: number

Promise<TaskAgentJobRequest>

refreshAgent(number, number)

function refreshAgent(poolId: number, agentId: number): Promise<void>

参数

poolId: number

agentId: number

Promise<void>

refreshAgents(number)

function refreshAgents(poolId: number): Promise<void>

参数

poolId: number

Promise<void>

refreshDeploymentMachines(string, number)

function refreshDeploymentMachines(project: string, deploymentGroupId: number): Promise<void>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

Promise<void>

refreshDeploymentTargets(string, number)

升级部署组中的部署目标。

function refreshDeploymentTargets(project: string, deploymentGroupId: number): Promise<void>

参数

project: string

项目 ID 或项目名称

deploymentGroupId: number

部署组的 ID。

Promise<void>

replaceAgent(TaskAgent, number, number)

替换代理。你可能不想直接调用此终结点。请改用代理配置脚本从组织中删除和重新配置代理。

function replaceAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>

参数

agent: TaskAgent

更新了有关替换代理的详细信息

poolId: number

要使用的代理池

agentId: number

要替换的代理

Promise<TaskAgent>

replaceDeploymentMachine(DeploymentMachine, string, number, number)

function replaceDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<DeploymentMachine>

参数

machine: DeploymentMachine

project: string

项目 ID 或项目名称

deploymentGroupId: number

machineId: number

Promise<DeploymentMachine>

replaceDeploymentTarget(DeploymentMachine, string, number, number)

替换部署组中的部署目标。通常，这由代理配置工具调用。

function replaceDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<DeploymentMachine>

参数

machine: DeploymentMachine

新部署目标。

project: string

项目 ID 或项目名称

deploymentGroupId: number

在其中替换部署目标的部署组的 ID。

targetId: number

要替换的部署目标的 ID。

Promise<DeploymentMachine>

sendMessage(TaskAgentMessage, number, number)

function sendMessage(message: TaskAgentMessage, poolId: number, requestId: number): Promise<void>

参数

message: TaskAgentMessage

poolId: number

requestId: number

Promise<void>

setAgentPoolMetadata(any, number)

function setAgentPoolMetadata(agentPoolMetadata: any, poolId: number): Promise<void>

参数

agentPoolMetadata: any

poolId: number

Promise<void>

shareVariableGroup(VariableGroupProjectReference[], number)

添加变量组。

function shareVariableGroup(variableGroupProjectReferences: VariableGroupProjectReference[], variableGroupId: number): Promise<void>

参数

variableGroupProjectReferences: VariableGroupProjectReference[]

variableGroupId: number

Promise<void>

undeleteTaskGroup(TaskGroup, string)

function undeleteTaskGroup(taskGroup: TaskGroup, project: string): Promise<TaskGroup[]>

参数

taskGroup: TaskGroup

project: string

项目 ID 或项目名称

Promise<TaskGroup[]>

updateAgent(TaskAgent, number, number)

更新代理详细信息。

function updateAgent(agent: TaskAgent, poolId: number, agentId: number): Promise<TaskAgent>

参数

agent: TaskAgent

更新了有关代理的详细信息

poolId: number

要使用的代理池

agentId: number

要更新的代理

Promise<TaskAgent>

updateAgentCloud(TaskAgentCloud, number)

function updateAgentCloud(updatedCloud: TaskAgentCloud, agentCloudId: number): Promise<TaskAgentCloud>

参数

updatedCloud: TaskAgentCloud

agentCloudId: number

Promise<TaskAgentCloud>

updateAgentPool(TaskAgentPool, number)

更新代理池的属性

function updateAgentPool(pool: TaskAgentPool, poolId: number): Promise<TaskAgentPool>

参数

pool: TaskAgentPool

更新了代理池详细信息

poolId: number

要更新的代理池

Promise<TaskAgentPool>

updateAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number, number)

function updateAgentPoolMaintenanceDefinition(definition: TaskAgentPoolMaintenanceDefinition, poolId: number, definitionId: number): Promise<TaskAgentPoolMaintenanceDefinition>

参数

definition: TaskAgentPoolMaintenanceDefinition

poolId: number

definitionId: number

Promise<TaskAgentPoolMaintenanceDefinition>

updateAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number, number)

function updateAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number, jobId: number): Promise<TaskAgentPoolMaintenanceJob>

参数

job: TaskAgentPoolMaintenanceJob

poolId: number

jobId: number

Promise<TaskAgentPoolMaintenanceJob>

updateAgentRequest(TaskAgentJobRequest, number, number, string, TaskAgentRequestUpdateOptions)

function updateAgentRequest(request: TaskAgentJobRequest, poolId: number, requestId: number, lockToken: string, updateOptions?: TaskAgentRequestUpdateOptions): Promise<TaskAgentJobRequest>

参数

request: TaskAgentJobRequest

poolId: number

requestId: number

lockToken: string

updateOptions: TaskAgentRequestUpdateOptions

Promise<TaskAgentJobRequest>

updateAgentUpdateState(number, number, string)

function updateAgentUpdateState(poolId: number, agentId: number, currentState: string): Promise<TaskAgent>

参数

poolId: number

agentId: number

currentState: string

Promise<TaskAgent>

updateAgentUserCapabilities({[key: string]: string}, number, number)

function updateAgentUserCapabilities(userCapabilities: {[key: string]: string}, poolId: number, agentId: number): Promise<TaskAgent>

参数

userCapabilities: {[key: string]: string}

poolId: number

agentId: number

Promise<TaskAgent>

updateDeploymentGroup(DeploymentGroupUpdateParameter, string, number)

更新部署组。

function updateDeploymentGroup(deploymentGroup: DeploymentGroupUpdateParameter, project: string, deploymentGroupId: number): Promise<DeploymentGroup>

参数

deploymentGroup: DeploymentGroupUpdateParameter

要更新的部署组。

project: string

项目 ID 或项目名称

deploymentGroupId: number

部署组的 ID。

Promise<DeploymentGroup>

updateDeploymentMachine(DeploymentMachine, string, number, number)

function updateDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<DeploymentMachine>

参数

machine: DeploymentMachine

project: string

项目 ID 或项目名称

deploymentGroupId: number

machineId: number

Promise<DeploymentMachine>

updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)

function updateDeploymentMachineGroup(machineGroup: DeploymentMachineGroup, project: string, machineGroupId: number): Promise<DeploymentMachineGroup>

参数

machineGroup: DeploymentMachineGroup

project: string

项目 ID 或项目名称

machineGroupId: number

Promise<DeploymentMachineGroup>

updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)

function updateDeploymentMachineGroupMachines(deploymentMachines: DeploymentMachine[], project: string, machineGroupId: number): Promise<DeploymentMachine[]>

参数

deploymentMachines: DeploymentMachine[]

project: string

项目 ID 或项目名称

machineGroupId: number

Promise<DeploymentMachine[]>

updateDeploymentMachines(DeploymentMachine[], string, number)

function updateDeploymentMachines(machines: DeploymentMachine[], project: string, deploymentGroupId: number): Promise<DeploymentMachine[]>

参数

machines: DeploymentMachine[]

project: string

项目 ID 或项目名称

deploymentGroupId: number

Promise<DeploymentMachine[]>

updateDeploymentTarget(DeploymentMachine, string, number, number)

更新部署组中的部署目标及其代理属性。通常，这由代理配置工具调用。

function updateDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<DeploymentMachine>

参数

machine: DeploymentMachine

要更新的部署目标。

project: string

项目 ID 或项目名称

deploymentGroupId: number

在其中更新部署目标的部署组的 ID。

targetId: number

要更新的部署目标的 ID。

Promise<DeploymentMachine>

updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)

更新部署组中部署目标列表的标记。

function updateDeploymentTargets(machines: DeploymentTargetUpdateParameter[], project: string, deploymentGroupId: number): Promise<DeploymentMachine[]>

参数

machines: DeploymentTargetUpdateParameter[]

具有 udpdate 标记的部署目标。

project: string

项目 ID 或项目名称

deploymentGroupId: number

在其中更新部署目标的部署组的 ID。

Promise<DeploymentMachine[]>

updateEnvironment(EnvironmentUpdateParameter, string, number)

更新指定的环境。

function updateEnvironment(environmentUpdateParameter: EnvironmentUpdateParameter, project: string, environmentId: number): Promise<EnvironmentInstance>

参数

environmentUpdateParameter: EnvironmentUpdateParameter

要更新的环境数据。

project: string

项目 ID 或项目名称

environmentId: number

环境的 ID。

Promise<EnvironmentInstance>

updateSecureFile(SecureFile, string, string)

更新现有安全文件的名称或属性

function updateSecureFile(secureFile: SecureFile, project: string, secureFileId: string): Promise<SecureFile>

参数

secureFile: SecureFile

具有更新名称和/或属性的安全文件

project: string

项目 ID 或项目名称

secureFileId: string

唯一的安全文件 ID

Promise<SecureFile>

updateSecureFiles(SecureFile[], string)

更新一组安全文件的属性和/或名称。文件由其 ID 标识。提供的属性将完全替代现有属性，即不合并。

function updateSecureFiles(secureFiles: SecureFile[], project: string): Promise<SecureFile[]>

参数

secureFiles: SecureFile[]

安全文件对象的列表。只有三个字段必须填充 Id、Name 和 Properties。对象中的其余字段将被忽略。

project: string

项目 ID 或项目名称

Promise<SecureFile[]>

updateTaskGroup(TaskGroupUpdateParameter, string, string)

更新任务组。

function updateTaskGroup(taskGroup: TaskGroupUpdateParameter, project: string, taskGroupId?: string): Promise<TaskGroup>

参数

taskGroup: TaskGroupUpdateParameter

要更新的任务组。

project: string

项目 ID 或项目名称

taskGroupId: string

要更新的任务组的 ID。

Promise<TaskGroup>

updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)

function updateTaskGroupProperties(taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase, project: string, taskGroupId: string, disablePriorVersions?: boolean): Promise<TaskGroup[]>

参数

taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase

project: string

项目 ID 或项目名称

taskGroupId: string

disablePriorVersions: boolean

Promise<TaskGroup[]>

updateTaskHubLicenseDetails(TaskHubLicenseDetails, string)

function updateTaskHubLicenseDetails(taskHubLicenseDetails: TaskHubLicenseDetails, hubName: string): Promise<TaskHubLicenseDetails>

参数

taskHubLicenseDetails: TaskHubLicenseDetails

hubName: string

Promise<TaskHubLicenseDetails>

updateVariableGroup(VariableGroupParameters, number)

更新变量组。

function updateVariableGroup(variableGroupParameters: VariableGroupParameters, groupId: number): Promise<VariableGroup>

参数

variableGroupParameters: VariableGroupParameters

groupId: number

要更新的变量组的 ID。

Promise<VariableGroup>

updateVirtualMachineGroup(VirtualMachineGroup, string, number)

function updateVirtualMachineGroup(resource: VirtualMachineGroup, project: string, environmentId: number): Promise<VirtualMachineGroup>

参数

resource: VirtualMachineGroup

project: string

项目 ID 或项目名称

environmentId: number

Promise<VirtualMachineGroup>

updateVirtualMachines(VirtualMachine[], string, number, number)

function updateVirtualMachines(machines: VirtualMachine[], project: string, environmentId: number, resourceId: number): Promise<VirtualMachine[]>

参数

machines: VirtualMachine[]

project: string

项目 ID 或项目名称

environmentId: number

resourceId: number

Promise<VirtualMachine[]>

uploadSecureFile(any, string, string, boolean)

上传安全文件，在请求正文中包含文件流

function uploadSecureFile(content: any, project: string, name: string, authorizePipelines?: boolean): Promise<SecureFile>

参数

content: any

要上传的内容

project: string

项目 ID 或项目名称

name: string

要上传的文件的名称

authorizePipelines: boolean

如果 authorizePipelines 为 true，则授权安全文件供项目中的所有管道使用。

Promise<SecureFile>

validateInputs(InputValidationRequest)

function validateInputs(inputValidationRequest: InputValidationRequest): Promise<InputValidationRequest>

参数

inputValidationRequest: InputValidationRequest

Promise<InputValidationRequest>

通过

TaskAgentRestClient class

构造函数

属性

方法

构造函数详细信息

TaskAgentRestClient(IVssRestClientOptions)

参数

属性详细信息

RESOURCE_AREA_ID

属性值

方法详细信息

addAgent(TaskAgent, number)

参数

返回

addAgentCloud(TaskAgentCloud)

参数

返回

addAgentPool(TaskAgentPool)

参数

返回

addAgentQueue(TaskAgentQueue, string, boolean)

参数

返回

addDeploymentGroup(DeploymentGroupCreateParameter, string)

参数

返回

addDeploymentMachine(DeploymentMachine, string, number)

参数

返回

addDeploymentMachineGroup(DeploymentMachineGroup, string)

参数

返回

addDeploymentTarget(DeploymentMachine, string, number)

参数

返回

addEnvironment(EnvironmentCreateParameter, string)

参数

返回

addKubernetesResource(KubernetesResourceCreateParameters, string, number)

参数

返回

addTaskGroup(TaskGroupCreateParameter, string)

参数

返回

addVariableGroup(VariableGroupParameters)

参数

返回

addVirtualMachineGroup(VirtualMachineGroupCreateParameters, string, number)

参数

返回

createAadOAuthRequest(string, string, AadLoginPromptOption, string, boolean)

参数

返回

createAgentPoolMaintenanceDefinition(TaskAgentPoolMaintenanceDefinition, number)

参数

返回

createAgentSession(TaskAgentSession, number)

参数

返回

createTeamProject(string)

参数

返回

deleteAgent(number, number)

参数

返回

deleteAgentCloud(number)

参数

返回

deleteAgentPool(number)

参数

返回

deleteAgentPoolMaintenanceDefinition(number, number)

参数

返回

deleteAgentPoolMaintenanceJob(number, number)

参数

返回

deleteAgentQueue(number, string)

参数