///
import basem = require('./ClientApiBases');
import VsoBaseInterfaces = require('./interfaces/common/VsoBaseInterfaces');
import TaskAgentInterfaces = require("./interfaces/TaskAgentInterfaces");
export interface ITaskAgentApiBase extends basem.ClientApiBase {
addAgentCloud(agentCloud: TaskAgentInterfaces.TaskAgentCloud): Promise;
deleteAgentCloud(agentCloudId: number): Promise;
getAgentCloud(agentCloudId: number): Promise;
getAgentClouds(): Promise;
updateAgentCloud(updatedCloud: TaskAgentInterfaces.TaskAgentCloud, agentCloudId: number): Promise;
getAgentCloudTypes(): Promise;
getAgentRequestsForQueue(project: string, queueId: number, top: number, continuationToken?: string): Promise;
queueAgentRequest(request: TaskAgentInterfaces.TaskAgentJobRequest, project: string, queueId: number): Promise;
addAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number): Promise;
deleteAgent(poolId: number, agentId: number): Promise;
getAgent(poolId: number, agentId: number, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[]): Promise;
getAgents(poolId: number, agentName?: string, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[], demands?: string[]): Promise;
replaceAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number, agentId: number): Promise;
updateAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number, agentId: number): Promise;
getAzureManagementGroups(): Promise;
getAzureSubscriptions(): Promise;
generateDeploymentGroupAccessToken(project: string, deploymentGroupId: number): Promise;
addDeploymentGroup(deploymentGroup: TaskAgentInterfaces.DeploymentGroupCreateParameter, project: string): Promise;
deleteDeploymentGroup(project: string, deploymentGroupId: number): Promise;
getDeploymentGroup(project: string, deploymentGroupId: number, actionFilter?: TaskAgentInterfaces.DeploymentGroupActionFilter, expand?: TaskAgentInterfaces.DeploymentGroupExpands): Promise;
getDeploymentGroups(project: string, name?: string, actionFilter?: TaskAgentInterfaces.DeploymentGroupActionFilter, expand?: TaskAgentInterfaces.DeploymentGroupExpands, continuationToken?: string, top?: number, ids?: number[]): Promise;
updateDeploymentGroup(deploymentGroup: TaskAgentInterfaces.DeploymentGroupUpdateParameter, project: string, deploymentGroupId: number): Promise;
getDeploymentGroupsMetrics(project: string, deploymentGroupName?: string, continuationToken?: string, top?: number): Promise;
getAgentRequestsForDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, completedRequestCount?: number): Promise;
getAgentRequestsForDeploymentMachines(project: string, deploymentGroupId: number, machineIds?: number[], completedRequestCount?: number): Promise;
refreshDeploymentMachines(project: string, deploymentGroupId: number): Promise;
generateDeploymentPoolAccessToken(poolId: number): Promise;
getDeploymentPoolsSummary(poolName?: string, expands?: TaskAgentInterfaces.DeploymentPoolSummaryExpands, poolIds?: number[]): Promise;
getAgentRequestsForDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, completedRequestCount?: number): Promise;
getAgentRequestsForDeploymentTargets(project: string, deploymentGroupId: number, targetIds?: number[], ownerId?: number, completedOn?: Date, completedRequestCount?: number): Promise;
refreshDeploymentTargets(project: string, deploymentGroupId: number): Promise;
queryEndpoint(endpoint: TaskAgentInterfaces.TaskDefinitionEndpoint): Promise;
getEnvironmentDeploymentExecutionRecords(project: string, environmentId: number, continuationToken?: string, top?: number): Promise;
addEnvironment(environmentCreateParameter: TaskAgentInterfaces.EnvironmentCreateParameter, project: string): Promise;
deleteEnvironment(project: string, environmentId: number): Promise;
getEnvironmentById(project: string, environmentId: number, expands?: TaskAgentInterfaces.EnvironmentExpands): Promise;
getEnvironments(project: string, name?: string, continuationToken?: string, top?: number): Promise;
updateEnvironment(environmentUpdateParameter: TaskAgentInterfaces.EnvironmentUpdateParameter, project: string, environmentId: number): Promise;
getTaskHubLicenseDetails(hubName: string, includeEnterpriseUsersCount?: boolean, includeHostedAgentMinutesCount?: boolean): Promise;
updateTaskHubLicenseDetails(taskHubLicenseDetails: TaskAgentInterfaces.TaskHubLicenseDetails, hubName: string): Promise;
validateInputs(inputValidationRequest: TaskAgentInterfaces.InputValidationRequest): Promise;
deleteAgentRequest(poolId: number, requestId: number, lockToken: string, result?: TaskAgentInterfaces.TaskResult, agentShuttingDown?: boolean): Promise;
getAgentRequest(poolId: number, requestId: number, includeStatus?: boolean): Promise;
getAgentRequests(poolId: number, top: number, continuationToken?: string): Promise;
getAgentRequestsForAgent(poolId: number, agentId: number, completedRequestCount?: number): Promise;
getAgentRequestsForAgents(poolId: number, agentIds?: number[], completedRequestCount?: number): Promise;
getAgentRequestsForPlan(poolId: number, planId: string, jobId?: string): Promise;
queueAgentRequestByPool(request: TaskAgentInterfaces.TaskAgentJobRequest, poolId: number): Promise;
updateAgentRequest(request: TaskAgentInterfaces.TaskAgentJobRequest, poolId: number, requestId: number, lockToken: string, updateOptions?: TaskAgentInterfaces.TaskAgentRequestUpdateOptions): Promise;
addKubernetesResource(createParameters: TaskAgentInterfaces.KubernetesResourceCreateParameters, project: string, environmentId: number): Promise;
deleteKubernetesResource(project: string, environmentId: number, resourceId: number): Promise;
getKubernetesResource(project: string, environmentId: number, resourceId: number): Promise;
generateDeploymentMachineGroupAccessToken(project: string, machineGroupId: number): Promise;
addDeploymentMachineGroup(machineGroup: TaskAgentInterfaces.DeploymentMachineGroup, project: string): Promise;
deleteDeploymentMachineGroup(project: string, machineGroupId: number): Promise;
getDeploymentMachineGroup(project: string, machineGroupId: number, actionFilter?: TaskAgentInterfaces.MachineGroupActionFilter): Promise;
getDeploymentMachineGroups(project: string, machineGroupName?: string, actionFilter?: TaskAgentInterfaces.MachineGroupActionFilter): Promise;
updateDeploymentMachineGroup(machineGroup: TaskAgentInterfaces.DeploymentMachineGroup, project: string, machineGroupId: number): Promise;
getDeploymentMachineGroupMachines(project: string, machineGroupId: number, tagFilters?: string[]): Promise;
updateDeploymentMachineGroupMachines(deploymentMachines: TaskAgentInterfaces.DeploymentMachine[], project: string, machineGroupId: number): Promise;
addDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number): Promise;
deleteDeploymentMachine(project: string, deploymentGroupId: number, machineId: number): Promise;
getDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, expand?: TaskAgentInterfaces.DeploymentMachineExpands): Promise;
getDeploymentMachines(project: string, deploymentGroupId: number, tags?: string[], name?: string, expand?: TaskAgentInterfaces.DeploymentMachineExpands): Promise;
replaceDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise;
updateDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise;
updateDeploymentMachines(machines: TaskAgentInterfaces.DeploymentMachine[], project: string, deploymentGroupId: number): Promise;
createAgentPoolMaintenanceDefinition(definition: TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition, poolId: number): Promise;
deleteAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise;
getAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise;
getAgentPoolMaintenanceDefinitions(poolId: number): Promise;
updateAgentPoolMaintenanceDefinition(definition: TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition, poolId: number, definitionId: number): Promise;
deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise;
getAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise;
getAgentPoolMaintenanceJobLogs(poolId: number, jobId: number): Promise;
getAgentPoolMaintenanceJobs(poolId: number, definitionId?: number): Promise;
queueAgentPoolMaintenanceJob(job: TaskAgentInterfaces.TaskAgentPoolMaintenanceJob, poolId: number): Promise;
updateAgentPoolMaintenanceJob(job: TaskAgentInterfaces.TaskAgentPoolMaintenanceJob, poolId: number, jobId: number): Promise;
deleteMessage(poolId: number, messageId: number, sessionId: string): Promise;
getMessage(poolId: number, sessionId: string, lastMessageId?: number): Promise;
refreshAgent(poolId: number, agentId: number): Promise;
refreshAgents(poolId: number): Promise;
sendMessage(message: TaskAgentInterfaces.TaskAgentMessage, poolId: number, requestId: number): Promise;
getPackage(packageType: string, platform: string, version: string): Promise;
getPackages(packageType: string, platform?: string, top?: number): Promise;
getAgentPoolMetadata(poolId: number): Promise;
setAgentPoolMetadata(customHeaders: any, agentPoolMetadata: any, poolId: number): Promise;
addAgentPool(pool: TaskAgentInterfaces.TaskAgentPool): Promise;
deleteAgentPool(poolId: number): Promise;
getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise;
getAgentPools(poolName?: string, properties?: string[], poolType?: TaskAgentInterfaces.TaskAgentPoolType, actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise;
getAgentPoolsByIds(poolIds: number[], actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise;
updateAgentPool(pool: TaskAgentInterfaces.TaskAgentPool, poolId: number): Promise;
addAgentQueue(queue: TaskAgentInterfaces.TaskAgentQueue, project?: string, authorizePipelines?: boolean): Promise;
createTeamProject(project?: string): Promise;
deleteAgentQueue(queueId: number, project?: string): Promise;
getAgentQueue(queueId: number, project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise;
getAgentQueues(project?: string, queueName?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise;
getAgentQueuesByIds(queueIds: number[], project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise;
getAgentQueuesByNames(queueNames: string[], project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise;
getAgentQueuesForPools(poolIds: number[], project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise;
getAgentCloudRequests(agentCloudId: number): Promise;
getResourceLimits(): Promise;
getResourceUsage(parallelismTag?: string, poolIsHosted?: boolean, includeRunningRequests?: boolean): Promise;
getTaskGroupHistory(project: string, taskGroupId: string): Promise;
deleteSecureFile(project: string, secureFileId: string): Promise;
downloadSecureFile(project: string, secureFileId: string, ticket: string, download?: boolean): Promise;
getSecureFile(project: string, secureFileId: string, includeDownloadTicket?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise;
getSecureFiles(project: string, namePattern?: string, includeDownloadTickets?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise;
getSecureFilesByIds(project: string, secureFileIds: string[], includeDownloadTickets?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise;
getSecureFilesByNames(project: string, secureFileNames: string[], includeDownloadTickets?: boolean, actionFilter?: TaskAgentInterfaces.SecureFileActionFilter): Promise;
querySecureFilesByProperties(condition: string, project: string, namePattern?: string): Promise;
updateSecureFile(secureFile: TaskAgentInterfaces.SecureFile, project: string, secureFileId: string): Promise;
updateSecureFiles(secureFiles: TaskAgentInterfaces.SecureFile[], project: string): Promise;
uploadSecureFile(customHeaders: any, contentStream: NodeJS.ReadableStream, project: string, name: string, authorizePipelines?: boolean): Promise;
createAgentSession(session: TaskAgentInterfaces.TaskAgentSession, poolId: number): Promise;
deleteAgentSession(poolId: number, sessionId: string): Promise;
addDeploymentTarget(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number): Promise;
deleteDeploymentTarget(project: string, deploymentGroupId: number, targetId: number): Promise;
getDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, expand?: TaskAgentInterfaces.DeploymentTargetExpands): Promise;
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;
replaceDeploymentTarget(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise;
updateDeploymentTarget(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, targetId: number): Promise;
updateDeploymentTargets(machines: TaskAgentInterfaces.DeploymentTargetUpdateParameter[], project: string, deploymentGroupId: number): Promise;
addTaskGroup(taskGroup: TaskAgentInterfaces.TaskGroupCreateParameter, project: string): Promise;
deleteTaskGroup(project: string, taskGroupId: string, comment?: string): Promise;
getTaskGroup(project: string, taskGroupId: string, versionSpec: string, expand?: TaskAgentInterfaces.TaskGroupExpands): Promise;
getTaskGroupRevision(project: string, taskGroupId: string, revision: number): Promise;
getTaskGroups(project: string, taskGroupId?: string, expanded?: boolean, taskIdFilter?: string, deleted?: boolean, top?: number, continuationToken?: Date, queryOrder?: TaskAgentInterfaces.TaskGroupQueryOrder): Promise;
publishTaskGroup(taskGroupMetadata: TaskAgentInterfaces.PublishTaskGroupMetadata, project: string, parentTaskGroupId: string): Promise;
undeleteTaskGroup(taskGroup: TaskAgentInterfaces.TaskGroup, project: string): Promise;
updateTaskGroup(taskGroup: TaskAgentInterfaces.TaskGroupUpdateParameter, project: string, taskGroupId?: string): Promise;
updateTaskGroupProperties(taskGroupUpdateProperties: TaskAgentInterfaces.TaskGroupUpdatePropertiesBase, project: string, taskGroupId: string, disablePriorVersions?: boolean): Promise;
deleteTaskDefinition(taskId: string): Promise;
getTaskContentZip(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise;
getTaskDefinition(taskId: string, versionString: string, visibility?: string[], scopeLocal?: boolean): Promise;
getTaskDefinitions(taskId?: string, visibility?: string[], scopeLocal?: boolean, allVersions?: boolean): Promise;
updateAgentUpdateState(poolId: number, agentId: number, currentState: string): Promise;
updateAgentUserCapabilities(userCapabilities: {
[key: string]: string;
}, poolId: number, agentId: number): Promise;
addVariableGroup(variableGroupParameters: TaskAgentInterfaces.VariableGroupParameters): Promise;
deleteVariableGroup(groupId: number, projectIds: string[]): Promise;
shareVariableGroup(variableGroupProjectReferences: TaskAgentInterfaces.VariableGroupProjectReference[], variableGroupId: number): Promise;
updateVariableGroup(variableGroupParameters: TaskAgentInterfaces.VariableGroupParameters, groupId: number): Promise;
getVariableGroup(project: string, groupId: number): Promise;
getVariableGroups(project: string, groupName?: string, actionFilter?: TaskAgentInterfaces.VariableGroupActionFilter, top?: number, continuationToken?: number, queryOrder?: TaskAgentInterfaces.VariableGroupQueryOrder): Promise;
getVariableGroupsById(project: string, groupIds: number[]): Promise;
addVirtualMachineGroup(createParameters: TaskAgentInterfaces.VirtualMachineGroupCreateParameters, project: string, environmentId: number): Promise;
deleteVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise;
getVirtualMachineGroup(project: string, environmentId: number, resourceId: number): Promise;
updateVirtualMachineGroup(resource: TaskAgentInterfaces.VirtualMachineGroup, project: string, environmentId: number): Promise;
getVirtualMachines(project: string, environmentId: number, resourceId: number, continuationToken?: string, name?: string, partialNameMatch?: boolean, tags?: string[], top?: number): Promise;
updateVirtualMachines(machines: TaskAgentInterfaces.VirtualMachine[], project: string, environmentId: number, resourceId: number): Promise;
acquireAccessToken(authenticationRequest: TaskAgentInterfaces.AadOauthTokenRequest): Promise;
createAadOAuthRequest(tenantId: string, redirectUri: string, promptOption?: TaskAgentInterfaces.AadLoginPromptOption, completeCallbackPayload?: string, completeCallbackByAuthCode?: boolean): Promise;
getVstsAadTenantId(): Promise;
getYamlSchema(validateTaskNames?: boolean): Promise;
}
export declare class TaskAgentApiBase extends basem.ClientApiBase implements ITaskAgentApiBase {
constructor(baseUrl: string, handlers: VsoBaseInterfaces.IRequestHandler[], options?: VsoBaseInterfaces.IRequestOptions);
static readonly RESOURCE_AREA_ID = "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd";
/**
* @param {TaskAgentInterfaces.TaskAgentCloud} agentCloud
*/
addAgentCloud(agentCloud: TaskAgentInterfaces.TaskAgentCloud): Promise;
/**
* @param {number} agentCloudId
*/
deleteAgentCloud(agentCloudId: number): Promise;
/**
* @param {number} agentCloudId
*/
getAgentCloud(agentCloudId: number): Promise;
/**
*/
getAgentClouds(): Promise;
/**
* @param {TaskAgentInterfaces.TaskAgentCloud} updatedCloud
* @param {number} agentCloudId
*/
updateAgentCloud(updatedCloud: TaskAgentInterfaces.TaskAgentCloud, agentCloudId: number): Promise;
/**
* Get agent cloud types.
*
*/
getAgentCloudTypes(): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} queueId
* @param {number} top
* @param {string} continuationToken
*/
getAgentRequestsForQueue(project: string, queueId: number, top: number, continuationToken?: string): Promise;
/**
* @param {TaskAgentInterfaces.TaskAgentJobRequest} request
* @param {string} project - Project ID or project name
* @param {number} queueId
*/
queueAgentRequest(request: TaskAgentInterfaces.TaskAgentJobRequest, project: string, queueId: number): Promise;
/**
* 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.
*
* @param {TaskAgentInterfaces.TaskAgent} agent - Details about the agent being added
* @param {number} poolId - The agent pool in which to add the agent
*/
addAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number): Promise;
/**
* 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.
*
* @param {number} poolId - The pool ID to remove the agent from
* @param {number} agentId - The agent ID to remove
*/
deleteAgent(poolId: number, agentId: number): Promise;
/**
* Get information about an agent.
*
* @param {number} poolId - The agent pool containing the agent
* @param {number} agentId - The agent ID to get information about
* @param {boolean} includeCapabilities - Whether to include the agent's capabilities in the response
* @param {boolean} includeAssignedRequest - Whether to include details about the agent's current work
* @param {boolean} includeLastCompletedRequest - Whether to include details about the agents' most recent completed work
* @param {string[]} propertyFilters - Filter which custom properties will be returned
*/
getAgent(poolId: number, agentId: number, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[]): Promise;
/**
* Get a list of agents.
*
* @param {number} poolId - The agent pool containing the agents
* @param {string} agentName - Filter on agent name
* @param {boolean} includeCapabilities - Whether to include the agents' capabilities in the response
* @param {boolean} includeAssignedRequest - Whether to include details about the agents' current work
* @param {boolean} includeLastCompletedRequest - Whether to include details about the agents' most recent completed work
* @param {string[]} propertyFilters - Filter which custom properties will be returned
* @param {string[]} demands - Filter by demands the agents can satisfy
*/
getAgents(poolId: number, agentName?: string, includeCapabilities?: boolean, includeAssignedRequest?: boolean, includeLastCompletedRequest?: boolean, propertyFilters?: string[], demands?: string[]): Promise;
/**
* 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.
*
* @param {TaskAgentInterfaces.TaskAgent} agent - Updated details about the replacing agent
* @param {number} poolId - The agent pool to use
* @param {number} agentId - The agent to replace
*/
replaceAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number, agentId: number): Promise;
/**
* Update agent details.
*
* @param {TaskAgentInterfaces.TaskAgent} agent - Updated details about the agent
* @param {number} poolId - The agent pool to use
* @param {number} agentId - The agent to update
*/
updateAgent(agent: TaskAgentInterfaces.TaskAgent, poolId: number, agentId: number): Promise;
/**
* Returns list of azure subscriptions
*
*/
getAzureManagementGroups(): Promise;
/**
* Returns list of azure subscriptions
*
*/
getAzureSubscriptions(): Promise;
/**
* GET a PAT token for managing (configuring, removing, tagging) deployment targets in a deployment group.
*
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId - ID of the deployment group in which deployment targets are managed.
*/
generateDeploymentGroupAccessToken(project: string, deploymentGroupId: number): Promise;
/**
* Create a deployment group.
*
* @param {TaskAgentInterfaces.DeploymentGroupCreateParameter} deploymentGroup - Deployment group to create.
* @param {string} project - Project ID or project name
*/
addDeploymentGroup(deploymentGroup: TaskAgentInterfaces.DeploymentGroupCreateParameter, project: string): Promise;
/**
* Delete a deployment group.
*
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId - ID of the deployment group to be deleted.
*/
deleteDeploymentGroup(project: string, deploymentGroupId: number): Promise;
/**
* Get a deployment group by its ID.
*
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId - ID of the deployment group.
* @param {TaskAgentInterfaces.DeploymentGroupActionFilter} actionFilter - Get the deployment group only if this action can be performed on it.
* @param {TaskAgentInterfaces.DeploymentGroupExpands} expand - Include these additional details in the returned object.
*/
getDeploymentGroup(project: string, deploymentGroupId: number, actionFilter?: TaskAgentInterfaces.DeploymentGroupActionFilter, expand?: TaskAgentInterfaces.DeploymentGroupExpands): Promise;
/**
* Get a list of deployment groups by name or IDs.
*
* @param {string} project - Project ID or project name
* @param {string} name - Name of the deployment group.
* @param {TaskAgentInterfaces.DeploymentGroupActionFilter} actionFilter - Get only deployment groups on which this action can be performed.
* @param {TaskAgentInterfaces.DeploymentGroupExpands} expand - Include these additional details in the returned objects.
* @param {string} continuationToken - Get deployment groups with names greater than this continuationToken lexicographically.
* @param {number} top - Maximum number of deployment groups to return. Default is **1000**.
* @param {number[]} ids - Comma separated list of IDs of the deployment groups.
*/
getDeploymentGroups(project: string, name?: string, actionFilter?: TaskAgentInterfaces.DeploymentGroupActionFilter, expand?: TaskAgentInterfaces.DeploymentGroupExpands, continuationToken?: string, top?: number, ids?: number[]): Promise;
/**
* Update a deployment group.
*
* @param {TaskAgentInterfaces.DeploymentGroupUpdateParameter} deploymentGroup - Deployment group to update.
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId - ID of the deployment group.
*/
updateDeploymentGroup(deploymentGroup: TaskAgentInterfaces.DeploymentGroupUpdateParameter, project: string, deploymentGroupId: number): Promise;
/**
* Get a list of deployment group metrics.
*
* @param {string} project - Project ID or project name
* @param {string} deploymentGroupName - Name of the deployment group.
* @param {string} continuationToken - Get metrics for deployment groups with names greater than this continuationToken lexicographically.
* @param {number} top - Maximum number of deployment group metrics to return. Default is **50**.
*/
getDeploymentGroupsMetrics(project: string, deploymentGroupName?: string, continuationToken?: string, top?: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId
* @param {number} machineId
* @param {number} completedRequestCount
*/
getAgentRequestsForDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, completedRequestCount?: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId
* @param {number[]} machineIds
* @param {number} completedRequestCount
*/
getAgentRequestsForDeploymentMachines(project: string, deploymentGroupId: number, machineIds?: number[], completedRequestCount?: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId
*/
refreshDeploymentMachines(project: string, deploymentGroupId: number): Promise;
/**
* GET a PAT token for managing (configuring, removing, tagging) deployment agents in a deployment pool.
*
* @param {number} poolId - ID of the deployment pool in which deployment agents are managed.
*/
generateDeploymentPoolAccessToken(poolId: number): Promise;
/**
* Get a list of deployment pool summaries.
*
* @param {string} poolName - Name of the deployment pool.
* @param {TaskAgentInterfaces.DeploymentPoolSummaryExpands} expands - Include these additional details in the returned objects.
* @param {number[]} poolIds - List of deployment pool ids.
*/
getDeploymentPoolsSummary(poolName?: string, expands?: TaskAgentInterfaces.DeploymentPoolSummaryExpands, poolIds?: number[]): Promise;
/**
* Get agent requests for a deployment target.
*
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId - ID of the deployment group to which the target belongs.
* @param {number} targetId - ID of the deployment target.
* @param {number} completedRequestCount - Maximum number of completed requests to return. Default is **50**
*/
getAgentRequestsForDeploymentTarget(project: string, deploymentGroupId: number, targetId: number, completedRequestCount?: number): Promise;
/**
* Get agent requests for a list deployment targets.
*
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId - ID of the deployment group to which the targets belong.
* @param {number[]} targetIds - Comma separated list of IDs of the deployment targets.
* @param {number} ownerId - Id of owner of agent job request.
* @param {Date} completedOn - Datetime to return request after this time.
* @param {number} completedRequestCount - Maximum number of completed requests to return for each target. Default is **50**
*/
getAgentRequestsForDeploymentTargets(project: string, deploymentGroupId: number, targetIds?: number[], ownerId?: number, completedOn?: Date, completedRequestCount?: number): Promise;
/**
* Upgrade the deployment targets in a deployment group.
*
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId - ID of the deployment group.
*/
refreshDeploymentTargets(project: string, deploymentGroupId: number): Promise;
/**
* 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.
*
* @param {TaskAgentInterfaces.TaskDefinitionEndpoint} endpoint - Describes the URL to fetch.
*/
queryEndpoint(endpoint: TaskAgentInterfaces.TaskDefinitionEndpoint): Promise;
/**
* Get environment deployment execution history
*
* @param {string} project - Project ID or project name
* @param {number} environmentId
* @param {string} continuationToken
* @param {number} top
*/
getEnvironmentDeploymentExecutionRecords(project: string, environmentId: number, continuationToken?: string, top?: number): Promise;
/**
* Create an environment.
*
* @param {TaskAgentInterfaces.EnvironmentCreateParameter} environmentCreateParameter - Environment to create.
* @param {string} project - Project ID or project name
*/
addEnvironment(environmentCreateParameter: TaskAgentInterfaces.EnvironmentCreateParameter, project: string): Promise;
/**
* Delete the specified environment.
*
* @param {string} project - Project ID or project name
* @param {number} environmentId - ID of the environment.
*/
deleteEnvironment(project: string, environmentId: number): Promise;
/**
* Get an environment by its ID.
*
* @param {string} project - Project ID or project name
* @param {number} environmentId - ID of the environment.
* @param {TaskAgentInterfaces.EnvironmentExpands} expands - Include these additional details in the returned objects.
*/
getEnvironmentById(project: string, environmentId: number, expands?: TaskAgentInterfaces.EnvironmentExpands): Promise;
/**
* Get all environments.
*
* @param {string} project - Project ID or project name
* @param {string} name
* @param {string} continuationToken
* @param {number} top
*/
getEnvironments(project: string, name?: string, continuationToken?: string, top?: number): Promise;
/**
* Update the specified environment.
*
* @param {TaskAgentInterfaces.EnvironmentUpdateParameter} environmentUpdateParameter - Environment data to update.
* @param {string} project - Project ID or project name
* @param {number} environmentId - ID of the environment.
*/
updateEnvironment(environmentUpdateParameter: TaskAgentInterfaces.EnvironmentUpdateParameter, project: string, environmentId: number): Promise;
/**
* @param {string} hubName
* @param {boolean} includeEnterpriseUsersCount
* @param {boolean} includeHostedAgentMinutesCount
*/
getTaskHubLicenseDetails(hubName: string, includeEnterpriseUsersCount?: boolean, includeHostedAgentMinutesCount?: boolean): Promise;
/**
* @param {TaskAgentInterfaces.TaskHubLicenseDetails} taskHubLicenseDetails
* @param {string} hubName
*/
updateTaskHubLicenseDetails(taskHubLicenseDetails: TaskAgentInterfaces.TaskHubLicenseDetails, hubName: string): Promise;
/**
* @param {TaskAgentInterfaces.InputValidationRequest} inputValidationRequest
*/
validateInputs(inputValidationRequest: TaskAgentInterfaces.InputValidationRequest): Promise;
/**
* @param {number} poolId
* @param {number} requestId
* @param {string} lockToken
* @param {TaskAgentInterfaces.TaskResult} result
* @param {boolean} agentShuttingDown
*/
deleteAgentRequest(poolId: number, requestId: number, lockToken: string, result?: TaskAgentInterfaces.TaskResult, agentShuttingDown?: boolean): Promise;
/**
* @param {number} poolId
* @param {number} requestId
* @param {boolean} includeStatus
*/
getAgentRequest(poolId: number, requestId: number, includeStatus?: boolean): Promise;
/**
* @param {number} poolId
* @param {number} top
* @param {string} continuationToken
*/
getAgentRequests(poolId: number, top: number, continuationToken?: string): Promise;
/**
* @param {number} poolId
* @param {number} agentId
* @param {number} completedRequestCount
*/
getAgentRequestsForAgent(poolId: number, agentId: number, completedRequestCount?: number): Promise;
/**
* @param {number} poolId
* @param {number[]} agentIds
* @param {number} completedRequestCount
*/
getAgentRequestsForAgents(poolId: number, agentIds?: number[], completedRequestCount?: number): Promise;
/**
* @param {number} poolId
* @param {string} planId
* @param {string} jobId
*/
getAgentRequestsForPlan(poolId: number, planId: string, jobId?: string): Promise;
/**
* @param {TaskAgentInterfaces.TaskAgentJobRequest} request
* @param {number} poolId
*/
queueAgentRequestByPool(request: TaskAgentInterfaces.TaskAgentJobRequest, poolId: number): Promise;
/**
* @param {TaskAgentInterfaces.TaskAgentJobRequest} request
* @param {number} poolId
* @param {number} requestId
* @param {string} lockToken
* @param {TaskAgentInterfaces.TaskAgentRequestUpdateOptions} updateOptions
*/
updateAgentRequest(request: TaskAgentInterfaces.TaskAgentJobRequest, poolId: number, requestId: number, lockToken: string, updateOptions?: TaskAgentInterfaces.TaskAgentRequestUpdateOptions): Promise;
/**
* @param {TaskAgentInterfaces.KubernetesResourceCreateParameters} createParameters
* @param {string} project - Project ID or project name
* @param {number} environmentId
*/
addKubernetesResource(createParameters: TaskAgentInterfaces.KubernetesResourceCreateParameters, project: string, environmentId: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} environmentId
* @param {number} resourceId
*/
deleteKubernetesResource(project: string, environmentId: number, resourceId: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} environmentId
* @param {number} resourceId
*/
getKubernetesResource(project: string, environmentId: number, resourceId: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} machineGroupId
*/
generateDeploymentMachineGroupAccessToken(project: string, machineGroupId: number): Promise;
/**
* @param {TaskAgentInterfaces.DeploymentMachineGroup} machineGroup
* @param {string} project - Project ID or project name
*/
addDeploymentMachineGroup(machineGroup: TaskAgentInterfaces.DeploymentMachineGroup, project: string): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} machineGroupId
*/
deleteDeploymentMachineGroup(project: string, machineGroupId: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} machineGroupId
* @param {TaskAgentInterfaces.MachineGroupActionFilter} actionFilter
*/
getDeploymentMachineGroup(project: string, machineGroupId: number, actionFilter?: TaskAgentInterfaces.MachineGroupActionFilter): Promise;
/**
* @param {string} project - Project ID or project name
* @param {string} machineGroupName
* @param {TaskAgentInterfaces.MachineGroupActionFilter} actionFilter
*/
getDeploymentMachineGroups(project: string, machineGroupName?: string, actionFilter?: TaskAgentInterfaces.MachineGroupActionFilter): Promise;
/**
* @param {TaskAgentInterfaces.DeploymentMachineGroup} machineGroup
* @param {string} project - Project ID or project name
* @param {number} machineGroupId
*/
updateDeploymentMachineGroup(machineGroup: TaskAgentInterfaces.DeploymentMachineGroup, project: string, machineGroupId: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} machineGroupId
* @param {string[]} tagFilters
*/
getDeploymentMachineGroupMachines(project: string, machineGroupId: number, tagFilters?: string[]): Promise;
/**
* @param {TaskAgentInterfaces.DeploymentMachine[]} deploymentMachines
* @param {string} project - Project ID or project name
* @param {number} machineGroupId
*/
updateDeploymentMachineGroupMachines(deploymentMachines: TaskAgentInterfaces.DeploymentMachine[], project: string, machineGroupId: number): Promise;
/**
* @param {TaskAgentInterfaces.DeploymentMachine} machine
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId
*/
addDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId
* @param {number} machineId
*/
deleteDeploymentMachine(project: string, deploymentGroupId: number, machineId: number): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId
* @param {number} machineId
* @param {TaskAgentInterfaces.DeploymentMachineExpands} expand
*/
getDeploymentMachine(project: string, deploymentGroupId: number, machineId: number, expand?: TaskAgentInterfaces.DeploymentMachineExpands): Promise;
/**
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId
* @param {string[]} tags
* @param {string} name
* @param {TaskAgentInterfaces.DeploymentMachineExpands} expand
*/
getDeploymentMachines(project: string, deploymentGroupId: number, tags?: string[], name?: string, expand?: TaskAgentInterfaces.DeploymentMachineExpands): Promise;
/**
* @param {TaskAgentInterfaces.DeploymentMachine} machine
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId
* @param {number} machineId
*/
replaceDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise;
/**
* @param {TaskAgentInterfaces.DeploymentMachine} machine
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId
* @param {number} machineId
*/
updateDeploymentMachine(machine: TaskAgentInterfaces.DeploymentMachine, project: string, deploymentGroupId: number, machineId: number): Promise;
/**
* @param {TaskAgentInterfaces.DeploymentMachine[]} machines
* @param {string} project - Project ID or project name
* @param {number} deploymentGroupId
*/
updateDeploymentMachines(machines: TaskAgentInterfaces.DeploymentMachine[], project: string, deploymentGroupId: number): Promise;
/**
* @param {TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition} definition
* @param {number} poolId
*/
createAgentPoolMaintenanceDefinition(definition: TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition, poolId: number): Promise;
/**
* @param {number} poolId
* @param {number} definitionId
*/
deleteAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise;
/**
* @param {number} poolId
* @param {number} definitionId
*/
getAgentPoolMaintenanceDefinition(poolId: number, definitionId: number): Promise;
/**
* @param {number} poolId
*/
getAgentPoolMaintenanceDefinitions(poolId: number): Promise;
/**
* @param {TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition} definition
* @param {number} poolId
* @param {number} definitionId
*/
updateAgentPoolMaintenanceDefinition(definition: TaskAgentInterfaces.TaskAgentPoolMaintenanceDefinition, poolId: number, definitionId: number): Promise;
/**
* @param {number} poolId
* @param {number} jobId
*/
deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise;
/**
* @param {number} poolId
* @param {number} jobId
*/
getAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise;
/**
* @param {number} poolId
* @param {number} jobId
*/
getAgentPoolMaintenanceJobLogs(poolId: number, jobId: number): Promise;
/**
* @param {number} poolId
* @param {number} definitionId
*/
getAgentPoolMaintenanceJobs(poolId: number, definitionId?: number): Promise;
/**
* @param {TaskAgentInterfaces.TaskAgentPoolMaintenanceJob} job
* @param {number} poolId
*/
queueAgentPoolMaintenanceJob(job: TaskAgentInterfaces.TaskAgentPoolMaintenanceJob, poolId: number): Promise;
/**
* @param {TaskAgentInterfaces.TaskAgentPoolMaintenanceJob} job
* @param {number} poolId
* @param {number} jobId
*/
updateAgentPoolMaintenanceJob(job: TaskAgentInterfaces.TaskAgentPoolMaintenanceJob, poolId: number, jobId: number): Promise;
/**
* @param {number} poolId
* @param {number} messageId
* @param {string} sessionId
*/
deleteMessage(poolId: number, messageId: number, sessionId: string): Promise;
/**
* @param {number} poolId
* @param {string} sessionId
* @param {number} lastMessageId
*/
getMessage(poolId: number, sessionId: string, lastMessageId?: number): Promise;
/**
* @param {number} poolId
* @param {number} agentId
*/
refreshAgent(poolId: number, agentId: number): Promise;
/**
* @param {number} poolId
*/
refreshAgents(poolId: number): Promise;
/**
* @param {TaskAgentInterfaces.TaskAgentMessage} message
* @param {number} poolId
* @param {number} requestId
*/
sendMessage(message: TaskAgentInterfaces.TaskAgentMessage, poolId: number, requestId: number): Promise;
/**
* @param {string} packageType
* @param {string} platform
* @param {string} version
*/
getPackage(packageType: string, platform: string, version: string): Promise;
/**
* @param {string} packageType
* @param {string} platform
* @param {number} top
*/
getPackages(packageType: string, platform?: string, top?: number): Promise;
/**
* @param {number} poolId
*/
getAgentPoolMetadata(poolId: number): Promise;
/**
* @param {any} agentPoolMetadata
* @param {number} poolId
*/
setAgentPoolMetadata(customHeaders: any, agentPoolMetadata: any, poolId: number): Promise;
/**
* Create an agent pool.
*
* @param {TaskAgentInterfaces.TaskAgentPool} pool - Details about the new agent pool
*/
addAgentPool(pool: TaskAgentInterfaces.TaskAgentPool): Promise;
/**
* Delete an agent pool.
*
* @param {number} poolId - ID of the agent pool to delete
*/
deleteAgentPool(poolId: number): Promise;
/**
* Get information about an agent pool.
*
* @param {number} poolId - An agent pool ID
* @param {string[]} properties - Agent pool properties (comma-separated)
* @param {TaskAgentInterfaces.TaskAgentPoolActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
*/
getAgentPool(poolId: number, properties?: string[], actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise;
/**
* Get a list of agent pools.
*
* @param {string} poolName - Filter by name
* @param {string[]} properties - Filter by agent pool properties (comma-separated)
* @param {TaskAgentInterfaces.TaskAgentPoolType} poolType - Filter by pool type
* @param {TaskAgentInterfaces.TaskAgentPoolActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
*/
getAgentPools(poolName?: string, properties?: string[], poolType?: TaskAgentInterfaces.TaskAgentPoolType, actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise;
/**
* Get a list of agent pools.
*
* @param {number[]} poolIds - pool Ids to fetch
* @param {TaskAgentInterfaces.TaskAgentPoolActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
*/
getAgentPoolsByIds(poolIds: number[], actionFilter?: TaskAgentInterfaces.TaskAgentPoolActionFilter): Promise;
/**
* Update properties on an agent pool
*
* @param {TaskAgentInterfaces.TaskAgentPool} pool - Updated agent pool details
* @param {number} poolId - The agent pool to update
*/
updateAgentPool(pool: TaskAgentInterfaces.TaskAgentPool, poolId: number): Promise;
/**
* Create a new agent queue to connect a project to an agent pool.
*
* @param {TaskAgentInterfaces.TaskAgentQueue} queue - Details about the queue to create
* @param {string} project - Project ID or project name
* @param {boolean} authorizePipelines - Automatically authorize this queue when using YAML
*/
addAgentQueue(queue: TaskAgentInterfaces.TaskAgentQueue, project?: string, authorizePipelines?: boolean): Promise;
/**
* Create a new team project.
*
* @param {string} project - Project ID or project name
*/
createTeamProject(project?: string): Promise;
/**
* Removes an agent queue from a project.
*
* @param {number} queueId - The agent queue to remove
* @param {string} project - Project ID or project name
*/
deleteAgentQueue(queueId: number, project?: string): Promise;
/**
* Get information about an agent queue.
*
* @param {number} queueId - The agent queue to get information about
* @param {string} project - Project ID or project name
* @param {TaskAgentInterfaces.TaskAgentQueueActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
*/
getAgentQueue(queueId: number, project?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise;
/**
* Get a list of agent queues.
*
* @param {string} project - Project ID or project name
* @param {string} queueName - Filter on the agent queue name
* @param {TaskAgentInterfaces.TaskAgentQueueActionFilter} actionFilter - Filter by whether the calling user has use or manage permissions
*/
getAgentQueues(project?: string, queueName?: string, actionFilter?: TaskAgentInterfaces.TaskAgentQueueActionFilter): Promise