TaskAgentRestClient class
應該 (衍生自) 的基類對 VSS REST API 提出要求
- Extends
建構函式
| Task |
屬性
| RESOURCE_AREA_ID |
方法
建構函式詳細資料
TaskAgentRestClient(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
項目識別碼或項目名稱
- authorizePipelines
-
boolean
使用 YAML 時自動授權此佇列
傳回
Promise<TaskAgentQueue>
addDeploymentGroup(DeploymentGroupCreateParameter, string)
Create 部署群組。
function addDeploymentGroup(deploymentGroup: DeploymentGroupCreateParameter, project: string): Promise<DeploymentGroup>參數
- deploymentGroup
- DeploymentGroupCreateParameter
要建立的部署群組。
- project
-
string
項目識別碼或項目名稱
傳回
Promise<DeploymentGroup>
addDeploymentMachine(DeploymentMachine, string, number)
function addDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number): Promise<DeploymentMachine>參數
- machine
- DeploymentMachine
- project
-
string
項目識別碼或項目名稱
- deploymentGroupId
-
number
傳回
Promise<DeploymentMachine>
addDeploymentMachineGroup(DeploymentMachineGroup, string)
function addDeploymentMachineGroup(machineGroup: DeploymentMachineGroup, project: string): Promise<DeploymentMachineGroup>參數
- machineGroup
- DeploymentMachineGroup
- project
-
string
項目識別碼或項目名稱
傳回
Promise<DeploymentMachineGroup>
addDeploymentTarget(DeploymentMachine, string, number)
向部署群組註冊部署目標。 一般而言，代理程式組態工具會呼叫此功能。
function addDeploymentTarget(machine: DeploymentMachine, project: string, deploymentGroupId: number): Promise<DeploymentMachine>參數
- machine
- DeploymentMachine
要註冊的部署目標。
- project
-
string
項目識別碼或項目名稱
- deploymentGroupId
-
number
部署目標註冊的目標部署群組標識碼。
傳回
Promise<DeploymentMachine>
addEnvironment(EnvironmentCreateParameter, string)
建立環境。
function addEnvironment(environmentCreateParameter: EnvironmentCreateParameter, project: string): Promise<EnvironmentInstance>參數
- environmentCreateParameter
- EnvironmentCreateParameter
要建立的環境。
- project
-
string
項目識別碼或項目名稱
傳回
Promise<EnvironmentInstance>
addKubernetesResource(KubernetesResourceCreateParameters, string, number)
function addKubernetesResource(createParameters: KubernetesResourceCreateParameters, project: string, environmentId: number): Promise<KubernetesResource>參數
- createParameters
- KubernetesResourceCreateParameters
- project
-
string
項目識別碼或項目名稱
- environmentId
-
number
傳回
Promise<KubernetesResource>
addTaskGroup(TaskGroupCreateParameter, string)
Create 工作組。
function addTaskGroup(taskGroup: TaskGroupCreateParameter, project: string): Promise<TaskGroup>參數
- taskGroup
- TaskGroupCreateParameter
要建立的工作群組物件。
- project
-
string
項目識別碼或項目名稱
傳回
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
項目識別碼或項目名稱
- 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 新的Team專案。
function createTeamProject(project?: string): Promise<void>參數
- project
-
string
項目識別碼或項目名稱
傳回
Promise<void>
deleteAgent(number, number)
刪除代理程式。 您可能不想直接呼叫此端點。 請改 用代理程式組態腳本 ，從您的組織移除代理程式。
function deleteAgent(poolId: number, agentId: number): Promise<void>參數
- poolId
-
number
要從中移除代理程式的集區標識碼
- agentId
-
number
要移除的代理程式識別碼
傳回
Promise<void>
deleteAgentCloud(number)
function deleteAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>參數
- agentCloudId
-
number
傳回
Promise<TaskAgentCloud>
deleteAgentPool(number)
刪除代理程式集區。
function deleteAgentPool(poolId: number): Promise<void>參數
- poolId
-
number
要刪除的代理程式集區識別碼
傳回
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
項目識別碼或項目名稱
傳回
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
項目識別碼或項目名稱
- deploymentGroupId
-
number
要刪除的部署群組標識碼。
傳回
Promise<void>
deleteDeploymentMachine(string, number, number)
function deleteDeploymentMachine(project: string, deploymentGroupId: number, machineId: number): Promise<void>參數
- project
-
string
項目識別碼或項目名稱
- deploymentGroupId
-
number
- machineId
-
number
傳回
Promise<void>
deleteDeploymentMachineGroup(string, number)
function deleteDeploymentMachineGroup(project: string, machineGroupId: number): Promise<void>參數
- project
-
string
項目識別碼或項目名稱
- machineGroupId
-
number
傳回
Promise<void>
deleteDeploymentTarget(string, number, number)
刪除部署群組中的部署目標。 這也會從相關聯的部署集區中刪除代理程式。
function deleteDeploymentTarget(project: string, deploymentGroupId: number, targetId: number): Promise<void>參數
- project
-
string
項目識別碼或項目名稱
- deploymentGroupId
-
number
刪除部署目標的部署群組標識碼。
- targetId
-
number
要刪除之部署目標的識別碼。
傳回
Promise<void>
deleteEnvironment(string, number)
刪除指定的環境。
function deleteEnvironment(project: string, environmentId: number): Promise<void>參數
- project
-
string
項目識別碼或項目名稱
- environmentId
-
number
環境的標識碼。
傳回
Promise<void>
deleteKubernetesResource(string, number, number)
function deleteKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<void>參數
- project
-
string
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- secureFileId
-
string
唯一的安全檔案標識碼
傳回
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
項目識別碼或項目名稱
- taskGroupId
-
string
要刪除之工作組的標識碼。
- comment
-
string
要刪除的批注。
傳回
Promise<void>
deleteVariableGroup(number, string[])
刪除變數群組
function deleteVariableGroup(groupId: number, projectIds: string[]): Promise<void>參數
- groupId
-
number
變數群組的標識碼。
- projectIds
-
string[]
傳回
Promise<void>
deleteVirtualMachineGroup(string, number, number)
function deleteVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<void>參數
- project
-
string
項目識別碼或項目名稱
- environmentId
-
number
- resourceId
-
number
傳回
Promise<void>
downloadSecureFile(string, string, string, boolean)
依標識碼下載安全檔案
function downloadSecureFile(project: string, secureFileId: string, ticket: string, download?: boolean): Promise<ArrayBuffer>參數
- project
-
string
項目識別碼或項目名稱
- secureFileId
-
string
唯一的安全檔案標識碼
- ticket
-
string
有效的下載票證
- download
-
boolean
如果 download 為 true，則會在回應本文中以附加專案的形式傳送檔案。 如果下載為 false，回應本文會包含檔案數據流。
傳回
Promise<ArrayBuffer>
generateDeploymentGroupAccessToken(string, number)
取得 PAT 令牌，以管理部署群組中的 (設定、移除、標記) 部署目標。
function generateDeploymentGroupAccessToken(project: string, deploymentGroupId: number): Promise<string>參數
- project
-
string
項目識別碼或項目名稱
- deploymentGroupId
-
number
部署目標的受控部署群組標識碼。
傳回
Promise<string>
generateDeploymentMachineGroupAccessToken(string, number)
function generateDeploymentMachineGroupAccessToken(project: string, machineGroupId: number): Promise<string>參數
- project
-
string
項目識別碼或項目名稱
- machineGroupId
-
number
傳回
Promise<string>
generateDeploymentPoolAccessToken(number)
取得 PAT 令牌，以管理部署集區中的 (設定、移除、標記) 部署代理程式。
function generateDeploymentPoolAccessToken(poolId: number): Promise<string>參數
- poolId
-
number
部署代理程式的部署集區標識碼。
傳回
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
要取得相關信息的代理程式識別碼
- 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()
getAgentCloudTypes()
取得代理程式雲端類型。
function getAgentCloudTypes(): Promise<TaskAgentCloudType[]>傳回
Promise<TaskAgentCloudType[]>
getAgentPool(number, string[], TaskAgentPoolActionFilter)
取得代理程式集區的相關信息。
function getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentPoolActionFilter): Promise<TaskAgentPool>參數
- poolId
-
number
代理程式集區標識碼
- 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[]
要擷取的集區標識碼
- actionFilter
- TaskAgentPoolActionFilter
篩選呼叫使用者是否具有使用或管理許可權
傳回
Promise<TaskAgentPool[]>
getAgentQueue(number, string, TaskAgentQueueActionFilter)
取得代理程式佇列的相關信息。
function getAgentQueue(queueId: number, project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue>參數
- queueId
-
number
要取得相關信息的代理程式佇列
- project
-
string
項目識別碼或項目名稱
- actionFilter
- TaskAgentQueueActionFilter
篩選呼叫使用者是否具有使用或管理許可權
傳回
Promise<TaskAgentQueue>
getAgentQueues(string, string, TaskAgentQueueActionFilter)
取得代理程式佇列的清單。
function getAgentQueues(project?: string, queueName?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>參數
- project
-
string
項目識別碼或項目名稱
- queueName
-
string
篩選代理程式佇列名稱
- actionFilter
- TaskAgentQueueActionFilter
篩選呼叫使用者是否具有使用或管理許可權
傳回
Promise<TaskAgentQueue[]>
getAgentQueuesByIds(number[], string, TaskAgentQueueActionFilter)
依其標識碼取得代理程式佇列的清單
function getAgentQueuesByIds(queueIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>參數
- queueIds
-
number[]
要擷取之代理程式佇列標識碼的逗號分隔清單
- project
-
string
項目識別碼或項目名稱
- actionFilter
- TaskAgentQueueActionFilter
篩選呼叫使用者是否具有使用或管理許可權
傳回
Promise<TaskAgentQueue[]>
getAgentQueuesByNames(string[], string, TaskAgentQueueActionFilter)
依其名稱取得代理程式佇列的清單
function getAgentQueuesByNames(queueNames: string[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>參數
- queueNames
-
string[]
要擷取之代理程式名稱的逗號分隔清單
- project
-
string
項目識別碼或項目名稱
- actionFilter
- TaskAgentQueueActionFilter
篩選呼叫使用者是否具有使用或管理許可權
傳回
Promise<TaskAgentQueue[]>
getAgentQueuesForPools(number[], string, TaskAgentQueueActionFilter)
依集區標識碼取得代理程式佇列清單
function getAgentQueuesForPools(poolIds: number[], project?: string, actionFilter?: TaskAgentQueueActionFilter): Promise<TaskAgentQueue[]>參數
- poolIds
-
number[]
要取得對應佇列的集區標識碼逗號分隔清單
- project
-
string
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- deploymentGroupId
-
number
目標所屬部署群組的標識碼。
- targetId
-
number
部署目標的標識碼。
- 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
項目識別碼或項目名稱
- deploymentGroupId
-
number
目標所屬部署群組的標識碼。
- targetIds
-
number[]
以逗號分隔的部署目標標識碼清單。
- ownerId
-
number
代理程式作業要求的擁有者標識碼。
- 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
項目識別碼或項目名稱
- 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)
依其標識碼取得部署群組。
function getDeploymentGroup(project: string, deploymentGroupId: number, actionFilter?: DeploymentGroupActionFilter, expand?: DeploymentGroupExpands): Promise<DeploymentGroup>參數
- project
-
string
項目識別碼或項目名稱
- deploymentGroupId
-
number
部署群組的標識碼。
- actionFilter
- DeploymentGroupActionFilter
只有在此動作可以執行時，才能取得部署群組。
- expand
- DeploymentGroupExpands
在傳回的物件中包含這些其他詳細數據。
傳回
Promise<DeploymentGroup>
getDeploymentGroups(string, string, DeploymentGroupActionFilter, DeploymentGroupExpands, string, number, number[])
依名稱或標識碼取得部署群組的清單。
function getDeploymentGroups(project: string, name?: string, actionFilter?: DeploymentGroupActionFilter, expand?: DeploymentGroupExpands, continuationToken?: string, top?: number, ids?: number[]): Promise<PagedList<DeploymentGroup>>參數
- project
-
string
項目識別碼或項目名稱
- name
-
string
部署群組的名稱。
- actionFilter
- DeploymentGroupActionFilter
只取得可執行此動作的部署群組。
- expand
- DeploymentGroupExpands
在傳回的物件中包含這些其他詳細數據。
- continuationToken
-
string
取得名稱大於這個 continuationToken 語彙的部署群組。
- top
-
number
要傳回的部署群組數目上限。 預設值為 1000。
- ids
-
number[]
以逗號分隔的部署群組標識碼清單。
傳回
Promise<PagedList<DeploymentGroup>>
getDeploymentGroupsMetrics(string, string, string, number)
取得部署群組計量的清單。
function getDeploymentGroupsMetrics(project: string, deploymentGroupName?: string, continuationToken?: string, top?: number): Promise<PagedList<DeploymentGroupMetrics>>參數
- project
-
string
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- deploymentGroupId
-
number
- machineId
-
number
- expand
- DeploymentMachineExpands
傳回
Promise<DeploymentMachine>
getDeploymentMachineGroup(string, number, MachineGroupActionFilter)
function getDeploymentMachineGroup(project: string, machineGroupId: number, actionFilter?: MachineGroupActionFilter): Promise<DeploymentMachineGroup>參數
- project
-
string
項目識別碼或項目名稱
- machineGroupId
-
number
- actionFilter
- MachineGroupActionFilter
傳回
Promise<DeploymentMachineGroup>
getDeploymentMachineGroupMachines(string, number, string[])
function getDeploymentMachineGroupMachines(project: string, machineGroupId: number, tagFilters?: string[]): Promise<DeploymentMachine[]>參數
- project
-
string
項目識別碼或項目名稱
- machineGroupId
-
number
- tagFilters
-
string[]
傳回
Promise<DeploymentMachine[]>
getDeploymentMachineGroups(string, string, MachineGroupActionFilter)
function getDeploymentMachineGroups(project: string, machineGroupName?: string, actionFilter?: MachineGroupActionFilter): Promise<DeploymentMachineGroup[]>參數
- project
-
string
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- 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[]
部署集區標識碼的清單。
傳回
Promise<DeploymentPoolSummary[]>
getDeploymentTarget(string, number, number, DeploymentTargetExpands)
依部署群組中的標識碼取得部署目標
function getDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, expand?: DeploymentTargetExpands): Promise<DeploymentMachine>參數
- project
-
string
項目識別碼或項目名稱
- deploymentGroupId
-
number
部署目標所屬部署群組的標識碼。
- targetId
-
number
要傳回之部署目標的標識碼。
- 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
項目識別碼或項目名稱
- deploymentGroupId
-
number
部署群組的標識碼。
- tags
-
string[]
只取得包含所有逗號分隔標籤清單的部署目標。
- name
-
string
要傳回之部署目標的名稱模式。
- partialNameMatch
-
boolean
當設定為 true 時，會將 名稱 視為模式。 Else 會將它視為絕對比對。 預設值為 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)
依其標識碼取得環境。
function getEnvironmentById(project: string, environmentId: number, expands?: EnvironmentExpands): Promise<EnvironmentInstance>參數
- project
-
string
項目識別碼或項目名稱
- environmentId
-
number
環境的標識碼。
- expands
- EnvironmentExpands
在傳回的物件中包含這些其他詳細數據。
傳回
Promise<EnvironmentInstance>
getEnvironmentDeploymentExecutionRecords(string, number, string, number)
取得環境部署執行歷程記錄
function getEnvironmentDeploymentExecutionRecords(project: string, environmentId: number, continuationToken?: string, top?: number): Promise<PagedList<EnvironmentDeploymentExecutionRecord>>參數
- project
-
string
項目識別碼或項目名稱
- environmentId
-
number
- continuationToken
-
string
- top
-
number
傳回
getEnvironments(string, string, string, number)
取得所有環境。
function getEnvironments(project: string, name?: string, continuationToken?: string, top?: number): Promise<PagedList<EnvironmentInstance>>參數
- project
-
string
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- 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()
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
項目識別碼或項目名稱
- secureFileId
-
string
唯一的安全檔案標識碼
- 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
項目識別碼或項目名稱
- namePattern
-
string
要比對的安全檔案名稱。 可以包含通配符以符合多個檔案。
- includeDownloadTickets
-
boolean
如果 includeDownloadTickets 為 true 且呼叫端具有許可權，則回應中會包含每個安全檔案的下載票證。
- actionFilter
- SecureFileActionFilter
依 [檢視]、[管理] 或 [使用] 動作的安全檔案許可權進行篩選。 默認為 [檢視]。
傳回
Promise<SecureFile[]>
getSecureFilesByIds(string, string[], boolean, SecureFileActionFilter)
取得安全檔案
function getSecureFilesByIds(project: string, secureFileIds: string[], includeDownloadTickets?: boolean, actionFilter?: SecureFileActionFilter): Promise<SecureFile[]>參數
- project
-
string
項目識別碼或項目名稱
- secureFileIds
-
string[]
安全檔案標識碼的清單
- 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
項目識別碼或項目名稱
- secureFileNames
-
string[]
安全檔案標識碼的清單
- 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
項目識別碼或項目名稱
- taskGroupId
-
string
工作組的標識碼。
- versionSpec
-
string
工作組的版本規格。 範例：1、1.0。
- expand
- TaskGroupExpands
應該展開的屬性。 example $expand=Tasks 會展開巢狀工作組。
傳回
Promise<TaskGroup>
getTaskGroupHistory(string, string)
function getTaskGroupHistory(project: string, taskGroupId: string): Promise<TaskGroupRevision[]>參數
- project
-
string
項目識別碼或項目名稱
- taskGroupId
-
string
傳回
Promise<TaskGroupRevision[]>
getTaskGroupRevision(string, string, number)
function getTaskGroupRevision(project: string, taskGroupId: string, revision: number): Promise<string>參數
- project
-
string
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- taskGroupId
-
string
工作組的標識碼。
- 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
項目識別碼或項目名稱
- groupId
-
number
變數群組的標識碼。
傳回
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
項目識別碼或項目名稱
- groupName
-
string
變數群組的名稱。
- actionFilter
- VariableGroupActionFilter
變數群組的動作篩選。 它會指定可在變數群組上執行的動作。
- top
-
number
要取得的變數群組數目。
- continuationToken
-
number
取得提供接續令牌之後的變數群組。
- queryOrder
- VariableGroupQueryOrder
以定義的順序取得結果。 預設值為 『IdDescending』。
傳回
Promise<VariableGroup[]>
getVariableGroupsById(string, number[], boolean)
依標識元取得變數群組。
function getVariableGroupsById(project: string, groupIds: number[], loadSecrets?: boolean): Promise<VariableGroup[]>參數
- project
-
string
項目識別碼或項目名稱
- groupIds
-
number[]
以逗號分隔的變數群組標識符清單。
- loadSecrets
-
boolean
旗標，指出是否應該載入變數群組內的秘密。
傳回
Promise<VariableGroup[]>
getVirtualMachineGroup(string, number, number)
function getVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<VirtualMachineGroup>參數
- project
-
string
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- 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
要檢查的集區標識碼
- 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
項目識別碼或項目名稱
- parentTaskGroupId
-
string
傳回
Promise<TaskGroup[]>
queryEndpoint(TaskDefinitionEndpoint)
'endpoint' 所定義之 GET 要求的 Proxy。 要求是使用服務連線進行授權。 回應會使用以 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
這裡 說明主要條件語法。 使用 屬性 (『property-name』) 函式來存取安全檔案的指定屬性值。 如果未設定 屬性，則會傳回 null。 例如 and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) )
- project
-
string
項目識別碼或項目名稱
- namePattern
-
string
要比對的安全檔名。 可以包含通配符以符合多個檔案。
傳回
Promise<SecureFile[]>
queueAgentPoolMaintenanceJob(TaskAgentPoolMaintenanceJob, number)
function queueAgentPoolMaintenanceJob(job: TaskAgentPoolMaintenanceJob, poolId: number): Promise<TaskAgentPoolMaintenanceJob>參數
- poolId
-
number
傳回
Promise<TaskAgentPoolMaintenanceJob>
queueAgentRequest(TaskAgentJobRequest, string, number)
function queueAgentRequest(request: TaskAgentJobRequest, project: string, queueId: number): Promise<TaskAgentJobRequest>參數
- request
- TaskAgentJobRequest
- project
-
string
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- deploymentGroupId
-
number
傳回
Promise<void>
refreshDeploymentTargets(string, number)
升級部署群組中的部署目標。
function refreshDeploymentTargets(project: string, deploymentGroupId: number): Promise<void>參數
- project
-
string
項目識別碼或項目名稱
- deploymentGroupId
-
number
部署群組的標識碼。
傳回
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
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- deploymentGroupId
-
number
取代部署目標的部署群組標識碼。
- targetId
-
number
要取代之部署目標的標識碼。
傳回
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
- variableGroupId
-
number
傳回
Promise<void>
undeleteTaskGroup(TaskGroup, string)
function undeleteTaskGroup(taskGroup: TaskGroup, project: string): Promise<TaskGroup[]>參數
- taskGroup
- TaskGroup
- project
-
string
項目識別碼或項目名稱
傳回
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>參數
- 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
項目識別碼或項目名稱
- deploymentGroupId
-
number
部署群組的標識碼。
傳回
Promise<DeploymentGroup>
updateDeploymentMachine(DeploymentMachine, string, number, number)
function updateDeploymentMachine(machine: DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<DeploymentMachine>參數
- machine
- DeploymentMachine
- project
-
string
項目識別碼或項目名稱
- deploymentGroupId
-
number
- machineId
-
number
傳回
Promise<DeploymentMachine>
updateDeploymentMachineGroup(DeploymentMachineGroup, string, number)
function updateDeploymentMachineGroup(machineGroup: DeploymentMachineGroup, project: string, machineGroupId: number): Promise<DeploymentMachineGroup>參數
- machineGroup
- DeploymentMachineGroup
- project
-
string
項目識別碼或項目名稱
- machineGroupId
-
number
傳回
Promise<DeploymentMachineGroup>
updateDeploymentMachineGroupMachines(DeploymentMachine[], string, number)
function updateDeploymentMachineGroupMachines(deploymentMachines: DeploymentMachine[], project: string, machineGroupId: number): Promise<DeploymentMachine[]>參數
- deploymentMachines
- project
-
string
項目識別碼或項目名稱
- machineGroupId
-
number
傳回
Promise<DeploymentMachine[]>
updateDeploymentMachines(DeploymentMachine[], string, number)
function updateDeploymentMachines(machines: DeploymentMachine[], project: string, deploymentGroupId: number): Promise<DeploymentMachine[]>參數
- machines
- project
-
string
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- deploymentGroupId
-
number
部署目標更新所在的部署群組標識碼。
- targetId
-
number
要更新之部署目標的標識碼。
傳回
Promise<DeploymentMachine>
updateDeploymentTargets(DeploymentTargetUpdateParameter[], string, number)
更新部署群組中部署目標清單的標記。
function updateDeploymentTargets(machines: DeploymentTargetUpdateParameter[], project: string, deploymentGroupId: number): Promise<DeploymentMachine[]>參數
- machines
部署目標，其標籤為 udpdate。
- project
-
string
項目識別碼或項目名稱
- deploymentGroupId
-
number
部署目標更新所在的部署群組標識碼。
傳回
Promise<DeploymentMachine[]>
updateEnvironment(EnvironmentUpdateParameter, string, number)
更新指定的環境。
function updateEnvironment(environmentUpdateParameter: EnvironmentUpdateParameter, project: string, environmentId: number): Promise<EnvironmentInstance>參數
- environmentUpdateParameter
- EnvironmentUpdateParameter
要更新的環境數據。
- project
-
string
項目識別碼或項目名稱
- environmentId
-
number
環境的標識碼。
傳回
Promise<EnvironmentInstance>
updateSecureFile(SecureFile, string, string)
更新現有安全檔案的名稱或屬性
function updateSecureFile(secureFile: SecureFile, project: string, secureFileId: string): Promise<SecureFile>參數
- secureFile
- SecureFile
具有更新名稱和/或屬性的安全檔案
- project
-
string
項目識別碼或項目名稱
- secureFileId
-
string
唯一的安全檔案標識碼
傳回
Promise<SecureFile>
updateSecureFiles(SecureFile[], string)
更新一組安全檔案的屬性和/或名稱。 檔案是由其標識碼所識別。 提供的屬性會完全覆寫現有的屬性，也就是不要合併。
function updateSecureFiles(secureFiles: SecureFile[], project: string): Promise<SecureFile[]>參數
- secureFiles
安全檔案對象的清單。 只有三個字段必須填入 [標識符]、[名稱] 和 [屬性]。 物件中的其餘欄位會被忽略。
- project
-
string
項目識別碼或項目名稱
傳回
Promise<SecureFile[]>
updateTaskGroup(TaskGroupUpdateParameter, string, string)
更新工作組。
function updateTaskGroup(taskGroup: TaskGroupUpdateParameter, project: string, taskGroupId?: string): Promise<TaskGroup>參數
- taskGroup
- TaskGroupUpdateParameter
要更新的工作群組。
- project
-
string
項目識別碼或項目名稱
- taskGroupId
-
string
要更新的工作群組標識碼。
傳回
Promise<TaskGroup>
updateTaskGroupProperties(TaskGroupUpdatePropertiesBase, string, string, boolean)
function updateTaskGroupProperties(taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase, project: string, taskGroupId: string, disablePriorVersions?: boolean): Promise<TaskGroup[]>參數
- taskGroupUpdateProperties
- TaskGroupUpdatePropertiesBase
- project
-
string
項目識別碼或項目名稱
- 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
要更新之變數群組的標識碼。
傳回
Promise<VariableGroup>
updateVirtualMachineGroup(VirtualMachineGroup, string, number)
function updateVirtualMachineGroup(resource: VirtualMachineGroup, project: string, environmentId: number): Promise<VirtualMachineGroup>參數
- resource
- VirtualMachineGroup
- project
-
string
項目識別碼或項目名稱
- environmentId
-
number
傳回
Promise<VirtualMachineGroup>
updateVirtualMachines(VirtualMachine[], string, number, number)
function updateVirtualMachines(machines: VirtualMachine[], project: string, environmentId: number, resourceId: number): Promise<VirtualMachine[]>參數
- machines
- project
-
string
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- name
-
string
要上傳的檔名
- authorizePipelines
-
boolean
如果 authorizePipelines 為 true，則安全檔案已獲授權供專案中的所有管線使用。
傳回
Promise<SecureFile>
validateInputs(InputValidationRequest)
function validateInputs(inputValidationRequest: InputValidationRequest): Promise<InputValidationRequest>參數
- inputValidationRequest
- InputValidationRequest
傳回
Promise<InputValidationRequest>