UNPKG

83.6 kBTypeScriptView Raw
1/// <reference types="node" />
2import basem = require('./ClientApiBases');
3import VsoBaseInterfaces = require('./interfaces/common/VsoBaseInterfaces');
4import TaskAgentInterfaces = require("./interfaces/TaskAgentInterfaces");
5import VSSInterfaces = require("./interfaces/common/VSSInterfaces");
6export interface ITaskAgentApiBase extends basem.ClientApiBase {
7 addAgentCloud(agentCloud: TaskAgentInterfaces.TaskAgentCloud): Promise<TaskAgentInterfaces.TaskAgentCloud>;
8 deleteAgentCloud(agentCloudId: number): Promise<TaskAgentInterfaces.TaskAgentCloud>;
9 getAgentCloud(agentCloudId: number): Promise<TaskAgentInterfaces.TaskAgentCloud>;
10 getAgentClouds(): Promise<TaskAgentInterfaces.TaskAgentCloud[]>;
11 updateAgentCloud(updatedCloud: TaskAgentInterfaces.TaskAgentCloud, agentCloudId: number): Promise<TaskAgentInterfaces.TaskAgentCloud>;
12 getAgentCloudTypes(): Promise<TaskAgentInterfaces.TaskAgentCloudType[]>;
13 getAgentRequestsForQueue(project: string, queueId: number, top: number, continuationToken?: string): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.TaskAgentJobRequest>>;
14 queueAgentRequest(request: TaskAgentInterfaces.TaskAgentJobRequest, project: string, queueId: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest>;
15 addAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number): Promise<TaskAgentInterfaces.TaskAgent>;
16 deleteAgent(poolId: number, agentId: number): Promise<void>;
17 getAgent(poolId: number, agentId: number, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[]): Promise<TaskAgentInterfaces.TaskAgent>;
18 getAgents(poolId: number, agentName?: string, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[], demands?: string[]): Promise<TaskAgentInterfaces.TaskAgent[]>;
19 replaceAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number, agentId: number): Promise<TaskAgentInterfaces.TaskAgent>;
20 updateAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number, agentId: number): Promise<TaskAgentInterfaces.TaskAgent>;
21 getAzureManagementGroups(): Promise<TaskAgentInterfaces.AzureManagementGroupQueryResult>;
22 getAzureSubscriptions(): Promise<TaskAgentInterfaces.AzureSubscriptionQueryResult>;
23 generateDeploymentGroupAccessToken(project: string, deploymentGroupId: number): Promise<string>;
24 addDeploymentGroup(deploymentGroup: TaskAgentInterfaces.DeploymentGroupCreateParameter, project: string): Promise<TaskAgentInterfaces.DeploymentGroup>;
25 deleteDeploymentGroup(project: string, deploymentGroupId: number): Promise<void>;
26 getDeploymentGroup(project: string, deploymentGroupId: number, actionFilter?: TaskAgentInterfaces.DeploymentGroupActionFilter, expand?: TaskAgentInterfaces.DeploymentGroupExpands): Promise<TaskAgentInterfaces.DeploymentGroup>;
27 getDeploymentGroups(project: string, name?: string, actionFilter?: TaskAgentInterfaces.DeploymentGroupActionFilter, expand?: TaskAgentInterfaces.DeploymentGroupExpands, continuationToken?: string, top?: number, ids?: number[]): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.DeploymentGroup>>;
28 updateDeploymentGroup(deploymentGroup: TaskAgentInterfaces.DeploymentGroupUpdateParameter, project: string, deploymentGroupId: number): Promise<TaskAgentInterfaces.DeploymentGroup>;
29 getDeploymentGroupsMetrics(project: string, deploymentGroupName?: string, continuationToken?: string, top?: number): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.DeploymentGroupMetrics>>;
30 getAgentRequestsForDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
31 getAgentRequestsForDeploymentMachines(project: string, deploymentGroupId: number, machineIds?: number[], completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
32 refreshDeploymentMachines(project: string, deploymentGroupId: number): Promise<void>;
33 generateDeploymentPoolAccessToken(poolId: number): Promise<string>;
34 getDeploymentPoolsSummary(poolName?: string, expands?: TaskAgentInterfaces.DeploymentPoolSummaryExpands, poolIds?: number[]): Promise<TaskAgentInterfaces.DeploymentPoolSummary[]>;
35 getAgentRequestsForDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
36 getAgentRequestsForDeploymentTargets(project: string, deploymentGroupId: number, targetIds?: number[], ownerId?: number, completedOn?: Date, completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
37 refreshDeploymentTargets(project: string, deploymentGroupId: number): Promise<void>;
38 queryEndpoint(endpoint: TaskAgentInterfaces.TaskDefinitionEndpoint): Promise<string[]>;
39 getEnvironmentDeploymentExecutionRecords(project: string, environmentId: number, continuationToken?: string, top?: number): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.EnvironmentDeploymentExecutionRecord>>;
40 addEnvironment(environmentCreateParameter: TaskAgentInterfaces.EnvironmentCreateParameter, project: string): Promise<TaskAgentInterfaces.EnvironmentInstance>;
41 deleteEnvironment(project: string, environmentId: number): Promise<void>;
42 getEnvironmentById(project: string, environmentId: number, expands?: TaskAgentInterfaces.EnvironmentExpands): Promise<TaskAgentInterfaces.EnvironmentInstance>;
43 getEnvironments(project: string, name?: string, continuationToken?: string, top?: number): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.EnvironmentInstance>>;
44 updateEnvironment(environmentUpdateParameter: TaskAgentInterfaces.EnvironmentUpdateParameter, project: string, environmentId: number): Promise<TaskAgentInterfaces.EnvironmentInstance>;
45 getTaskHubLicenseDetails(hubName: string, includeEnterpriseUsersCount?: boolean, includeHostedAgentMinutesCount?: boolean): Promise<TaskAgentInterfaces.TaskHubLicenseDetails>;
46 updateTaskHubLicenseDetails(taskHubLicenseDetails: TaskAgentInterfaces.TaskHubLicenseDetails, hubName: string): Promise<TaskAgentInterfaces.TaskHubLicenseDetails>;
47 validateInputs(inputValidationRequest: TaskAgentInterfaces.InputValidationRequest): Promise<TaskAgentInterfaces.InputValidationRequest>;
48 deleteAgentRequest(poolId: number, requestId: number, lockToken: string, result?: TaskAgentInterfaces.TaskResult, agentShuttingDown?: boolean): Promise<void>;
49 getAgentRequest(poolId: number, requestId: number, includeStatus?: boolean): Promise<TaskAgentInterfaces.TaskAgentJobRequest>;
50 getAgentRequests(poolId: number, top: number, continuationToken?: string): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.TaskAgentJobRequest>>;
51 getAgentRequestsForAgent(poolId: number, agentId: number, completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
52 getAgentRequestsForAgents(poolId: number, agentIds?: number[], completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
53 getAgentRequestsForPlan(poolId: number, planId: string, jobId?: string): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
54 queueAgentRequestByPool(request: TaskAgentInterfaces.TaskAgentJobRequest, poolId: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest>;
55 updateAgentRequest(request: TaskAgentInterfaces.TaskAgentJobRequest, poolId: number, requestId: number, lockToken: string, updateOptions?: TaskAgentInterfaces.TaskAgentRequestUpdateOptions): Promise<TaskAgentInterfaces.TaskAgentJobRequest>;
56 addKubernetesResource(createParameters: TaskAgentInterfaces.KubernetesResourceCreateParameters, project: string, environmentId: number): Promise<TaskAgentInterfaces.KubernetesResource>;
57 deleteKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<void>;
58 getKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<TaskAgentInterfaces.KubernetesResource>;
59 generateDeploymentMachineGroupAccessToken(project: string, machineGroupId: number): Promise<string>;
60 addDeploymentMachineGroup(machineGroup: TaskAgentInterfaces.DeploymentMachineGroup, project: string): Promise<TaskAgentInterfaces.DeploymentMachineGroup>;
61 deleteDeploymentMachineGroup(project: string, machineGroupId: number): Promise<void>;
62 getDeploymentMachineGroup(project: string, machineGroupId: number, actionFilter?: TaskAgentInterfaces.MachineGroupActionFilter): Promise<TaskAgentInterfaces.DeploymentMachineGroup>;
63 getDeploymentMachineGroups(project: string, machineGroupName?: string, actionFilter?: TaskAgentInterfaces.MachineGroupActionFilter): Promise<TaskAgentInterfaces.DeploymentMachineGroup[]>;
64 updateDeploymentMachineGroup(machineGroup: TaskAgentInterfaces.DeploymentMachineGroup, project: string, machineGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachineGroup>;
65 getDeploymentMachineGroupMachines(project: string, machineGroupId: number, tagFilters?: string[]): Promise<TaskAgentInterfaces.DeploymentMachine[]>;
66 updateDeploymentMachineGroupMachines(deploymentMachines: TaskAgentInterfaces.DeploymentMachine[], project: string, machineGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachine[]>;
67 addDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
68 deleteDeploymentMachine(project: string, deploymentGroupId: number, machineId: number): Promise<void>;
69 getDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, expand?: TaskAgentInterfaces.DeploymentMachineExpands): Promise<TaskAgentInterfaces.DeploymentMachine>;
70 getDeploymentMachines(project: string, deploymentGroupId: number, tags?: string[], name?: string, expand?: TaskAgentInterfaces.DeploymentMachineExpands): Promise<TaskAgentInterfaces.DeploymentMachine[]>;
71 replaceDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
72 updateDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
73 updateDeploymentMachines(machines: TaskAgentInterfaces.DeploymentMachine[], project: string, deploymentGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachine[]>;
74 createAgentPoolMaintenanceDefinition(definition: TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition, poolId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition>;
75 deleteAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<void>;
76 getAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition>;
77 getAgentPoolMaintenanceDefinitions(poolId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition[]>;
78 updateAgentPoolMaintenanceDefinition(definition: TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition, poolId: number, definitionId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition>;
79 deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<void>;
80 getAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceJob>;
81 getAgentPoolMaintenanceJobLogs(poolId: number, jobId: number): Promise<NodeJS.ReadableStream>;
82 getAgentPoolMaintenanceJobs(poolId: number, definitionId?: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceJob[]>;
83 queueAgentPoolMaintenanceJob(job: TaskAgentInterfaces.TaskAgentPoolMaintenanceJob, poolId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceJob>;
84 updateAgentPoolMaintenanceJob(job: TaskAgentInterfaces.TaskAgentPoolMaintenanceJob, poolId: number, jobId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceJob>;
85 deleteMessage(poolId: number, messageId: number, sessionId: string): Promise<void>;
86 getMessage(poolId: number, sessionId: string, lastMessageId?: number): Promise<TaskAgentInterfaces.TaskAgentMessage>;
87 refreshAgent(poolId: number, agentId: number): Promise<void>;
88 refreshAgents(poolId: number): Promise<void>;
89 sendMessage(message: TaskAgentInterfaces.TaskAgentMessage, poolId: number, requestId: number): Promise<void>;
90 getPackage(packageType: string, platform: string, version: string): Promise<TaskAgentInterfaces.PackageMetadata>;
91 getPackages(packageType: string, platform?: string, top?: number): Promise<TaskAgentInterfaces.PackageMetadata[]>;
92 getAgentPoolMetadata(poolId: number): Promise<NodeJS.ReadableStream>;
93 setAgentPoolMetadata(customHeaders: any, agentPoolMetadata: any, poolId: number): Promise<void>;
94 hasPoolPermissions(poolId: number, permissions: number): Promise<boolean>;
95 addAgentPool(pool: TaskAgentInterfaces.TaskAgentPool): Promise<TaskAgentInterfaces.TaskAgentPool>;
96 deleteAgentPool(poolId: number): Promise<void>;
97 getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise<TaskAgentInterfaces.TaskAgentPool>;
98 getAgentPools(poolName?: string, properties?: string[], poolType?: TaskAgentInterfaces.TaskAgentPoolType, actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise<TaskAgentInterfaces.TaskAgentPool[]>;
99 getAgentPoolsByIds(poolIds: number[], actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise<TaskAgentInterfaces.TaskAgentPool[]>;
100 updateAgentPool(pool: TaskAgentInterfaces.TaskAgentPool, poolId: number): Promise<TaskAgentInterfaces.TaskAgentPool>;
101 addAgentQueue(queue: TaskAgentInterfaces.TaskAgentQueue, project?: string, authorizePipelines?: boolean): Promise<TaskAgentInterfaces.TaskAgentQueue>;
102 createTeamProject(project?: string): Promise<void>;
103 deleteAgentQueue(queueId: number, project?: string): Promise<void>;
104 getAgentQueue(queueId: number, project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise<TaskAgentInterfaces.TaskAgentQueue>;
105 getAgentQueues(project?: string, queueName?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise<TaskAgentInterfaces.TaskAgentQueue[]>;
106 getAgentQueuesByIds(queueIds: number[], project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise<TaskAgentInterfaces.TaskAgentQueue[]>;
107 getAgentQueuesByNames(queueNames: string[], project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise<TaskAgentInterfaces.TaskAgentQueue[]>;
108 getAgentQueuesForPools(poolIds: number[], project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise<TaskAgentInterfaces.TaskAgentQueue[]>;
109 getAgentCloudRequests(agentCloudId: number): Promise<TaskAgentInterfaces.TaskAgentCloudRequest[]>;
110 getResourceLimits(): Promise<TaskAgentInterfaces.ResourceLimit[]>;
111 getResourceUsage(parallelismTag?: string, poolIsHosted?: boolean, includeRunningRequests?: boolean): Promise<TaskAgentInterfaces.ResourceUsage>;
112 getTaskGroupHistory(project: string, taskGroupId: string): Promise<TaskAgentInterfaces.TaskGroupRevision[]>;
113 deleteSecureFile(project: string, secureFileId: string): Promise<void>;
114 downloadSecureFile(project: string, secureFileId: string, ticket: string, download?: boolean): Promise<NodeJS.ReadableStream>;
115 getSecureFile(project: string, secureFileId: string, includeDownloadTicket?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise<TaskAgentInterfaces.SecureFile>;
116 getSecureFiles(project: string, namePattern?: string, includeDownloadTickets?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise<TaskAgentInterfaces.SecureFile[]>;
117 getSecureFilesByIds(project: string, secureFileIds: string[], includeDownloadTickets?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise<TaskAgentInterfaces.SecureFile[]>;
118 getSecureFilesByNames(project: string, secureFileNames: string[], includeDownloadTickets?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise<TaskAgentInterfaces.SecureFile[]>;
119 querySecureFilesByProperties(condition: string, project: string, namePattern?: string): Promise<TaskAgentInterfaces.SecureFile[]>;
120 updateSecureFile(secureFile: TaskAgentInterfaces.SecureFile, project: string, secureFileId: string): Promise<TaskAgentInterfaces.SecureFile>;
121 updateSecureFiles(secureFiles: TaskAgentInterfaces.SecureFile[], project: string): Promise<TaskAgentInterfaces.SecureFile[]>;
122 uploadSecureFile(customHeaders: any, contentStream: NodeJS.ReadableStream, project: string, name: string, authorizePipelines?: boolean): Promise<TaskAgentInterfaces.SecureFile>;
123 createAgentSession(session: TaskAgentInterfaces.TaskAgentSession, poolId: number): Promise<TaskAgentInterfaces.TaskAgentSession>;
124 deleteAgentSession(poolId: number, sessionId: string): Promise<void>;
125 addDeploymentTarget(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
126 deleteDeploymentTarget(project: string, deploymentGroupId: number, targetId: number): Promise<void>;
127 getDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, expand?: TaskAgentInterfaces.DeploymentTargetExpands): Promise<TaskAgentInterfaces.DeploymentMachine>;
128 getDeploymentTargets(project: string, deploymentGroupId: number, tags?: string[], name?: string, partialNameMatch?: boolean, expand?: TaskAgentInterfaces.DeploymentTargetExpands, agentStatus?: TaskAgentInterfaces.TaskAgentStatusFilter, agentJobResult?: TaskAgentInterfaces.TaskAgentJobResultFilter, continuationToken?: string, top?: number, enabled?: boolean, propertyFilters?: string[]): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.DeploymentMachine>>;
129 replaceDeploymentTarget(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
130 updateDeploymentTarget(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
131 updateDeploymentTargets(machines: TaskAgentInterfaces.DeploymentTargetUpdateParameter[], project: string, deploymentGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachine[]>;
132 addTaskGroup(taskGroup: TaskAgentInterfaces.TaskGroupCreateParameter, project: string): Promise<TaskAgentInterfaces.TaskGroup>;
133 deleteTaskGroup(project: string, taskGroupId: string, comment?: string): Promise<void>;
134 getTaskGroup(project: string, taskGroupId: string, versionSpec: string, expand?: TaskAgentInterfaces.TaskGroupExpands): Promise<TaskAgentInterfaces.TaskGroup>;
135 getTaskGroupRevision(project: string, taskGroupId: string, revision: number): Promise<NodeJS.ReadableStream>;
136 getTaskGroups(project: string, taskGroupId?: string, expanded?: boolean, taskIdFilter?: string, deleted?: boolean, top?: number, continuationToken?: Date, queryOrder?: TaskAgentInterfaces.TaskGroupQueryOrder): Promise<TaskAgentInterfaces.TaskGroup[]>;
137 publishTaskGroup(taskGroupMetadata: TaskAgentInterfaces.PublishTaskGroupMetadata, project: string, parentTaskGroupId: string): Promise<TaskAgentInterfaces.TaskGroup[]>;
138 undeleteTaskGroup(taskGroup: TaskAgentInterfaces.TaskGroup, project: string): Promise<TaskAgentInterfaces.TaskGroup[]>;
139 updateTaskGroup(taskGroup: TaskAgentInterfaces.TaskGroupUpdateParameter, project: string, taskGroupId?: string): Promise<TaskAgentInterfaces.TaskGroup>;
140 updateTaskGroupProperties(taskGroupUpdateProperties: TaskAgentInterfaces.TaskGroupUpdatePropertiesBase, project: string, taskGroupId: string, disablePriorVersions?: boolean): Promise<TaskAgentInterfaces.TaskGroup[]>;
141 deleteTaskDefinition(taskId: string): Promise<void>;
142 getTaskContentZip(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<NodeJS.ReadableStream>;
143 getTaskDefinition(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<TaskAgentInterfaces.TaskDefinition>;
144 getTaskDefinitions(taskId?: string, visibility?: string[], scopeLocal?: boolean, allVersions?: boolean): Promise<TaskAgentInterfaces.TaskDefinition[]>;
145 updateAgentUpdateState(poolId: number, agentId: number, currentState: string): Promise<TaskAgentInterfaces.TaskAgent>;
146 updateAgentUserCapabilities(userCapabilities: {
147 [key: string]: string;
148 }, poolId: number, agentId: number): Promise<TaskAgentInterfaces.TaskAgent>;
149 addVariableGroup(variableGroupParameters: TaskAgentInterfaces.VariableGroupParameters): Promise<TaskAgentInterfaces.VariableGroup>;
150 deleteVariableGroup(groupId: number, projectIds: string[]): Promise<void>;
151 shareVariableGroup(variableGroupProjectReferences: TaskAgentInterfaces.VariableGroupProjectReference[], variableGroupId: number): Promise<void>;
152 updateVariableGroup(variableGroupParameters: TaskAgentInterfaces.VariableGroupParameters, groupId: number): Promise<TaskAgentInterfaces.VariableGroup>;
153 getVariableGroup(project: string, groupId: number): Promise<TaskAgentInterfaces.VariableGroup>;
154 getVariableGroups(project: string, groupName?: string, actionFilter?: TaskAgentInterfaces.VariableGroupActionFilter, top?: number, continuationToken?: number, queryOrder?: TaskAgentInterfaces.VariableGroupQueryOrder): Promise<TaskAgentInterfaces.VariableGroup[]>;
155 getVariableGroupsById(project: string, groupIds: number[], loadSecrets?: boolean): Promise<TaskAgentInterfaces.VariableGroup[]>;
156 addVirtualMachineGroup(createParameters: TaskAgentInterfaces.VirtualMachineGroupCreateParameters, project: string, environmentId: number): Promise<TaskAgentInterfaces.VirtualMachineGroup>;
157 deleteVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<void>;
158 getVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<TaskAgentInterfaces.VirtualMachineGroup>;
159 updateVirtualMachineGroup(resource: TaskAgentInterfaces.VirtualMachineGroup, project: string, environmentId: number): Promise<TaskAgentInterfaces.VirtualMachineGroup>;
160 getVirtualMachines(project: string, environmentId: number, resourceId: number, continuationToken?: string, name?: string, partialNameMatch?: boolean, tags?: string[], top?: number): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.VirtualMachine>>;
161 updateVirtualMachines(machines: TaskAgentInterfaces.VirtualMachine[], project: string, environmentId: number, resourceId: number): Promise<TaskAgentInterfaces.VirtualMachine[]>;
162 createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: TaskAgentInterfaces.AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>;
163 getVstsAadTenantId(): Promise<string>;
164 getYamlSchema(validateTaskNames?: boolean): Promise<any>;
165}
166export declare class TaskAgentApiBase extends basem.ClientApiBase implements ITaskAgentApiBase {
167 constructor(baseUrl: string, handlers: VsoBaseInterfaces.IRequestHandler[], options?: VsoBaseInterfaces.IRequestOptions);
168 static readonly RESOURCE_AREA_ID = "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd";
169 /**
170 * @param {TaskAgentInterfaces.TaskAgentCloud} agentCloud
171 */
172 addAgentCloud(agentCloud: TaskAgentInterfaces.TaskAgentCloud): Promise<TaskAgentInterfaces.TaskAgentCloud>;
173 /**
174 * @param {number} agentCloudId
175 */
176 deleteAgentCloud(agentCloudId: number): Promise<TaskAgentInterfaces.TaskAgentCloud>;
177 /**
178 * @param {number} agentCloudId
179 */
180 getAgentCloud(agentCloudId: number): Promise<TaskAgentInterfaces.TaskAgentCloud>;
181 /**
182 */
183 getAgentClouds(): Promise<TaskAgentInterfaces.TaskAgentCloud[]>;
184 /**
185 * @param {TaskAgentInterfaces.TaskAgentCloud} updatedCloud
186 * @param {number} agentCloudId
187 */
188 updateAgentCloud(updatedCloud: TaskAgentInterfaces.TaskAgentCloud, agentCloudId: number): Promise<TaskAgentInterfaces.TaskAgentCloud>;
189 /**
190 * Get agent cloud types.
191 *
192 */
193 getAgentCloudTypes(): Promise<TaskAgentInterfaces.TaskAgentCloudType[]>;
194 /**
195 * @param {string} project - Project ID or project name
196 * @param {number} queueId
197 * @param {number} top
198 * @param {string} continuationToken
199 */
200 getAgentRequestsForQueue(project: string, queueId: number, top: number, continuationToken?: string): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.TaskAgentJobRequest>>;
201 /**
202 * @param {TaskAgentInterfaces.TaskAgentJobRequest} request
203 * @param {string} project - Project ID or project name
204 * @param {number} queueId
205 */
206 queueAgentRequest(request: TaskAgentInterfaces.TaskAgentJobRequest, project: string, queueId: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest>;
207 /**
208 * Adds an agent to a pool. You probably don't want to call this endpoint directly. Instead, [configure an agent](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) using the agent download package.
209 *
210 * @param {TaskAgentInterfaces.TaskAgent} agent - Details about the agent being added
211 * @param {number} poolId - The agent pool in which to add the agent
212 */
213 addAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number): Promise<TaskAgentInterfaces.TaskAgent>;
214 /**
215 * Delete an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove an agent from your organization.
216 *
217 * @param {number} poolId - The pool ID to remove the agent from
218 * @param {number} agentId - The agent ID to remove
219 */
220 deleteAgent(poolId: number, agentId: number): Promise<void>;
221 /**
222 * Get information about an agent.
223 *
224 * @param {number} poolId - The agent pool containing the agent
225 * @param {number} agentId - The agent ID to get information about
226 * @param {boolean} includeCapabilities - Whether to include the agent's capabilities in the response
227 * @param {boolean} includeAssignedRequest - Whether to include details about the agent's current work
228 * @param {boolean} includeLastCompletedRequest - Whether to include details about the agents' most recent completed work
229 * @param {string[]} propertyFilters - Filter which custom properties will be returned
230 */
231 getAgent(poolId: number, agentId: number, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[]): Promise<TaskAgentInterfaces.TaskAgent>;
232 /**
233 * Get a list of agents.
234 *
235 * @param {number} poolId - The agent pool containing the agents
236 * @param {string} agentName - Filter on agent name
237 * @param {boolean} includeCapabilities - Whether to include the agents' capabilities in the response
238 * @param {boolean} includeAssignedRequest - Whether to include details about the agents' current work
239 * @param {boolean} includeLastCompletedRequest - Whether to include details about the agents' most recent completed work
240 * @param {string[]} propertyFilters - Filter which custom properties will be returned
241 * @param {string[]} demands - Filter by demands the agents can satisfy
242 */
243 getAgents(poolId: number, agentName?: string, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[], demands?: string[]): Promise<TaskAgentInterfaces.TaskAgent[]>;
244 /**
245 * Replace an agent. You probably don't want to call this endpoint directly. Instead, [use the agent configuration script](https://docs.microsoft.com/azure/devops/pipelines/agents/agents) to remove and reconfigure an agent from your organization.
246 *
247 * @param {TaskAgentInterfaces.TaskAgent} agent - Updated details about the replacing agent
248 * @param {number} poolId - The agent pool to use
249 * @param {number} agentId - The agent to replace
250 */
251 replaceAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number, agentId: number): Promise<TaskAgentInterfaces.TaskAgent>;
252 /**
253 * Update agent details.
254 *
255 * @param {TaskAgentInterfaces.TaskAgent} agent - Updated details about the agent
256 * @param {number} poolId - The agent pool to use
257 * @param {number} agentId - The agent to update
258 */
259 updateAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number, agentId: number): Promise<TaskAgentInterfaces.TaskAgent>;
260 /**
261 * Returns list of azure subscriptions
262 *
263 */
264 getAzureManagementGroups(): Promise<TaskAgentInterfaces.AzureManagementGroupQueryResult>;
265 /**
266 * Returns list of azure subscriptions
267 *
268 */
269 getAzureSubscriptions(): Promise<TaskAgentInterfaces.AzureSubscriptionQueryResult>;
270 /**
271 * GET a PAT token for managing (configuring, removing, tagging) deployment targets in a deployment group.
272 *
273 * @param {string} project - Project ID or project name
274 * @param {number} deploymentGroupId - ID of the deployment group in which deployment targets are managed.
275 */
276 generateDeploymentGroupAccessToken(project: string, deploymentGroupId: number): Promise<string>;
277 /**
278 * Create a deployment group.
279 *
280 * @param {TaskAgentInterfaces.DeploymentGroupCreateParameter} deploymentGroup - Deployment group to create.
281 * @param {string} project - Project ID or project name
282 */
283 addDeploymentGroup(deploymentGroup: TaskAgentInterfaces.DeploymentGroupCreateParameter, project: string): Promise<TaskAgentInterfaces.DeploymentGroup>;
284 /**
285 * Delete a deployment group.
286 *
287 * @param {string} project - Project ID or project name
288 * @param {number} deploymentGroupId - ID of the deployment group to be deleted.
289 */
290 deleteDeploymentGroup(project: string, deploymentGroupId: number): Promise<void>;
291 /**
292 * Get a deployment group by its ID.
293 *
294 * @param {string} project - Project ID or project name
295 * @param {number} deploymentGroupId - ID of the deployment group.
296 * @param {TaskAgentInterfaces.DeploymentGroupActionFilter} actionFilter - Get the deployment group only if this action can be performed on it.
297 * @param {TaskAgentInterfaces.DeploymentGroupExpands} expand - Include these additional details in the returned object.
298 */
299 getDeploymentGroup(project: string, deploymentGroupId: number, actionFilter?: TaskAgentInterfaces.DeploymentGroupActionFilter, expand?: TaskAgentInterfaces.DeploymentGroupExpands): Promise<TaskAgentInterfaces.DeploymentGroup>;
300 /**
301 * Get a list of deployment groups by name or IDs.
302 *
303 * @param {string} project - Project ID or project name
304 * @param {string} name - Name of the deployment group.
305 * @param {TaskAgentInterfaces.DeploymentGroupActionFilter} actionFilter - Get only deployment groups on which this action can be performed.
306 * @param {TaskAgentInterfaces.DeploymentGroupExpands} expand - Include these additional details in the returned objects.
307 * @param {string} continuationToken - Get deployment groups with names greater than this continuationToken lexicographically.
308 * @param {number} top - Maximum number of deployment groups to return. Default is **1000**.
309 * @param {number[]} ids - Comma separated list of IDs of the deployment groups.
310 */
311 getDeploymentGroups(project: string, name?: string, actionFilter?: TaskAgentInterfaces.DeploymentGroupActionFilter, expand?: TaskAgentInterfaces.DeploymentGroupExpands, continuationToken?: string, top?: number, ids?: number[]): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.DeploymentGroup>>;
312 /**
313 * Update a deployment group.
314 *
315 * @param {TaskAgentInterfaces.DeploymentGroupUpdateParameter} deploymentGroup - Deployment group to update.
316 * @param {string} project - Project ID or project name
317 * @param {number} deploymentGroupId - ID of the deployment group.
318 */
319 updateDeploymentGroup(deploymentGroup: TaskAgentInterfaces.DeploymentGroupUpdateParameter, project: string, deploymentGroupId: number): Promise<TaskAgentInterfaces.DeploymentGroup>;
320 /**
321 * Get a list of deployment group metrics.
322 *
323 * @param {string} project - Project ID or project name
324 * @param {string} deploymentGroupName - Name of the deployment group.
325 * @param {string} continuationToken - Get metrics for deployment groups with names greater than this continuationToken lexicographically.
326 * @param {number} top - Maximum number of deployment group metrics to return. Default is **50**.
327 */
328 getDeploymentGroupsMetrics(project: string, deploymentGroupName?: string, continuationToken?: string, top?: number): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.DeploymentGroupMetrics>>;
329 /**
330 * @param {string} project - Project ID or project name
331 * @param {number} deploymentGroupId
332 * @param {number} machineId
333 * @param {number} completedRequestCount
334 */
335 getAgentRequestsForDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
336 /**
337 * @param {string} project - Project ID or project name
338 * @param {number} deploymentGroupId
339 * @param {number[]} machineIds
340 * @param {number} completedRequestCount
341 */
342 getAgentRequestsForDeploymentMachines(project: string, deploymentGroupId: number, machineIds?: number[], completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
343 /**
344 * @param {string} project - Project ID or project name
345 * @param {number} deploymentGroupId
346 */
347 refreshDeploymentMachines(project: string, deploymentGroupId: number): Promise<void>;
348 /**
349 * GET a PAT token for managing (configuring, removing, tagging) deployment agents in a deployment pool.
350 *
351 * @param {number} poolId - ID of the deployment pool in which deployment agents are managed.
352 */
353 generateDeploymentPoolAccessToken(poolId: number): Promise<string>;
354 /**
355 * Get a list of deployment pool summaries.
356 *
357 * @param {string} poolName - Name of the deployment pool.
358 * @param {TaskAgentInterfaces.DeploymentPoolSummaryExpands} expands - Include these additional details in the returned objects.
359 * @param {number[]} poolIds - List of deployment pool ids.
360 */
361 getDeploymentPoolsSummary(poolName?: string, expands?: TaskAgentInterfaces.DeploymentPoolSummaryExpands, poolIds?: number[]): Promise<TaskAgentInterfaces.DeploymentPoolSummary[]>;
362 /**
363 * Get agent requests for a deployment target.
364 *
365 * @param {string} project - Project ID or project name
366 * @param {number} deploymentGroupId - ID of the deployment group to which the target belongs.
367 * @param {number} targetId - ID of the deployment target.
368 * @param {number} completedRequestCount - Maximum number of completed requests to return. Default is **50**
369 */
370 getAgentRequestsForDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
371 /**
372 * Get agent requests for a list deployment targets.
373 *
374 * @param {string} project - Project ID or project name
375 * @param {number} deploymentGroupId - ID of the deployment group to which the targets belong.
376 * @param {number[]} targetIds - Comma separated list of IDs of the deployment targets.
377 * @param {number} ownerId - Id of owner of agent job request.
378 * @param {Date} completedOn - Datetime to return request after this time.
379 * @param {number} completedRequestCount - Maximum number of completed requests to return for each target. Default is **50**
380 */
381 getAgentRequestsForDeploymentTargets(project: string, deploymentGroupId: number, targetIds?: number[], ownerId?: number, completedOn?: Date, completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
382 /**
383 * Upgrade the deployment targets in a deployment group.
384 *
385 * @param {string} project - Project ID or project name
386 * @param {number} deploymentGroupId - ID of the deployment group.
387 */
388 refreshDeploymentTargets(project: string, deploymentGroupId: number): Promise<void>;
389 /**
390 * Proxy for a GET request defined by an 'endpoint'. The request is authorized using a service connection. The response is filtered using an XPath/Json based selector.
391 *
392 * @param {TaskAgentInterfaces.TaskDefinitionEndpoint} endpoint - Describes the URL to fetch.
393 */
394 queryEndpoint(endpoint: TaskAgentInterfaces.TaskDefinitionEndpoint): Promise<string[]>;
395 /**
396 * Get environment deployment execution history
397 *
398 * @param {string} project - Project ID or project name
399 * @param {number} environmentId
400 * @param {string} continuationToken
401 * @param {number} top
402 */
403 getEnvironmentDeploymentExecutionRecords(project: string, environmentId: number, continuationToken?: string, top?: number): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.EnvironmentDeploymentExecutionRecord>>;
404 /**
405 * Create an environment.
406 *
407 * @param {TaskAgentInterfaces.EnvironmentCreateParameter} environmentCreateParameter - Environment to create.
408 * @param {string} project - Project ID or project name
409 */
410 addEnvironment(environmentCreateParameter: TaskAgentInterfaces.EnvironmentCreateParameter, project: string): Promise<TaskAgentInterfaces.EnvironmentInstance>;
411 /**
412 * Delete the specified environment.
413 *
414 * @param {string} project - Project ID or project name
415 * @param {number} environmentId - ID of the environment.
416 */
417 deleteEnvironment(project: string, environmentId: number): Promise<void>;
418 /**
419 * Get an environment by its ID.
420 *
421 * @param {string} project - Project ID or project name
422 * @param {number} environmentId - ID of the environment.
423 * @param {TaskAgentInterfaces.EnvironmentExpands} expands - Include these additional details in the returned objects.
424 */
425 getEnvironmentById(project: string, environmentId: number, expands?: TaskAgentInterfaces.EnvironmentExpands): Promise<TaskAgentInterfaces.EnvironmentInstance>;
426 /**
427 * Get all environments.
428 *
429 * @param {string} project - Project ID or project name
430 * @param {string} name
431 * @param {string} continuationToken
432 * @param {number} top
433 */
434 getEnvironments(project: string, name?: string, continuationToken?: string, top?: number): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.EnvironmentInstance>>;
435 /**
436 * Update the specified environment.
437 *
438 * @param {TaskAgentInterfaces.EnvironmentUpdateParameter} environmentUpdateParameter - Environment data to update.
439 * @param {string} project - Project ID or project name
440 * @param {number} environmentId - ID of the environment.
441 */
442 updateEnvironment(environmentUpdateParameter: TaskAgentInterfaces.EnvironmentUpdateParameter, project: string, environmentId: number): Promise<TaskAgentInterfaces.EnvironmentInstance>;
443 /**
444 * @param {string} hubName
445 * @param {boolean} includeEnterpriseUsersCount
446 * @param {boolean} includeHostedAgentMinutesCount
447 */
448 getTaskHubLicenseDetails(hubName: string, includeEnterpriseUsersCount?: boolean, includeHostedAgentMinutesCount?: boolean): Promise<TaskAgentInterfaces.TaskHubLicenseDetails>;
449 /**
450 * @param {TaskAgentInterfaces.TaskHubLicenseDetails} taskHubLicenseDetails
451 * @param {string} hubName
452 */
453 updateTaskHubLicenseDetails(taskHubLicenseDetails: TaskAgentInterfaces.TaskHubLicenseDetails, hubName: string): Promise<TaskAgentInterfaces.TaskHubLicenseDetails>;
454 /**
455 * @param {TaskAgentInterfaces.InputValidationRequest} inputValidationRequest
456 */
457 validateInputs(inputValidationRequest: TaskAgentInterfaces.InputValidationRequest): Promise<TaskAgentInterfaces.InputValidationRequest>;
458 /**
459 * @param {number} poolId
460 * @param {number} requestId
461 * @param {string} lockToken
462 * @param {TaskAgentInterfaces.TaskResult} result
463 * @param {boolean} agentShuttingDown
464 */
465 deleteAgentRequest(poolId: number, requestId: number, lockToken: string, result?: TaskAgentInterfaces.TaskResult, agentShuttingDown?: boolean): Promise<void>;
466 /**
467 * @param {number} poolId
468 * @param {number} requestId
469 * @param {boolean} includeStatus
470 */
471 getAgentRequest(poolId: number, requestId: number, includeStatus?: boolean): Promise<TaskAgentInterfaces.TaskAgentJobRequest>;
472 /**
473 * @param {number} poolId
474 * @param {number} top
475 * @param {string} continuationToken
476 */
477 getAgentRequests(poolId: number, top: number, continuationToken?: string): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.TaskAgentJobRequest>>;
478 /**
479 * @param {number} poolId
480 * @param {number} agentId
481 * @param {number} completedRequestCount
482 */
483 getAgentRequestsForAgent(poolId: number, agentId: number, completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
484 /**
485 * @param {number} poolId
486 * @param {number[]} agentIds
487 * @param {number} completedRequestCount
488 */
489 getAgentRequestsForAgents(poolId: number, agentIds?: number[], completedRequestCount?: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
490 /**
491 * @param {number} poolId
492 * @param {string} planId
493 * @param {string} jobId
494 */
495 getAgentRequestsForPlan(poolId: number, planId: string, jobId?: string): Promise<TaskAgentInterfaces.TaskAgentJobRequest[]>;
496 /**
497 * @param {TaskAgentInterfaces.TaskAgentJobRequest} request
498 * @param {number} poolId
499 */
500 queueAgentRequestByPool(request: TaskAgentInterfaces.TaskAgentJobRequest, poolId: number): Promise<TaskAgentInterfaces.TaskAgentJobRequest>;
501 /**
502 * @param {TaskAgentInterfaces.TaskAgentJobRequest} request
503 * @param {number} poolId
504 * @param {number} requestId
505 * @param {string} lockToken
506 * @param {TaskAgentInterfaces.TaskAgentRequestUpdateOptions} updateOptions
507 */
508 updateAgentRequest(request: TaskAgentInterfaces.TaskAgentJobRequest, poolId: number, requestId: number, lockToken: string, updateOptions?: TaskAgentInterfaces.TaskAgentRequestUpdateOptions): Promise<TaskAgentInterfaces.TaskAgentJobRequest>;
509 /**
510 * @param {TaskAgentInterfaces.KubernetesResourceCreateParameters} createParameters
511 * @param {string} project - Project ID or project name
512 * @param {number} environmentId
513 */
514 addKubernetesResource(createParameters: TaskAgentInterfaces.KubernetesResourceCreateParameters, project: string, environmentId: number): Promise<TaskAgentInterfaces.KubernetesResource>;
515 /**
516 * @param {string} project - Project ID or project name
517 * @param {number} environmentId
518 * @param {number} resourceId
519 */
520 deleteKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<void>;
521 /**
522 * @param {string} project - Project ID or project name
523 * @param {number} environmentId
524 * @param {number} resourceId
525 */
526 getKubernetesResource(project: string, environmentId: number, resourceId: number): Promise<TaskAgentInterfaces.KubernetesResource>;
527 /**
528 * @param {string} project - Project ID or project name
529 * @param {number} machineGroupId
530 */
531 generateDeploymentMachineGroupAccessToken(project: string, machineGroupId: number): Promise<string>;
532 /**
533 * @param {TaskAgentInterfaces.DeploymentMachineGroup} machineGroup
534 * @param {string} project - Project ID or project name
535 */
536 addDeploymentMachineGroup(machineGroup: TaskAgentInterfaces.DeploymentMachineGroup, project: string): Promise<TaskAgentInterfaces.DeploymentMachineGroup>;
537 /**
538 * @param {string} project - Project ID or project name
539 * @param {number} machineGroupId
540 */
541 deleteDeploymentMachineGroup(project: string, machineGroupId: number): Promise<void>;
542 /**
543 * @param {string} project - Project ID or project name
544 * @param {number} machineGroupId
545 * @param {TaskAgentInterfaces.MachineGroupActionFilter} actionFilter
546 */
547 getDeploymentMachineGroup(project: string, machineGroupId: number, actionFilter?: TaskAgentInterfaces.MachineGroupActionFilter): Promise<TaskAgentInterfaces.DeploymentMachineGroup>;
548 /**
549 * @param {string} project - Project ID or project name
550 * @param {string} machineGroupName
551 * @param {TaskAgentInterfaces.MachineGroupActionFilter} actionFilter
552 */
553 getDeploymentMachineGroups(project: string, machineGroupName?: string, actionFilter?: TaskAgentInterfaces.MachineGroupActionFilter): Promise<TaskAgentInterfaces.DeploymentMachineGroup[]>;
554 /**
555 * @param {TaskAgentInterfaces.DeploymentMachineGroup} machineGroup
556 * @param {string} project - Project ID or project name
557 * @param {number} machineGroupId
558 */
559 updateDeploymentMachineGroup(machineGroup: TaskAgentInterfaces.DeploymentMachineGroup, project: string, machineGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachineGroup>;
560 /**
561 * @param {string} project - Project ID or project name
562 * @param {number} machineGroupId
563 * @param {string[]} tagFilters
564 */
565 getDeploymentMachineGroupMachines(project: string, machineGroupId: number, tagFilters?: string[]): Promise<TaskAgentInterfaces.DeploymentMachine[]>;
566 /**
567 * @param {TaskAgentInterfaces.DeploymentMachine[]} deploymentMachines
568 * @param {string} project - Project ID or project name
569 * @param {number} machineGroupId
570 */
571 updateDeploymentMachineGroupMachines(deploymentMachines: TaskAgentInterfaces.DeploymentMachine[], project: string, machineGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachine[]>;
572 /**
573 * @param {TaskAgentInterfaces.DeploymentMachine} machine
574 * @param {string} project - Project ID or project name
575 * @param {number} deploymentGroupId
576 */
577 addDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
578 /**
579 * @param {string} project - Project ID or project name
580 * @param {number} deploymentGroupId
581 * @param {number} machineId
582 */
583 deleteDeploymentMachine(project: string, deploymentGroupId: number, machineId: number): Promise<void>;
584 /**
585 * @param {string} project - Project ID or project name
586 * @param {number} deploymentGroupId
587 * @param {number} machineId
588 * @param {TaskAgentInterfaces.DeploymentMachineExpands} expand
589 */
590 getDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, expand?: TaskAgentInterfaces.DeploymentMachineExpands): Promise<TaskAgentInterfaces.DeploymentMachine>;
591 /**
592 * @param {string} project - Project ID or project name
593 * @param {number} deploymentGroupId
594 * @param {string[]} tags
595 * @param {string} name
596 * @param {TaskAgentInterfaces.DeploymentMachineExpands} expand
597 */
598 getDeploymentMachines(project: string, deploymentGroupId: number, tags?: string[], name?: string, expand?: TaskAgentInterfaces.DeploymentMachineExpands): Promise<TaskAgentInterfaces.DeploymentMachine[]>;
599 /**
600 * @param {TaskAgentInterfaces.DeploymentMachine} machine
601 * @param {string} project - Project ID or project name
602 * @param {number} deploymentGroupId
603 * @param {number} machineId
604 */
605 replaceDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
606 /**
607 * @param {TaskAgentInterfaces.DeploymentMachine} machine
608 * @param {string} project - Project ID or project name
609 * @param {number} deploymentGroupId
610 * @param {number} machineId
611 */
612 updateDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
613 /**
614 * @param {TaskAgentInterfaces.DeploymentMachine[]} machines
615 * @param {string} project - Project ID or project name
616 * @param {number} deploymentGroupId
617 */
618 updateDeploymentMachines(machines: TaskAgentInterfaces.DeploymentMachine[], project: string, deploymentGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachine[]>;
619 /**
620 * @param {TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition} definition
621 * @param {number} poolId
622 */
623 createAgentPoolMaintenanceDefinition(definition: TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition, poolId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition>;
624 /**
625 * @param {number} poolId
626 * @param {number} definitionId
627 */
628 deleteAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<void>;
629 /**
630 * @param {number} poolId
631 * @param {number} definitionId
632 */
633 getAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition>;
634 /**
635 * @param {number} poolId
636 */
637 getAgentPoolMaintenanceDefinitions(poolId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition[]>;
638 /**
639 * @param {TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition} definition
640 * @param {number} poolId
641 * @param {number} definitionId
642 */
643 updateAgentPoolMaintenanceDefinition(definition: TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition, poolId: number, definitionId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition>;
644 /**
645 * @param {number} poolId
646 * @param {number} jobId
647 */
648 deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<void>;
649 /**
650 * @param {number} poolId
651 * @param {number} jobId
652 */
653 getAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceJob>;
654 /**
655 * @param {number} poolId
656 * @param {number} jobId
657 */
658 getAgentPoolMaintenanceJobLogs(poolId: number, jobId: number): Promise<NodeJS.ReadableStream>;
659 /**
660 * @param {number} poolId
661 * @param {number} definitionId
662 */
663 getAgentPoolMaintenanceJobs(poolId: number, definitionId?: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceJob[]>;
664 /**
665 * @param {TaskAgentInterfaces.TaskAgentPoolMaintenanceJob} job
666 * @param {number} poolId
667 */
668 queueAgentPoolMaintenanceJob(job: TaskAgentInterfaces.TaskAgentPoolMaintenanceJob, poolId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceJob>;
669 /**
670 * @param {TaskAgentInterfaces.TaskAgentPoolMaintenanceJob} job
671 * @param {number} poolId
672 * @param {number} jobId
673 */
674 updateAgentPoolMaintenanceJob(job: TaskAgentInterfaces.TaskAgentPoolMaintenanceJob, poolId: number, jobId: number): Promise<TaskAgentInterfaces.TaskAgentPoolMaintenanceJob>;
675 /**
676 * @param {number} poolId
677 * @param {number} messageId
678 * @param {string} sessionId
679 */
680 deleteMessage(poolId: number, messageId: number, sessionId: string): Promise<void>;
681 /**
682 * @param {number} poolId
683 * @param {string} sessionId
684 * @param {number} lastMessageId
685 */
686 getMessage(poolId: number, sessionId: string, lastMessageId?: number): Promise<TaskAgentInterfaces.TaskAgentMessage>;
687 /**
688 * @param {number} poolId
689 * @param {number} agentId
690 */
691 refreshAgent(poolId: number, agentId: number): Promise<void>;
692 /**
693 * @param {number} poolId
694 */
695 refreshAgents(poolId: number): Promise<void>;
696 /**
697 * @param {TaskAgentInterfaces.TaskAgentMessage} message
698 * @param {number} poolId
699 * @param {number} requestId
700 */
701 sendMessage(message: TaskAgentInterfaces.TaskAgentMessage, poolId: number, requestId: number): Promise<void>;
702 /**
703 * @param {string} packageType
704 * @param {string} platform
705 * @param {string} version
706 */
707 getPackage(packageType: string, platform: string, version: string): Promise<TaskAgentInterfaces.PackageMetadata>;
708 /**
709 * @param {string} packageType
710 * @param {string} platform
711 * @param {number} top
712 */
713 getPackages(packageType: string, platform?: string, top?: number): Promise<TaskAgentInterfaces.PackageMetadata[]>;
714 /**
715 * @param {number} poolId
716 */
717 getAgentPoolMetadata(poolId: number): Promise<NodeJS.ReadableStream>;
718 /**
719 * @param {any} agentPoolMetadata
720 * @param {number} poolId
721 */
722 setAgentPoolMetadata(customHeaders: any, agentPoolMetadata: any, poolId: number): Promise<void>;
723 /**
724 * Checks if current identity has passed permissions on a pool.
725 *
726 * @param {number} poolId - Id of the pool to check
727 * @param {number} permissions - Permissions to check. Multiple permissions might be merged into single value using bitwise OR operator (e.g. AgentPoolPermissions.Manage | AgentPoolPermissions.View)
728 */
729 hasPoolPermissions(poolId: number, permissions: number): Promise<boolean>;
730 /**
731 * Create an agent pool.
732 *
733 * @param {TaskAgentInterfaces.TaskAgentPool} pool - Details about the new agent pool
734 */
735 addAgentPool(pool: TaskAgentInterfaces.TaskAgentPool): Promise<TaskAgentInterfaces.TaskAgentPool>;
736 /**
737 * Delete an agent pool.
738 *
739 * @param {number} poolId - ID of the agent pool to delete
740 */
741 deleteAgentPool(poolId: number): Promise<void>;
742 /**
743 * Get information about an agent pool.
744 *
745 * @param {number} poolId - An agent pool ID
746 * @param {string[]} properties - Agent pool properties (comma-separated)
747 * @param {TaskAgentInterfaces.TaskAgentPoolActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
748 */
749 getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise<TaskAgentInterfaces.TaskAgentPool>;
750 /**
751 * Get a list of agent pools.
752 *
753 * @param {string} poolName - Filter by name
754 * @param {string[]} properties - Filter by agent pool properties (comma-separated)
755 * @param {TaskAgentInterfaces.TaskAgentPoolType} poolType - Filter by pool type
756 * @param {TaskAgentInterfaces.TaskAgentPoolActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
757 */
758 getAgentPools(poolName?: string, properties?: string[], poolType?: TaskAgentInterfaces.TaskAgentPoolType, actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise<TaskAgentInterfaces.TaskAgentPool[]>;
759 /**
760 * Get a list of agent pools.
761 *
762 * @param {number[]} poolIds - pool Ids to fetch
763 * @param {TaskAgentInterfaces.TaskAgentPoolActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
764 */
765 getAgentPoolsByIds(poolIds: number[], actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise<TaskAgentInterfaces.TaskAgentPool[]>;
766 /**
767 * Update properties on an agent pool
768 *
769 * @param {TaskAgentInterfaces.TaskAgentPool} pool - Updated agent pool details
770 * @param {number} poolId - The agent pool to update
771 */
772 updateAgentPool(pool: TaskAgentInterfaces.TaskAgentPool, poolId: number): Promise<TaskAgentInterfaces.TaskAgentPool>;
773 /**
774 * Create a new agent queue to connect a project to an agent pool.
775 *
776 * @param {TaskAgentInterfaces.TaskAgentQueue} queue - Details about the queue to create
777 * @param {string} project - Project ID or project name
778 * @param {boolean} authorizePipelines - Automatically authorize this queue when using YAML
779 */
780 addAgentQueue(queue: TaskAgentInterfaces.TaskAgentQueue, project?: string, authorizePipelines?: boolean): Promise<TaskAgentInterfaces.TaskAgentQueue>;
781 /**
782 * Create a new team project.
783 *
784 * @param {string} project - Project ID or project name
785 */
786 createTeamProject(project?: string): Promise<void>;
787 /**
788 * Removes an agent queue from a project.
789 *
790 * @param {number} queueId - The agent queue to remove
791 * @param {string} project - Project ID or project name
792 */
793 deleteAgentQueue(queueId: number, project?: string): Promise<void>;
794 /**
795 * Get information about an agent queue.
796 *
797 * @param {number} queueId - The agent queue to get information about
798 * @param {string} project - Project ID or project name
799 * @param {TaskAgentInterfaces.TaskAgentQueueActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
800 */
801 getAgentQueue(queueId: number, project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise<TaskAgentInterfaces.TaskAgentQueue>;
802 /**
803 * Get a list of agent queues.
804 *
805 * @param {string} project - Project ID or project name
806 * @param {string} queueName - Filter on the agent queue name
807 * @param {TaskAgentInterfaces.TaskAgentQueueActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
808 */
809 getAgentQueues(project?: string, queueName?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise<TaskAgentInterfaces.TaskAgentQueue[]>;
810 /**
811 * Get a list of agent queues by their IDs
812 *
813 * @param {number[]} queueIds - A comma-separated list of agent queue IDs to retrieve
814 * @param {string} project - Project ID or project name
815 * @param {TaskAgentInterfaces.TaskAgentQueueActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
816 */
817 getAgentQueuesByIds(queueIds: number[], project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise<TaskAgentInterfaces.TaskAgentQueue[]>;
818 /**
819 * Get a list of agent queues by their names
820 *
821 * @param {string[]} queueNames - A comma-separated list of agent names to retrieve
822 * @param {string} project - Project ID or project name
823 * @param {TaskAgentInterfaces.TaskAgentQueueActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
824 */
825 getAgentQueuesByNames(queueNames: string[], project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise<TaskAgentInterfaces.TaskAgentQueue[]>;
826 /**
827 * Get a list of agent queues by pool ids
828 *
829 * @param {number[]} poolIds - A comma-separated list of pool ids to get the corresponding queues for
830 * @param {string} project - Project ID or project name
831 * @param {TaskAgentInterfaces.TaskAgentQueueActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
832 */
833 getAgentQueuesForPools(poolIds: number[], project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise<TaskAgentInterfaces.TaskAgentQueue[]>;
834 /**
835 * @param {number} agentCloudId
836 */
837 getAgentCloudRequests(agentCloudId: number): Promise<TaskAgentInterfaces.TaskAgentCloudRequest[]>;
838 /**
839 */
840 getResourceLimits(): Promise<TaskAgentInterfaces.ResourceLimit[]>;
841 /**
842 * @param {string} parallelismTag
843 * @param {boolean} poolIsHosted
844 * @param {boolean} includeRunningRequests
845 */
846 getResourceUsage(parallelismTag?: string, poolIsHosted?: boolean, includeRunningRequests?: boolean): Promise<TaskAgentInterfaces.ResourceUsage>;
847 /**
848 * @param {string} project - Project ID or project name
849 * @param {string} taskGroupId
850 */
851 getTaskGroupHistory(project: string, taskGroupId: string): Promise<TaskAgentInterfaces.TaskGroupRevision[]>;
852 /**
853 * Delete a secure file
854 *
855 * @param {string} project - Project ID or project name
856 * @param {string} secureFileId - The unique secure file Id
857 */
858 deleteSecureFile(project: string, secureFileId: string): Promise<void>;
859 /**
860 * Download a secure file by Id
861 *
862 * @param {string} project - Project ID or project name
863 * @param {string} secureFileId - The unique secure file Id
864 * @param {string} ticket - A valid download ticket
865 * @param {boolean} download - If download is true, the file is sent as attachement in the response body. If download is false, the response body contains the file stream.
866 */
867 downloadSecureFile(project: string, secureFileId: string, ticket: string, download?: boolean): Promise<NodeJS.ReadableStream>;
868 /**
869 * Get a secure file
870 *
871 * @param {string} project - Project ID or project name
872 * @param {string} secureFileId - The unique secure file Id
873 * @param {boolean} includeDownloadTicket - If includeDownloadTicket is true and the caller has permissions, a download ticket is included in the response.
874 * @param {TaskAgentInterfaces.SecureFileActionFilter} actionFilter
875 */
876 getSecureFile(project: string, secureFileId: string, includeDownloadTicket?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise<TaskAgentInterfaces.SecureFile>;
877 /**
878 * Get secure files
879 *
880 * @param {string} project - Project ID or project name
881 * @param {string} namePattern - Name of the secure file to match. Can include wildcards to match multiple files.
882 * @param {boolean} includeDownloadTickets - If includeDownloadTickets is true and the caller has permissions, a download ticket for each secure file is included in the response.
883 * @param {TaskAgentInterfaces.SecureFileActionFilter} actionFilter - Filter by secure file permissions for View, Manage or Use action. Defaults to View.
884 */
885 getSecureFiles(project: string, namePattern?: string, includeDownloadTickets?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise<TaskAgentInterfaces.SecureFile[]>;
886 /**
887 * Get secure files
888 *
889 * @param {string} project - Project ID or project name
890 * @param {string[]} secureFileIds - A list of secure file Ids
891 * @param {boolean} includeDownloadTickets - If includeDownloadTickets is true and the caller has permissions, a download ticket for each secure file is included in the response.
892 * @param {TaskAgentInterfaces.SecureFileActionFilter} actionFilter
893 */
894 getSecureFilesByIds(project: string, secureFileIds: string[], includeDownloadTickets?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise<TaskAgentInterfaces.SecureFile[]>;
895 /**
896 * Get secure files
897 *
898 * @param {string} project - Project ID or project name
899 * @param {string[]} secureFileNames - A list of secure file Ids
900 * @param {boolean} includeDownloadTickets - If includeDownloadTickets is true and the caller has permissions, a download ticket for each secure file is included in the response.
901 * @param {TaskAgentInterfaces.SecureFileActionFilter} actionFilter
902 */
903 getSecureFilesByNames(project: string, secureFileNames: string[], includeDownloadTickets?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise<TaskAgentInterfaces.SecureFile[]>;
904 /**
905 * Query secure files using a name pattern and a condition on file properties.
906 *
907 * @param {string} condition - The main condition syntax is described [here](https://go.microsoft.com/fwlink/?linkid=842996). Use the *property('property-name')* function to access the value of the specified property of a secure file. It returns null if the property is not set. E.g. ``` and( eq( property('devices'), '2' ), in( property('provisioning profile type'), 'ad hoc', 'development' ) ) ```
908 * @param {string} project - Project ID or project name
909 * @param {string} namePattern - Name of the secure file to match. Can include wildcards to match multiple files.
910 */
911 querySecureFilesByProperties(condition: string, project: string, namePattern?: string): Promise<TaskAgentInterfaces.SecureFile[]>;
912 /**
913 * Update the name or properties of an existing secure file
914 *
915 * @param {TaskAgentInterfaces.SecureFile} secureFile - The secure file with updated name and/or properties
916 * @param {string} project - Project ID or project name
917 * @param {string} secureFileId - The unique secure file Id
918 */
919 updateSecureFile(secureFile: TaskAgentInterfaces.SecureFile, project: string, secureFileId: string): Promise<TaskAgentInterfaces.SecureFile>;
920 /**
921 * Update properties and/or names of a set of secure files. Files are identified by their IDs. Properties provided override the existing one entirely, i.e. do not merge.
922 *
923 * @param {TaskAgentInterfaces.SecureFile[]} secureFiles - A list of secure file objects. Only three field must be populated Id, Name, and Properties. The rest of fields in the object are ignored.
924 * @param {string} project - Project ID or project name
925 */
926 updateSecureFiles(secureFiles: TaskAgentInterfaces.SecureFile[], project: string): Promise<TaskAgentInterfaces.SecureFile[]>;
927 /**
928 * Upload a secure file, include the file stream in the request body
929 *
930 * @param {NodeJS.ReadableStream} contentStream - Content to upload
931 * @param {string} project - Project ID or project name
932 * @param {string} name - Name of the file to upload
933 * @param {boolean} authorizePipelines - If authorizePipelines is true, then the secure file is authorized for use by all pipelines in the project.
934 */
935 uploadSecureFile(customHeaders: any, contentStream: NodeJS.ReadableStream, project: string, name: string, authorizePipelines?: boolean): Promise<TaskAgentInterfaces.SecureFile>;
936 /**
937 * @param {TaskAgentInterfaces.TaskAgentSession} session
938 * @param {number} poolId
939 */
940 createAgentSession(session: TaskAgentInterfaces.TaskAgentSession, poolId: number): Promise<TaskAgentInterfaces.TaskAgentSession>;
941 /**
942 * @param {number} poolId
943 * @param {string} sessionId
944 */
945 deleteAgentSession(poolId: number, sessionId: string): Promise<void>;
946 /**
947 * Register a deployment target to a deployment group. Generally this is called by agent configuration tool.
948 *
949 * @param {TaskAgentInterfaces.DeploymentMachine} machine - Deployment target to register.
950 * @param {string} project - Project ID or project name
951 * @param {number} deploymentGroupId - ID of the deployment group to which the deployment target is registered.
952 */
953 addDeploymentTarget(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
954 /**
955 * Delete a deployment target in a deployment group. This deletes the agent from associated deployment pool too.
956 *
957 * @param {string} project - Project ID or project name
958 * @param {number} deploymentGroupId - ID of the deployment group in which deployment target is deleted.
959 * @param {number} targetId - ID of the deployment target to delete.
960 */
961 deleteDeploymentTarget(project: string, deploymentGroupId: number, targetId: number): Promise<void>;
962 /**
963 * Get a deployment target by its ID in a deployment group
964 *
965 * @param {string} project - Project ID or project name
966 * @param {number} deploymentGroupId - ID of the deployment group to which deployment target belongs.
967 * @param {number} targetId - ID of the deployment target to return.
968 * @param {TaskAgentInterfaces.DeploymentTargetExpands} expand - Include these additional details in the returned objects.
969 */
970 getDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, expand?: TaskAgentInterfaces.DeploymentTargetExpands): Promise<TaskAgentInterfaces.DeploymentMachine>;
971 /**
972 * Get a list of deployment targets in a deployment group.
973 *
974 * @param {string} project - Project ID or project name
975 * @param {number} deploymentGroupId - ID of the deployment group.
976 * @param {string[]} tags - Get only the deployment targets that contain all these comma separted list of tags.
977 * @param {string} name - Name pattern of the deployment targets to return.
978 * @param {boolean} partialNameMatch - When set to true, treats **name** as pattern. Else treats it as absolute match. Default is **false**.
979 * @param {TaskAgentInterfaces.DeploymentTargetExpands} expand - Include these additional details in the returned objects.
980 * @param {TaskAgentInterfaces.TaskAgentStatusFilter} agentStatus - Get only deployment targets that have this status.
981 * @param {TaskAgentInterfaces.TaskAgentJobResultFilter} agentJobResult - Get only deployment targets that have this last job result.
982 * @param {string} continuationToken - Get deployment targets with names greater than this continuationToken lexicographically.
983 * @param {number} top - Maximum number of deployment targets to return. Default is **1000**.
984 * @param {boolean} enabled - Get only deployment targets that are enabled or disabled. Default is 'null' which returns all the targets.
985 * @param {string[]} propertyFilters
986 */
987 getDeploymentTargets(project: string, deploymentGroupId: number, tags?: string[], name?: string, partialNameMatch?: boolean, expand?: TaskAgentInterfaces.DeploymentTargetExpands, agentStatus?: TaskAgentInterfaces.TaskAgentStatusFilter, agentJobResult?: TaskAgentInterfaces.TaskAgentJobResultFilter, continuationToken?: string, top?: number, enabled?: boolean, propertyFilters?: string[]): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.DeploymentMachine>>;
988 /**
989 * Replace a deployment target in a deployment group. Generally this is called by agent configuration tool.
990 *
991 * @param {TaskAgentInterfaces.DeploymentMachine} machine - New deployment target.
992 * @param {string} project - Project ID or project name
993 * @param {number} deploymentGroupId - ID of the deployment group in which deployment target is replaced.
994 * @param {number} targetId - ID of the deployment target to replace.
995 */
996 replaceDeploymentTarget(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
997 /**
998 * Update a deployment target and its agent properties in a deployment group. Generally this is called by agent configuration tool.
999 *
1000 * @param {TaskAgentInterfaces.DeploymentMachine} machine - Deployment target to update.
1001 * @param {string} project - Project ID or project name
1002 * @param {number} deploymentGroupId - ID of the deployment group in which deployment target is updated.
1003 * @param {number} targetId - ID of the deployment target to update.
1004 */
1005 updateDeploymentTarget(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise<TaskAgentInterfaces.DeploymentMachine>;
1006 /**
1007 * Update tags of a list of deployment targets in a deployment group.
1008 *
1009 * @param {TaskAgentInterfaces.DeploymentTargetUpdateParameter[]} machines - Deployment targets with tags to udpdate.
1010 * @param {string} project - Project ID or project name
1011 * @param {number} deploymentGroupId - ID of the deployment group in which deployment targets are updated.
1012 */
1013 updateDeploymentTargets(machines: TaskAgentInterfaces.DeploymentTargetUpdateParameter[], project: string, deploymentGroupId: number): Promise<TaskAgentInterfaces.DeploymentMachine[]>;
1014 /**
1015 * Create a task group.
1016 *
1017 * @param {TaskAgentInterfaces.TaskGroupCreateParameter} taskGroup - Task group object to create.
1018 * @param {string} project - Project ID or project name
1019 */
1020 addTaskGroup(taskGroup: TaskAgentInterfaces.TaskGroupCreateParameter, project: string): Promise<TaskAgentInterfaces.TaskGroup>;
1021 /**
1022 * Delete a task group.
1023 *
1024 * @param {string} project - Project ID or project name
1025 * @param {string} taskGroupId - Id of the task group to be deleted.
1026 * @param {string} comment - Comments to delete.
1027 */
1028 deleteTaskGroup(project: string, taskGroupId: string, comment?: string): Promise<void>;
1029 /**
1030 * Get task group.
1031 *
1032 * @param {string} project - Project ID or project name
1033 * @param {string} taskGroupId - Id of the task group.
1034 * @param {string} versionSpec - version specification of the task group. examples: 1, 1.0.
1035 * @param {TaskAgentInterfaces.TaskGroupExpands} expand - The properties that should be expanded. example $expand=Tasks will expand nested task groups.
1036 */
1037 getTaskGroup(project: string, taskGroupId: string, versionSpec: string, expand?: TaskAgentInterfaces.TaskGroupExpands): Promise<TaskAgentInterfaces.TaskGroup>;
1038 /**
1039 * @param {string} project - Project ID or project name
1040 * @param {string} taskGroupId
1041 * @param {number} revision
1042 */
1043 getTaskGroupRevision(project: string, taskGroupId: string, revision: number): Promise<NodeJS.ReadableStream>;
1044 /**
1045 * List task groups.
1046 *
1047 * @param {string} project - Project ID or project name
1048 * @param {string} taskGroupId - Id of the task group.
1049 * @param {boolean} expanded - 'true' to recursively expand task groups. Default is 'false'.
1050 * @param {string} taskIdFilter - Guid of the taskId to filter.
1051 * @param {boolean} deleted - 'true'to include deleted task groups. Default is 'false'.
1052 * @param {number} top - Number of task groups to get.
1053 * @param {Date} continuationToken - Gets the task groups after the continuation token provided.
1054 * @param {TaskAgentInterfaces.TaskGroupQueryOrder} queryOrder - Gets the results in the defined order. Default is 'CreatedOnDescending'.
1055 */
1056 getTaskGroups(project: string, taskGroupId?: string, expanded?: boolean, taskIdFilter?: string, deleted?: boolean, top?: number, continuationToken?: Date, queryOrder?: TaskAgentInterfaces.TaskGroupQueryOrder): Promise<TaskAgentInterfaces.TaskGroup[]>;
1057 /**
1058 * @param {TaskAgentInterfaces.PublishTaskGroupMetadata} taskGroupMetadata
1059 * @param {string} project - Project ID or project name
1060 * @param {string} parentTaskGroupId
1061 */
1062 publishTaskGroup(taskGroupMetadata: TaskAgentInterfaces.PublishTaskGroupMetadata, project: string, parentTaskGroupId: string): Promise<TaskAgentInterfaces.TaskGroup[]>;
1063 /**
1064 * @param {TaskAgentInterfaces.TaskGroup} taskGroup
1065 * @param {string} project - Project ID or project name
1066 */
1067 undeleteTaskGroup(taskGroup: TaskAgentInterfaces.TaskGroup, project: string): Promise<TaskAgentInterfaces.TaskGroup[]>;
1068 /**
1069 * Update a task group.
1070 *
1071 * @param {TaskAgentInterfaces.TaskGroupUpdateParameter} taskGroup - Task group to update.
1072 * @param {string} project - Project ID or project name
1073 * @param {string} taskGroupId - Id of the task group to update.
1074 */
1075 updateTaskGroup(taskGroup: TaskAgentInterfaces.TaskGroupUpdateParameter, project: string, taskGroupId?: string): Promise<TaskAgentInterfaces.TaskGroup>;
1076 /**
1077 * @param {TaskAgentInterfaces.TaskGroupUpdatePropertiesBase} taskGroupUpdateProperties
1078 * @param {string} project - Project ID or project name
1079 * @param {string} taskGroupId
1080 * @param {boolean} disablePriorVersions
1081 */
1082 updateTaskGroupProperties(taskGroupUpdateProperties: TaskAgentInterfaces.TaskGroupUpdatePropertiesBase, project: string, taskGroupId: string, disablePriorVersions?: boolean): Promise<TaskAgentInterfaces.TaskGroup[]>;
1083 /**
1084 * @param {string} taskId
1085 */
1086 deleteTaskDefinition(taskId: string): Promise<void>;
1087 /**
1088 * @param {string} taskId
1089 * @param {string} versionString
1090 * @param {string[]} visibility
1091 * @param {boolean} scopeLocal
1092 */
1093 getTaskContentZip(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<NodeJS.ReadableStream>;
1094 /**
1095 * @param {string} taskId
1096 * @param {string} versionString
1097 * @param {string[]} visibility
1098 * @param {boolean} scopeLocal
1099 */
1100 getTaskDefinition(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise<TaskAgentInterfaces.TaskDefinition>;
1101 /**
1102 * @param {string} taskId
1103 * @param {string[]} visibility
1104 * @param {boolean} scopeLocal
1105 * @param {boolean} allVersions
1106 */
1107 getTaskDefinitions(taskId?: string, visibility?: string[], scopeLocal?: boolean, allVersions?: boolean): Promise<TaskAgentInterfaces.TaskDefinition[]>;
1108 /**
1109 * @param {number} poolId
1110 * @param {number} agentId
1111 * @param {string} currentState
1112 */
1113 updateAgentUpdateState(poolId: number, agentId: number, currentState: string): Promise<TaskAgentInterfaces.TaskAgent>;
1114 /**
1115 * @param {{ [key: string] : string; }} userCapabilities
1116 * @param {number} poolId
1117 * @param {number} agentId
1118 */
1119 updateAgentUserCapabilities(userCapabilities: {
1120 [key: string]: string;
1121 }, poolId: number, agentId: number): Promise<TaskAgentInterfaces.TaskAgent>;
1122 /**
1123 * Add a variable group.
1124 *
1125 * @param {TaskAgentInterfaces.VariableGroupParameters} variableGroupParameters
1126 */
1127 addVariableGroup(variableGroupParameters: TaskAgentInterfaces.VariableGroupParameters): Promise<TaskAgentInterfaces.VariableGroup>;
1128 /**
1129 * Delete a variable group
1130 *
1131 * @param {number} groupId - Id of the variable group.
1132 * @param {string[]} projectIds
1133 */
1134 deleteVariableGroup(groupId: number, projectIds: string[]): Promise<void>;
1135 /**
1136 * Add a variable group.
1137 *
1138 * @param {TaskAgentInterfaces.VariableGroupProjectReference[]} variableGroupProjectReferences
1139 * @param {number} variableGroupId
1140 */
1141 shareVariableGroup(variableGroupProjectReferences: TaskAgentInterfaces.VariableGroupProjectReference[], variableGroupId: number): Promise<void>;
1142 /**
1143 * Update a variable group.
1144 *
1145 * @param {TaskAgentInterfaces.VariableGroupParameters} variableGroupParameters
1146 * @param {number} groupId - Id of the variable group to update.
1147 */
1148 updateVariableGroup(variableGroupParameters: TaskAgentInterfaces.VariableGroupParameters, groupId: number): Promise<TaskAgentInterfaces.VariableGroup>;
1149 /**
1150 * Get a variable group.
1151 *
1152 * @param {string} project - Project ID or project name
1153 * @param {number} groupId - Id of the variable group.
1154 */
1155 getVariableGroup(project: string, groupId: number): Promise<TaskAgentInterfaces.VariableGroup>;
1156 /**
1157 * Get variable groups.
1158 *
1159 * @param {string} project - Project ID or project name
1160 * @param {string} groupName - Name of variable group.
1161 * @param {TaskAgentInterfaces.VariableGroupActionFilter} actionFilter - Action filter for the variable group. It specifies the action which can be performed on the variable groups.
1162 * @param {number} top - Number of variable groups to get.
1163 * @param {number} continuationToken - Gets the variable groups after the continuation token provided.
1164 * @param {TaskAgentInterfaces.VariableGroupQueryOrder} queryOrder - Gets the results in the defined order. Default is 'IdDescending'.
1165 */
1166 getVariableGroups(project: string, groupName?: string, actionFilter?: TaskAgentInterfaces.VariableGroupActionFilter, top?: number, continuationToken?: number, queryOrder?: TaskAgentInterfaces.VariableGroupQueryOrder): Promise<TaskAgentInterfaces.VariableGroup[]>;
1167 /**
1168 * Get variable groups by ids.
1169 *
1170 * @param {string} project - Project ID or project name
1171 * @param {number[]} groupIds - Comma separated list of Ids of variable groups.
1172 * @param {boolean} loadSecrets
1173 */
1174 getVariableGroupsById(project: string, groupIds: number[], loadSecrets?: boolean): Promise<TaskAgentInterfaces.VariableGroup[]>;
1175 /**
1176 * @param {TaskAgentInterfaces.VirtualMachineGroupCreateParameters} createParameters
1177 * @param {string} project - Project ID or project name
1178 * @param {number} environmentId
1179 */
1180 addVirtualMachineGroup(createParameters: TaskAgentInterfaces.VirtualMachineGroupCreateParameters, project: string, environmentId: number): Promise<TaskAgentInterfaces.VirtualMachineGroup>;
1181 /**
1182 * @param {string} project - Project ID or project name
1183 * @param {number} environmentId
1184 * @param {number} resourceId
1185 */
1186 deleteVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<void>;
1187 /**
1188 * @param {string} project - Project ID or project name
1189 * @param {number} environmentId
1190 * @param {number} resourceId
1191 */
1192 getVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise<TaskAgentInterfaces.VirtualMachineGroup>;
1193 /**
1194 * @param {TaskAgentInterfaces.VirtualMachineGroup} resource
1195 * @param {string} project - Project ID or project name
1196 * @param {number} environmentId
1197 */
1198 updateVirtualMachineGroup(resource: TaskAgentInterfaces.VirtualMachineGroup, project: string, environmentId: number): Promise<TaskAgentInterfaces.VirtualMachineGroup>;
1199 /**
1200 * @param {string} project - Project ID or project name
1201 * @param {number} environmentId
1202 * @param {number} resourceId
1203 * @param {string} continuationToken
1204 * @param {string} name
1205 * @param {boolean} partialNameMatch
1206 * @param {string[]} tags
1207 * @param {number} top
1208 */
1209 getVirtualMachines(project: string, environmentId: number, resourceId: number, continuationToken?: string, name?: string, partialNameMatch?: boolean, tags?: string[], top?: number): Promise<VSSInterfaces.PagedList<TaskAgentInterfaces.VirtualMachine>>;
1210 /**
1211 * @param {TaskAgentInterfaces.VirtualMachine[]} machines
1212 * @param {string} project - Project ID or project name
1213 * @param {number} environmentId
1214 * @param {number} resourceId
1215 */
1216 updateVirtualMachines(machines: TaskAgentInterfaces.VirtualMachine[], project: string, environmentId: number, resourceId: number): Promise<TaskAgentInterfaces.VirtualMachine[]>;
1217 /**
1218 * @param {string} tenantId
1219 * @param {string} redirectUri
1220 * @param {TaskAgentInterfaces.AadLoginPromptOption} promptOption
1221 * @param {string} completeCallbackPayload
1222 * @param {boolean} completeCallbackByAuthCode
1223 */
1224 createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: TaskAgentInterfaces.AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise<string>;
1225 /**
1226 */
1227 getVstsAadTenantId(): Promise<string>;
1228 /**
1229 * GET the Yaml schema used for Yaml file validation.
1230 *
1231 * @param {boolean} validateTaskNames - Whether the schema should validate that tasks are actually installed (useful for offline tools where you don't want validation).
1232 */
1233 getYamlSchema(validateTaskNames?: boolean): Promise<any>;
1234}