Class TaskAgentApiBase

Hierarchy (View Summary)

ClientApiBase
- TaskAgentApiBase
  - TaskAgentApi

Implements

ITaskAgentApiBase

Index

Constructors

constructor

new TaskAgentApiBase(
    baseUrl: string,
    handlers: IRequestHandler[],
    options?: IRequestOptions,
): TaskAgentApiBase
Parameters
- baseUrl: string
- handlers: IRequestHandler[]
- Optionaloptions: IRequestOptions
Returns TaskAgentApiBase
Overrides ClientApiBase.constructor
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:180

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

`Static` `Readonly`RESOURCE_AREA_ID

RESOURCE_AREA_ID: "a85b8835-c1a1-4aac-ae97-1c3d0ba72dbd"

Methods

addAgent

addAgent(agent: TaskAgent, poolId: number): Promise<TaskAgent>
Adds an agent to a pool. You probably don't want to call this endpoint directly. Instead, configure an agent using the agent download package.
Parameters
- agent: TaskAgent
  Details about the agent being added
- poolId: number
  The agent pool in which to add the agent
Returns Promise<TaskAgent>
Implementation of ITaskAgentApiBase.addAgent
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:522

addAgentCloud

addAgentCloud(agentCloud: TaskAgentCloud): Promise<TaskAgentCloud>
Parameters
- agentCloud: TaskAgentCloud
Returns Promise<TaskAgentCloud>
Implementation of ITaskAgentApiBase.addAgentCloud
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:189

addAgentPool

addAgentPool(pool: TaskAgentPool): Promise<TaskAgentPool>
Create an agent pool.
Parameters
- pool: TaskAgentPool
  Details about the new agent pool
Returns Promise<TaskAgentPool>
Implementation of ITaskAgentApiBase.addAgentPool
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4262

addAgentQueue

addAgentQueue(
    queue: TaskAgentQueue,
    project?: string,
    authorizePipelines?: boolean,
): Promise<TaskAgentQueue>
Create a new agent queue to connect a project to an agent pool.
Parameters
- queue: TaskAgentQueue
  Details about the queue to create
- Optionalproject: string
  Project ID or project name
- OptionalauthorizePipelines: boolean
  Automatically authorize this queue when using YAML
Returns Promise<TaskAgentQueue>
Implementation of ITaskAgentApiBase.addAgentQueue
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4544

addDeploymentGroup

addDeploymentGroup(
deploymentGroup: DeploymentGroupCreateParameter,
project: string,
): Promise<DeploymentGroup>
Create a deployment group.
Parameters
- deploymentGroup: DeploymentGroupCreateParameter
  Deployment group to create.
- project: string
  Project ID or project name
Returns Promise<DeploymentGroup>
Implementation of ITaskAgentApiBase.addDeploymentGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:944

addDeploymentMachine

addDeploymentMachine(
    machine: DeploymentMachine,
    project: string,
    deploymentGroupId: number,
): Promise<DeploymentMachine>
Parameters
- machine: DeploymentMachine
- project: string
  Project ID or project name
- deploymentGroupId: number
Returns Promise<DeploymentMachine>
Implementation of ITaskAgentApiBase.addDeploymentMachine
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3013

addDeploymentMachineGroup

addDeploymentMachineGroup(
machineGroup: DeploymentMachineGroup,
project: string,
): Promise<DeploymentMachineGroup>
Parameters
- machineGroup: DeploymentMachineGroup
- project: string
  Project ID or project name
Returns Promise<DeploymentMachineGroup>
Implementation of ITaskAgentApiBase.addDeploymentMachineGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2694

addDeploymentTarget

addDeploymentTarget(
    machine: DeploymentMachine,
    project: string,
    deploymentGroupId: number,
): Promise<DeploymentMachine>
Register a deployment target to a deployment group. Generally this is called by agent configuration tool.
Parameters
- machine: DeploymentMachine
  Deployment target to register.
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group to which the deployment target is registered.
Returns Promise<DeploymentMachine>
Implementation of ITaskAgentApiBase.addDeploymentTarget
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5707

addEnvironment

addEnvironment(
environmentCreateParameter: EnvironmentCreateParameter,
project: string,
): Promise<EnvironmentInstance>
Create an environment.
Parameters
- environmentCreateParameter: EnvironmentCreateParameter
  Environment to create.
- project: string
  Project ID or project name
Returns Promise<EnvironmentInstance>
Implementation of ITaskAgentApiBase.addEnvironment
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1744

addKubernetesResource

addKubernetesResource(
    createParameters: KubernetesResourceCreateParameters,
    project: string,
    environmentId: number,
): Promise<KubernetesResource>
Parameters
- createParameters: KubernetesResourceCreateParameters
- project: string
  Project ID or project name
- environmentId: number
Returns Promise<KubernetesResource>
Implementation of ITaskAgentApiBase.addKubernetesResource
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2519

addTaskGroup

addTaskGroup(
taskGroup: TaskGroupCreateParameter,
project: string,
): Promise<TaskGroup>
Create a task group.
Parameters
- taskGroup: TaskGroupCreateParameter
  Task group object to create.
- project: string
  Project ID or project name
Returns Promise<TaskGroup>
Implementation of ITaskAgentApiBase.addTaskGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6075

addVariableGroup

addVariableGroup(
variableGroupParameters: VariableGroupParameters,
): Promise<VariableGroup>
Add a variable group.
Parameters
- variableGroupParameters: VariableGroupParameters
Returns Promise<VariableGroup>
Implementation of ITaskAgentApiBase.addVariableGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6807

addVirtualMachineGroup

addVirtualMachineGroup(
    createParameters: VirtualMachineGroupCreateParameters,
    project: string,
    environmentId: number,
): Promise<VirtualMachineGroup>
Parameters
- createParameters: VirtualMachineGroupCreateParameters
- project: string
  Project ID or project name
- environmentId: number
Returns Promise<VirtualMachineGroup>
Implementation of ITaskAgentApiBase.addVirtualMachineGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:7149

createAadOAuthRequest

createAadOAuthRequest(
    tenantId: string,
    redirectUri: string,
    promptOption?: AadLoginPromptOption,
    completeCallbackPayload?: string,
    completeCallbackByAuthCode?: boolean,
): Promise<string>
Parameters
- tenantId: string
- redirectUri: string
- OptionalpromptOption: AadLoginPromptOption
- OptionalcompleteCallbackPayload: string
- OptionalcompleteCallbackByAuthCode: boolean
Returns Promise<string>
Implementation of ITaskAgentApiBase.createAadOAuthRequest
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:7440

createAcceptHeader

createAcceptHeader(type: string, apiVersion?: string): string
Parameters
- type: string
- OptionalapiVersion: string
Returns string
Implementation of ITaskAgentApiBase.createAcceptHeader
Inherited from ClientApiBase.createAcceptHeader
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:30

createAgentPoolMaintenanceDefinition

createAgentPoolMaintenanceDefinition(
definition: TaskAgentPoolMaintenanceDefinition,
poolId: number,
): Promise<TaskAgentPoolMaintenanceDefinition>
Parameters
- definition: TaskAgentPoolMaintenanceDefinition
- poolId: number
Returns Promise<TaskAgentPoolMaintenanceDefinition>
Implementation of ITaskAgentApiBase.createAgentPoolMaintenanceDefinition
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3346

createAgentSession

createAgentSession(
session: TaskAgentSession,
poolId: number,
): Promise<TaskAgentSession>
Parameters
- session: TaskAgentSession
- poolId: number
Returns Promise<TaskAgentSession>
Implementation of ITaskAgentApiBase.createAgentSession
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5621

createRequestOptions

createRequestOptions(type: string, apiVersion?: string): IRequestOptions
Parameters
- type: string
- OptionalapiVersion: string
Returns IRequestOptions
Implementation of ITaskAgentApiBase.createRequestOptions
Inherited from ClientApiBase.createRequestOptions
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:34

createTeamProject

createTeamProject(project?: string): Promise<void>
Create a new team project.
Parameters
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of ITaskAgentApiBase.createTeamProject
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4592

deleteAgent

deleteAgent(poolId: number, agentId: number): Promise<void>
Delete an agent. You probably don't want to call this endpoint directly. Instead, use the agent configuration script to remove an agent from your organization.
Parameters
- poolId: number
  The pool ID to remove the agent from
- agentId: number
  The agent ID to remove
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteAgent
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:565

deleteAgentCloud

deleteAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>
Parameters
- agentCloudId: number
Returns Promise<TaskAgentCloud>
Implementation of ITaskAgentApiBase.deleteAgentCloud
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:227

deleteAgentPool

deleteAgentPool(poolId: number): Promise<void>
Delete an agent pool.
Parameters
- poolId: number
  ID of the agent pool to delete
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteAgentPool
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4302

deleteAgentPoolMaintenanceDefinition

deleteAgentPoolMaintenanceDefinition(
poolId: number,
definitionId: number,
): Promise<void>
Parameters
- poolId: number
- definitionId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteAgentPoolMaintenanceDefinition
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3387

deleteAgentPoolMaintenanceJob

deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<void>
Parameters
- poolId: number
- jobId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteAgentPoolMaintenanceJob
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3554

deleteAgentQueue

deleteAgentQueue(queueId: number, project?: string): Promise<void>
Removes an agent queue from a project.
Parameters
- queueId: number
  The agent queue to remove
- Optionalproject: string
  Project ID or project name
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteAgentQueue
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4634

deleteAgentRequest

deleteAgentRequest(
    poolId: number,
    requestId: number,
    lockToken: string,
    result?: TaskResult,
    agentShuttingDown?: boolean,
): Promise<void>
Parameters
- poolId: number
- requestId: number
- lockToken: string
- Optionalresult: TaskResult
- OptionalagentShuttingDown: boolean
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteAgentRequest
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2111

deleteAgentSession

deleteAgentSession(poolId: number, sessionId: string): Promise<void>
Parameters
- poolId: number
- sessionId: string
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteAgentSession
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5662

deleteDeploymentGroup

deleteDeploymentGroup(project: string, deploymentGroupId: number): Promise<void>
Delete a deployment group.
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group to be deleted.
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteDeploymentGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:987

deleteDeploymentMachine

deleteDeploymentMachine(
    project: string,
    deploymentGroupId: number,
    machineId: number,
): Promise<void>
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
- machineId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteDeploymentMachine
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3057

deleteDeploymentMachineGroup

deleteDeploymentMachineGroup(
project: string,
machineGroupId: number,
): Promise<void>
Parameters
- project: string
  Project ID or project name
- machineGroupId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteDeploymentMachineGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2735

deleteDeploymentTarget

deleteDeploymentTarget(
    project: string,
    deploymentGroupId: number,
    targetId: number,
): Promise<void>
Delete a deployment target in a deployment group. This deletes the agent from associated deployment pool too.
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group in which deployment target is deleted.
- targetId: number
  ID of the deployment target to delete.
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteDeploymentTarget
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5753

deleteEnvironment

deleteEnvironment(project: string, environmentId: number): Promise<void>
Delete the specified environment.
Parameters
- project: string
  Project ID or project name
- environmentId: number
  ID of the environment.
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteEnvironment
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1787

deleteKubernetesResource

deleteKubernetesResource(
    project: string,
    environmentId: number,
    resourceId: number,
): Promise<void>
Parameters
- project: string
  Project ID or project name
- environmentId: number
- resourceId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteKubernetesResource
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2563

deleteMessage

deleteMessage(
    poolId: number,
    messageId: number,
    sessionId: string,
): Promise<void>
Parameters
- poolId: number
- messageId: number
- sessionId: string
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteMessage
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3804

deleteSecureFile

deleteSecureFile(project: string, secureFileId: string): Promise<void>
Delete a secure file
Parameters
- project: string
  Project ID or project name
- secureFileId: string
  The unique secure file Id
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteSecureFile
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5108

deleteTaskDefinition

deleteTaskDefinition(taskId: string): Promise<void>
Parameters
- taskId: string
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteTaskDefinition
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6522

deleteTaskGroup

deleteTaskGroup(
    project: string,
    taskGroupId: string,
    comment?: string,
): Promise<void>
Delete a task group.
Parameters
- project: string
  Project ID or project name
- taskGroupId: string
  Id of the task group to be deleted.
- Optionalcomment: string
  Comments to delete.
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteTaskGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6119

deleteVariableGroup

deleteVariableGroup(groupId: number, projectIds: string[]): Promise<void>
Delete a variable group
Parameters
- groupId: number
  Id of the variable group.
- projectIds: string[]
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteVariableGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6848

deleteVirtualMachineGroup

deleteVirtualMachineGroup(
    project: string,
    environmentId: number,
    resourceId: number,
): Promise<void>
Parameters
- project: string
  Project ID or project name
- environmentId: number
- resourceId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.deleteVirtualMachineGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:7193

downloadSecureFile

downloadSecureFile(
    project: string,
    secureFileId: string,
    ticket: string,
    download?: boolean,
): Promise<ReadableStream>
Download a secure file by Id
Parameters
- project: string
  Project ID or project name
- secureFileId: string
  The unique secure file Id
- ticket: string
  A valid download ticket
- Optionaldownload: boolean
  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.
Returns Promise<ReadableStream>
Implementation of ITaskAgentApiBase.downloadSecureFile
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5154

formatResponse

formatResponse(data: any, responseTypeMetadata: any, isCollection: boolean): any
Parameters
- data: any
- responseTypeMetadata: any
- isCollection: boolean
Returns any
Implementation of ITaskAgentApiBase.formatResponse
Inherited from ClientApiBase.formatResponse
- Defined in repos/azure-devops-node-api/api/ClientApiBases.ts:40

generateDeploymentGroupAccessToken

generateDeploymentGroupAccessToken(
project: string,
deploymentGroupId: number,
): Promise<string>
GET a PAT token for managing (configuring, removing, tagging) deployment targets in a deployment group.
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group in which deployment targets are managed.
Returns Promise<string>
Implementation of ITaskAgentApiBase.generateDeploymentGroupAccessToken
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:900

generateDeploymentMachineGroupAccessToken

generateDeploymentMachineGroupAccessToken(
project: string,
machineGroupId: number,
): Promise<string>
Parameters
- project: string
  Project ID or project name
- machineGroupId: number
Returns Promise<string>
Implementation of ITaskAgentApiBase.generateDeploymentMachineGroupAccessToken
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2652

generateDeploymentPoolAccessToken

generateDeploymentPoolAccessToken(poolId: number): Promise<string>
GET a PAT token for managing (configuring, removing, tagging) deployment agents in a deployment pool.
Parameters
- poolId: number
  ID of the deployment pool in which deployment agents are managed.
Returns Promise<string>
Implementation of ITaskAgentApiBase.generateDeploymentPoolAccessToken
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1396

getAgent

getAgent(
    poolId: number,
    agentId: number,
    includeCapabilities?: boolean,
    includeAssignedRequest?: boolean,
    includeLastCompletedRequest?: boolean,
    propertyFilters?: string[],
): Promise<TaskAgent>
Get information about an agent.
Parameters
- poolId: number
  The agent pool containing the agent
- agentId: number
  The agent ID to get information about
- OptionalincludeCapabilities: boolean
  Whether to include the agent's capabilities in the response
- OptionalincludeAssignedRequest: boolean
  Whether to include details about the agent's current work
- OptionalincludeLastCompletedRequest: boolean
  Whether to include details about the agents' most recent completed work
- OptionalpropertyFilters: string[]
  Filter which custom properties will be returned
Returns Promise<TaskAgent>
Implementation of ITaskAgentApiBase.getAgent
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:613

getAgentCloud

getAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>
Parameters
- agentCloudId: number
Returns Promise<TaskAgentCloud>
Implementation of ITaskAgentApiBase.getAgentCloud
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:266

getAgentCloudRequests

getAgentCloudRequests(agentCloudId: number): Promise<TaskAgentCloudRequest[]>
Parameters
- agentCloudId: number
Returns Promise<TaskAgentCloudRequest[]>
Implementation of ITaskAgentApiBase.getAgentCloudRequests
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4939

getAgentClouds

getAgentClouds(): Promise<TaskAgentCloud[]>
Returns Promise<TaskAgentCloud[]>
Implementation of ITaskAgentApiBase.getAgentClouds
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:304

getAgentCloudTypes

getAgentCloudTypes(): Promise<TaskAgentCloudType[]>
Get agent cloud types.

Returns Promise<TaskAgentCloudType[]>
Implementation of ITaskAgentApiBase.getAgentCloudTypes
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:383

getAgentPool

getAgentPool(
    poolId: number,
    properties?: string[],
    actionFilter?: TaskAgentPoolActionFilter,
): Promise<TaskAgentPool>
Get information about an agent pool.
Parameters
- poolId: number
  An agent pool ID
- Optionalproperties: string[]
  Agent pool properties (comma-separated)
- OptionalactionFilter: TaskAgentPoolActionFilter
  Filter by whether the calling user has use or manage permissions
Returns Promise<TaskAgentPool>
Implementation of ITaskAgentApiBase.getAgentPool
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4345

getAgentPoolMaintenanceDefinition

getAgentPoolMaintenanceDefinition(
poolId: number,
definitionId: number,
): Promise<TaskAgentPoolMaintenanceDefinition>
Parameters
- poolId: number
- definitionId: number
Returns Promise<TaskAgentPoolMaintenanceDefinition>
Implementation of ITaskAgentApiBase.getAgentPoolMaintenanceDefinition
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3429

getAgentPoolMaintenanceDefinitions

getAgentPoolMaintenanceDefinitions(
poolId: number,
): Promise<TaskAgentPoolMaintenanceDefinition[]>
Parameters
- poolId: number
Returns Promise<TaskAgentPoolMaintenanceDefinition[]>
Implementation of ITaskAgentApiBase.getAgentPoolMaintenanceDefinitions
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3470

getAgentPoolMaintenanceJob

getAgentPoolMaintenanceJob(
poolId: number,
jobId: number,
): Promise<TaskAgentPoolMaintenanceJob>
Parameters
- poolId: number
- jobId: number
Returns Promise<TaskAgentPoolMaintenanceJob>
Implementation of ITaskAgentApiBase.getAgentPoolMaintenanceJob
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3596

getAgentPoolMaintenanceJobLogs

getAgentPoolMaintenanceJobLogs(
poolId: number,
jobId: number,
): Promise<ReadableStream>
Parameters
- poolId: number
- jobId: number
Returns Promise<ReadableStream>
Implementation of ITaskAgentApiBase.getAgentPoolMaintenanceJobLogs
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3638

getAgentPoolMaintenanceJobs

getAgentPoolMaintenanceJobs(
poolId: number,
definitionId?: number,
): Promise<TaskAgentPoolMaintenanceJob[]>
Parameters
- poolId: number
- OptionaldefinitionId: number
Returns Promise<TaskAgentPoolMaintenanceJob[]>
Implementation of ITaskAgentApiBase.getAgentPoolMaintenanceJobs
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3672

getAgentPoolMetadata

getAgentPoolMetadata(poolId: number): Promise<ReadableStream>
Parameters
- poolId: number
Returns Promise<ReadableStream>
Implementation of ITaskAgentApiBase.getAgentPoolMetadata
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4139

getAgentPools

getAgentPools(
    poolName?: string,
    properties?: string[],
    poolType?: TaskAgentPoolType,
    actionFilter?: TaskAgentPoolActionFilter,
): Promise<TaskAgentPool[]>
Get a list of agent pools.
Parameters
- OptionalpoolName: string
  Filter by name
- Optionalproperties: string[]
  Filter by agent pool properties (comma-separated)
- OptionalpoolType: TaskAgentPoolType
  Filter by pool type
- OptionalactionFilter: TaskAgentPoolActionFilter
  Filter by whether the calling user has use or manage permissions
Returns Promise<TaskAgentPool[]>
Implementation of ITaskAgentApiBase.getAgentPools
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4397

getAgentPoolsByIds

getAgentPoolsByIds(
poolIds: number[],
actionFilter?: TaskAgentPoolActionFilter,
): Promise<TaskAgentPool[]>
Get a list of agent pools.
Parameters
- poolIds: number[]
  pool Ids to fetch
- OptionalactionFilter: TaskAgentPoolActionFilter
  Filter by whether the calling user has use or manage permissions
Returns Promise<TaskAgentPool[]>
Implementation of ITaskAgentApiBase.getAgentPoolsByIds
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4449

getAgentQueue

getAgentQueue(
    queueId: number,
    project?: string,
    actionFilter?: TaskAgentQueueActionFilter,
): Promise<TaskAgentQueue>
Get information about an agent queue.
Parameters
- queueId: number
  The agent queue to get information about
- Optionalproject: string
  Project ID or project name
- OptionalactionFilter: TaskAgentQueueActionFilter
  Filter by whether the calling user has use or manage permissions
Returns Promise<TaskAgentQueue>
Implementation of ITaskAgentApiBase.getAgentQueue
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4679

getAgentQueues

getAgentQueues(
    project?: string,
    queueName?: string,
    actionFilter?: TaskAgentQueueActionFilter,
): Promise<TaskAgentQueue[]>
Get a list of agent queues.
Parameters
- Optionalproject: string
  Project ID or project name
- OptionalqueueName: string
  Filter on the agent queue name
- OptionalactionFilter: TaskAgentQueueActionFilter
  Filter by whether the calling user has use or manage permissions
Returns Promise<TaskAgentQueue[]>
Implementation of ITaskAgentApiBase.getAgentQueues
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4730

getAgentQueuesByIds

getAgentQueuesByIds(
    queueIds: number[],
    project?: string,
    actionFilter?: TaskAgentQueueActionFilter,
): Promise<TaskAgentQueue[]>
Get a list of agent queues by their IDs
Parameters
- queueIds: number[]
  A comma-separated list of agent queue IDs to retrieve
- Optionalproject: string
  Project ID or project name
- OptionalactionFilter: TaskAgentQueueActionFilter
  Filter by whether the calling user has use or manage permissions
Returns Promise<TaskAgentQueue[]>
Implementation of ITaskAgentApiBase.getAgentQueuesByIds
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4781

getAgentQueuesByNames

getAgentQueuesByNames(
    queueNames: string[],
    project?: string,
    actionFilter?: TaskAgentQueueActionFilter,
): Promise<TaskAgentQueue[]>
Get a list of agent queues by their names
Parameters
- queueNames: string[]
  A comma-separated list of agent names to retrieve
- Optionalproject: string
  Project ID or project name
- OptionalactionFilter: TaskAgentQueueActionFilter
  Filter by whether the calling user has use or manage permissions
Returns Promise<TaskAgentQueue[]>
Implementation of ITaskAgentApiBase.getAgentQueuesByNames
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4835

getAgentQueuesForPools

getAgentQueuesForPools(
    poolIds: number[],
    project?: string,
    actionFilter?: TaskAgentQueueActionFilter,
): Promise<TaskAgentQueue[]>
Get a list of agent queues by pool ids
Parameters
- poolIds: number[]
  A comma-separated list of pool ids to get the corresponding queues for
- Optionalproject: string
  Project ID or project name
- OptionalactionFilter: TaskAgentQueueActionFilter
  Filter by whether the calling user has use or manage permissions
Returns Promise<TaskAgentQueue[]>
Implementation of ITaskAgentApiBase.getAgentQueuesForPools
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4889

getAgentRequest

getAgentRequest(
    poolId: number,
    requestId: number,
    includeStatus?: boolean,
): Promise<TaskAgentJobRequest>
Parameters
- poolId: number
- requestId: number
- OptionalincludeStatus: boolean
Returns Promise<TaskAgentJobRequest>
Implementation of ITaskAgentApiBase.getAgentRequest
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2167

getAgentRequests

getAgentRequests(
    poolId: number,
    top: number,
    continuationToken?: string,
): Promise<PagedList<TaskAgentJobRequest>>
Parameters
- poolId: number
- top: number
- OptionalcontinuationToken: string
Returns Promise<PagedList<TaskAgentJobRequest>>
Implementation of ITaskAgentApiBase.getAgentRequests
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2216

getAgentRequestsForAgent

getAgentRequestsForAgent(
    poolId: number,
    agentId: number,
    completedRequestCount?: number,
): Promise<TaskAgentJobRequest[]>
Parameters
- poolId: number
- agentId: number
- OptionalcompletedRequestCount: number
Returns Promise<TaskAgentJobRequest[]>
Implementation of ITaskAgentApiBase.getAgentRequestsForAgent
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2268

getAgentRequestsForAgents

getAgentRequestsForAgents(
    poolId: number,
    agentIds?: number[],
    completedRequestCount?: number,
): Promise<TaskAgentJobRequest[]>
Parameters
- poolId: number
- OptionalagentIds: number[]
- OptionalcompletedRequestCount: number
Returns Promise<TaskAgentJobRequest[]>
Implementation of ITaskAgentApiBase.getAgentRequestsForAgents
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2320

getAgentRequestsForDeploymentMachine

getAgentRequestsForDeploymentMachine(
    project: string,
    deploymentGroupId: number,
    machineId: number,
    completedRequestCount?: number,
): Promise<TaskAgentJobRequest[]>
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
- machineId: number
- OptionalcompletedRequestCount: number
Returns Promise<TaskAgentJobRequest[]>
Implementation of ITaskAgentApiBase.getAgentRequestsForDeploymentMachine
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1248

getAgentRequestsForDeploymentMachines

getAgentRequestsForDeploymentMachines(
    project: string,
    deploymentGroupId: number,
    machineIds?: number[],
    completedRequestCount?: number,
): Promise<TaskAgentJobRequest[]>
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
- OptionalmachineIds: number[]
- OptionalcompletedRequestCount: number
Returns Promise<TaskAgentJobRequest[]>
Implementation of ITaskAgentApiBase.getAgentRequestsForDeploymentMachines
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1303

getAgentRequestsForDeploymentTarget

getAgentRequestsForDeploymentTarget(
    project: string,
    deploymentGroupId: number,
    targetId: number,
    completedRequestCount?: number,
): Promise<TaskAgentJobRequest[]>
Get agent requests for a deployment target.
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group to which the target belongs.
- targetId: number
  ID of the deployment target.
- OptionalcompletedRequestCount: number
  Maximum number of completed requests to return. Default is 50
Returns Promise<TaskAgentJobRequest[]>
Implementation of ITaskAgentApiBase.getAgentRequestsForDeploymentTarget
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1491

getAgentRequestsForDeploymentTargets

getAgentRequestsForDeploymentTargets(
    project: string,
    deploymentGroupId: number,
    targetIds?: number[],
    ownerId?: number,
    completedOn?: Date,
    completedRequestCount?: number,
): Promise<TaskAgentJobRequest[]>
Get agent requests for a list deployment targets.
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group to which the targets belong.
- OptionaltargetIds: number[]
  Comma separated list of IDs of the deployment targets.
- OptionalownerId: number
  Id of owner of agent job request.
- OptionalcompletedOn: Date
  Datetime to return request after this time.
- OptionalcompletedRequestCount: number
  Maximum number of completed requests to return for each target. Default is 50
Returns Promise<TaskAgentJobRequest[]>
Implementation of ITaskAgentApiBase.getAgentRequestsForDeploymentTargets
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1550

getAgentRequestsForPlan

getAgentRequestsForPlan(
    poolId: number,
    planId: string,
    jobId?: string,
): Promise<TaskAgentJobRequest[]>
Parameters
- poolId: number
- planId: string
- OptionaljobId: string
Returns Promise<TaskAgentJobRequest[]>
Implementation of ITaskAgentApiBase.getAgentRequestsForPlan
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2369

getAgentRequestsForQueue

getAgentRequestsForQueue(
    project: string,
    queueId: number,
    top: number,
    continuationToken?: string,
): Promise<PagedList<TaskAgentJobRequest>>
Parameters
- project: string
  Project ID or project name
- queueId: number
- top: number
- OptionalcontinuationToken: string
Returns Promise<PagedList<TaskAgentJobRequest>>
Implementation of ITaskAgentApiBase.getAgentRequestsForQueue
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:423

getAgents

getAgents(
    poolId: number,
    agentName?: string,
    includeCapabilities?: boolean,
    includeAssignedRequest?: boolean,
    includeLastCompletedRequest?: boolean,
    propertyFilters?: string[],
    demands?: string[],
): Promise<TaskAgent[]>
Get a list of agents.
Parameters
- poolId: number
  The agent pool containing the agents
- OptionalagentName: string
  Filter on agent name
- OptionalincludeCapabilities: boolean
  Whether to include the agents' capabilities in the response
- OptionalincludeAssignedRequest: boolean
  Whether to include details about the agents' current work
- OptionalincludeLastCompletedRequest: boolean
  Whether to include details about the agents' most recent completed work
- OptionalpropertyFilters: string[]
  Filter which custom properties will be returned
- Optionaldemands: string[]
  Filter by demands the agents can satisfy
Returns Promise<TaskAgent[]>
Implementation of ITaskAgentApiBase.getAgents
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:674

getAzureManagementGroups

getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>
Returns list of azure subscriptions

Returns Promise<AzureManagementGroupQueryResult>
Implementation of ITaskAgentApiBase.getAzureManagementGroups
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:822

getAzureSubscriptions

getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>
Returns list of azure subscriptions

Returns Promise<AzureSubscriptionQueryResult>
Implementation of ITaskAgentApiBase.getAzureSubscriptions
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:860

getDeploymentGroup

getDeploymentGroup(
    project: string,
    deploymentGroupId: number,
    actionFilter?: DeploymentGroupActionFilter,
    expand?: DeploymentGroupExpands,
): Promise<DeploymentGroup>
Get a deployment group by its ID.
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group.
- OptionalactionFilter: DeploymentGroupActionFilter
  Get the deployment group only if this action can be performed on it.
- Optionalexpand: DeploymentGroupExpands
  Include these additional details in the returned object.
Returns Promise<DeploymentGroup>
Implementation of ITaskAgentApiBase.getDeploymentGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1033

getDeploymentGroups

getDeploymentGroups(
    project: string,
    name?: string,
    actionFilter?: DeploymentGroupActionFilter,
    expand?: DeploymentGroupExpands,
    continuationToken?: string,
    top?: number,
    ids?: number[],
): Promise<PagedList<DeploymentGroup>>
Get a list of deployment groups by name or IDs.
Parameters
- project: string
  Project ID or project name
- Optionalname: string
  Name of the deployment group.
- OptionalactionFilter: DeploymentGroupActionFilter
  Get only deployment groups on which this action can be performed.
- Optionalexpand: DeploymentGroupExpands
  Include these additional details in the returned objects.
- OptionalcontinuationToken: string
  Get deployment groups with names greater than this continuationToken lexicographically.
- Optionaltop: number
  Maximum number of deployment groups to return. Default is 1000.
- Optionalids: number[]
  Comma separated list of IDs of the deployment groups.
Returns Promise<PagedList<DeploymentGroup>>
Implementation of ITaskAgentApiBase.getDeploymentGroups
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1090

getDeploymentGroupsMetrics

getDeploymentGroupsMetrics(
    project: string,
    deploymentGroupName?: string,
    continuationToken?: string,
    top?: number,
): Promise<PagedList<DeploymentGroupMetrics>>
Get a list of deployment group metrics.
Parameters
- project: string
  Project ID or project name
- OptionaldeploymentGroupName: string
  Name of the deployment group.
- OptionalcontinuationToken: string
  Get metrics for deployment groups with names greater than this continuationToken lexicographically.
- Optionaltop: number
  Maximum number of deployment group metrics to return. Default is 50.
Returns Promise<PagedList<DeploymentGroupMetrics>>
Implementation of ITaskAgentApiBase.getDeploymentGroupsMetrics
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1196

getDeploymentMachine

getDeploymentMachine(
    project: string,
    deploymentGroupId: number,
    machineId: number,
    expand?: DeploymentMachineExpands,
): Promise<DeploymentMachine>
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
- machineId: number
- Optionalexpand: DeploymentMachineExpands
Returns Promise<DeploymentMachine>
Implementation of ITaskAgentApiBase.getDeploymentMachine
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3103

getDeploymentMachineGroup

getDeploymentMachineGroup(
    project: string,
    machineGroupId: number,
    actionFilter?: MachineGroupActionFilter,
): Promise<DeploymentMachineGroup>
Parameters
- project: string
  Project ID or project name
- machineGroupId: number
- OptionalactionFilter: MachineGroupActionFilter
Returns Promise<DeploymentMachineGroup>
Implementation of ITaskAgentApiBase.getDeploymentMachineGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2778

getDeploymentMachineGroupMachines

getDeploymentMachineGroupMachines(
    project: string,
    machineGroupId: number,
    tagFilters?: string[],
): Promise<DeploymentMachine[]>
Parameters
- project: string
  Project ID or project name
- machineGroupId: number
- OptionaltagFilters: string[]
Returns Promise<DeploymentMachine[]>
Implementation of ITaskAgentApiBase.getDeploymentMachineGroupMachines
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2920

getDeploymentMachineGroups

getDeploymentMachineGroups(
    project: string,
    machineGroupName?: string,
    actionFilter?: MachineGroupActionFilter,
): Promise<DeploymentMachineGroup[]>
Parameters
- project: string
  Project ID or project name
- OptionalmachineGroupName: string
- OptionalactionFilter: MachineGroupActionFilter
Returns Promise<DeploymentMachineGroup[]>
Implementation of ITaskAgentApiBase.getDeploymentMachineGroups
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2827

getDeploymentMachines

getDeploymentMachines(
    project: string,
    deploymentGroupId: number,
    tags?: string[],
    name?: string,
    expand?: DeploymentMachineExpands,
): Promise<DeploymentMachine[]>
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
- Optionaltags: string[]
- Optionalname: string
- Optionalexpand: DeploymentMachineExpands
Returns Promise<DeploymentMachine[]>
Implementation of ITaskAgentApiBase.getDeploymentMachines
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3156

getDeploymentPoolsSummary

getDeploymentPoolsSummary(
    poolName?: string,
    expands?: DeploymentPoolSummaryExpands,
    poolIds?: number[],
): Promise<DeploymentPoolSummary[]>
Get a list of deployment pool summaries.
Parameters
- OptionalpoolName: string
  Name of the deployment pool.
- Optionalexpands: DeploymentPoolSummaryExpands
  Include these additional details in the returned objects.
- OptionalpoolIds: number[]
  List of deployment pool ids.
Returns Promise<DeploymentPoolSummary[]>
Implementation of ITaskAgentApiBase.getDeploymentPoolsSummary
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1439

getDeploymentTarget

getDeploymentTarget(
    project: string,
    deploymentGroupId: number,
    targetId: number,
    expand?: DeploymentTargetExpands,
): Promise<DeploymentMachine>
Get a deployment target by its ID in a deployment group
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group to which deployment target belongs.
- targetId: number
  ID of the deployment target to return.
- Optionalexpand: DeploymentTargetExpands
  Include these additional details in the returned objects.
Returns Promise<DeploymentMachine>
Implementation of ITaskAgentApiBase.getDeploymentTarget
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5801

getDeploymentTargets

getDeploymentTargets(
    project: string,
    deploymentGroupId: number,
    tags?: string[],
    name?: string,
    partialNameMatch?: boolean,
    expand?: DeploymentTargetExpands,
    agentStatus?: TaskAgentStatusFilter,
    agentJobResult?: TaskAgentJobResultFilter,
    continuationToken?: string,
    top?: number,
    enabled?: boolean,
    propertyFilters?: string[],
): Promise<PagedList<DeploymentMachine>>
Get a list of deployment targets in a deployment group.
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group.
- Optionaltags: string[]
  Get only the deployment targets that contain all these comma separted list of tags.
- Optionalname: string
  Name pattern of the deployment targets to return.
- OptionalpartialNameMatch: boolean
  When set to true, treats name as pattern. Else treats it as absolute match. Default is false.
- Optionalexpand: DeploymentTargetExpands
  Include these additional details in the returned objects.
- OptionalagentStatus: TaskAgentStatusFilter
  Get only deployment targets that have this status.
- OptionalagentJobResult: TaskAgentJobResultFilter
  Get only deployment targets that have this last job result.
- OptionalcontinuationToken: string
  Get deployment targets with names greater than this continuationToken lexicographically.
- Optionaltop: number
  Maximum number of deployment targets to return. Default is 1000.
- Optionalenabled: boolean
  Get only deployment targets that are enabled or disabled. Default is 'null' which returns all the targets.
- OptionalpropertyFilters: string[]
Returns Promise<PagedList<DeploymentMachine>>
Implementation of ITaskAgentApiBase.getDeploymentTargets
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5863

getEnvironmentById

getEnvironmentById(
    project: string,
    environmentId: number,
    expands?: EnvironmentExpands,
): Promise<EnvironmentInstance>
Get an environment by its ID.
Parameters
- project: string
  Project ID or project name
- environmentId: number
  ID of the environment.
- Optionalexpands: EnvironmentExpands
  Include these additional details in the returned objects.
Returns Promise<EnvironmentInstance>
Implementation of ITaskAgentApiBase.getEnvironmentById
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1832

getEnvironmentDeploymentExecutionRecords

getEnvironmentDeploymentExecutionRecords(
    project: string,
    environmentId: number,
    continuationToken?: string,
    top?: number,
): Promise<PagedList<EnvironmentDeploymentExecutionRecord>>
Get environment deployment execution history
Parameters
- project: string
  Project ID or project name
- environmentId: number
- OptionalcontinuationToken: string
- Optionaltop: number
Returns Promise<PagedList<EnvironmentDeploymentExecutionRecord>>
Implementation of ITaskAgentApiBase.getEnvironmentDeploymentExecutionRecords
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1692

getEnvironments

getEnvironments(
    project: string,
    name?: string,
    continuationToken?: string,
    top?: number,
): Promise<PagedList<EnvironmentInstance>>
Get all environments.
Parameters
- project: string
  Project ID or project name
- Optionalname: string
- OptionalcontinuationToken: string
- Optionaltop: number
Returns Promise<PagedList<EnvironmentInstance>>
Implementation of ITaskAgentApiBase.getEnvironments
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1884

getKubernetesResource

getKubernetesResource(
    project: string,
    environmentId: number,
    resourceId: number,
): Promise<KubernetesResource>
Parameters
- project: string
  Project ID or project name
- environmentId: number
- resourceId: number
Returns Promise<KubernetesResource>
Implementation of ITaskAgentApiBase.getKubernetesResource
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2608

getMessage

getMessage(
    poolId: number,
    sessionId: string,
    lastMessageId?: number,
): Promise<TaskAgentMessage>
Parameters
- poolId: number
- sessionId: string
- OptionallastMessageId: number
Returns Promise<TaskAgentMessage>
Implementation of ITaskAgentApiBase.getMessage
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3856

getPackage

getPackage(
    packageType: string,
    platform: string,
    version: string,
): Promise<PackageMetadata>
Parameters
- packageType: string
- platform: string
- version: string
Returns Promise<PackageMetadata>
Implementation of ITaskAgentApiBase.getPackage
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4047

getPackages

getPackages(
    packageType: string,
    platform?: string,
    top?: number,
): Promise<PackageMetadata[]>
Parameters
- packageType: string
- Optionalplatform: string
- Optionaltop: number
Returns Promise<PackageMetadata[]>
Implementation of ITaskAgentApiBase.getPackages
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4092

getResourceLimits

getResourceLimits(): Promise<ResourceLimit[]>
Returns Promise<ResourceLimit[]>
Implementation of ITaskAgentApiBase.getResourceLimits
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4977

getResourceUsage

getResourceUsage(
    parallelismTag?: string,
    poolIsHosted?: boolean,
    includeRunningRequests?: boolean,
): Promise<ResourceUsage>
Parameters
- OptionalparallelismTag: string
- OptionalpoolIsHosted: boolean
- OptionalincludeRunningRequests: boolean
Returns Promise<ResourceUsage>
Implementation of ITaskAgentApiBase.getResourceUsage
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5016

getSecureFile

getSecureFile(
    project: string,
    secureFileId: string,
    includeDownloadTicket?: boolean,
    actionFilter?: SecureFileActionFilter,
): Promise<SecureFile>
Get a secure file
Parameters
- project: string
  Project ID or project name
- secureFileId: string
  The unique secure file Id
- OptionalincludeDownloadTicket: boolean
  If includeDownloadTicket is true and the caller has permissions, a download ticket is included in the response.
- OptionalactionFilter: SecureFileActionFilter
Returns Promise<SecureFile>
Implementation of ITaskAgentApiBase.getSecureFile
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5203

getSecureFiles

getSecureFiles(
    project: string,
    namePattern?: string,
    includeDownloadTickets?: boolean,
    actionFilter?: SecureFileActionFilter,
): Promise<SecureFile[]>
Get secure files
Parameters
- project: string
  Project ID or project name
- OptionalnamePattern: string
  Name of the secure file to match. Can include wildcards to match multiple files.
- OptionalincludeDownloadTickets: boolean
  If includeDownloadTickets is true and the caller has permissions, a download ticket for each secure file is included in the response.
- OptionalactionFilter: SecureFileActionFilter
  Filter by secure file permissions for View, Manage or Use action. Defaults to View.
Returns Promise<SecureFile[]>
Implementation of ITaskAgentApiBase.getSecureFiles
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5257

getSecureFilesByIds

getSecureFilesByIds(
    project: string,
    secureFileIds: string[],
    includeDownloadTickets?: boolean,
    actionFilter?: SecureFileActionFilter,
): Promise<SecureFile[]>
Get secure files
Parameters
- project: string
  Project ID or project name
- secureFileIds: string[]
  A list of secure file Ids
- OptionalincludeDownloadTickets: boolean
  If includeDownloadTickets is true and the caller has permissions, a download ticket for each secure file is included in the response.
- OptionalactionFilter: SecureFileActionFilter
Returns Promise<SecureFile[]>
Implementation of ITaskAgentApiBase.getSecureFilesByIds
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5311

getSecureFilesByNames

getSecureFilesByNames(
    project: string,
    secureFileNames: string[],
    includeDownloadTickets?: boolean,
    actionFilter?: SecureFileActionFilter,
): Promise<SecureFile[]>
Get secure files
Parameters
- project: string
  Project ID or project name
- secureFileNames: string[]
  A list of secure file Ids
- OptionalincludeDownloadTickets: boolean
  If includeDownloadTickets is true and the caller has permissions, a download ticket for each secure file is included in the response.
- OptionalactionFilter: SecureFileActionFilter
Returns Promise<SecureFile[]>
Implementation of ITaskAgentApiBase.getSecureFilesByNames
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5368

getTaskContentZip

getTaskContentZip(
    taskId: string,
    versionString: string,
    visibility?: string[],
    scopeLocal?: boolean,
): Promise<ReadableStream>
Parameters
- taskId: string
- versionString: string
- Optionalvisibility: string[]
- OptionalscopeLocal: boolean
Returns Promise<ReadableStream>
Implementation of ITaskAgentApiBase.getTaskContentZip
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6564

getTaskDefinition

getTaskDefinition(
    taskId: string,
    versionString: string,
    visibility?: string[],
    scopeLocal?: boolean,
): Promise<TaskDefinition>
Parameters
- taskId: string
- versionString: string
- Optionalvisibility: string[]
- OptionalscopeLocal: boolean
Returns Promise<TaskDefinition>
Implementation of ITaskAgentApiBase.getTaskDefinition
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6608

getTaskDefinitions

getTaskDefinitions(
    taskId?: string,
    visibility?: string[],
    scopeLocal?: boolean,
    allVersions?: boolean,
): Promise<TaskDefinition[]>
Parameters
- OptionaltaskId: string
- Optionalvisibility: string[]
- OptionalscopeLocal: boolean
- OptionalallVersions: boolean
Returns Promise<TaskDefinition[]>
Implementation of ITaskAgentApiBase.getTaskDefinitions
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6660

getTaskGroup

getTaskGroup(
    project: string,
    taskGroupId: string,
    versionSpec: string,
    expand?: TaskGroupExpands,
): Promise<TaskGroup>
Get task group.
Parameters
- project: string
  Project ID or project name
- taskGroupId: string
  Id of the task group.
- versionSpec: string
  version specification of the task group. examples: 1, 1.0.
- Optionalexpand: TaskGroupExpands
  The properties that should be expanded. example $expand=Tasks will expand nested task groups.
Returns Promise<TaskGroup>
Implementation of ITaskAgentApiBase.getTaskGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6171

getTaskGroupHistory

getTaskGroupHistory(
project: string,
taskGroupId: string,
): Promise<TaskGroupRevision[]>
Parameters
- project: string
  Project ID or project name
- taskGroupId: string
Returns Promise<TaskGroupRevision[]>
Implementation of ITaskAgentApiBase.getTaskGroupHistory
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5064

getTaskGroupRevision

getTaskGroupRevision(
    project: string,
    taskGroupId: string,
    revision: number,
): Promise<ReadableStream>
Parameters
- project: string
  Project ID or project name
- taskGroupId: string
- revision: number
Returns Promise<ReadableStream>
Implementation of ITaskAgentApiBase.getTaskGroupRevision
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6225

getTaskGroups

getTaskGroups(
    project: string,
    taskGroupId?: string,
    expanded?: boolean,
    taskIdFilter?: string,
    deleted?: boolean,
    top?: number,
    continuationToken?: Date,
    queryOrder?: TaskGroupQueryOrder,
): Promise<TaskGroup[]>
List task groups.
Parameters
- project: string
  Project ID or project name
- OptionaltaskGroupId: string
  Id of the task group.
- Optionalexpanded: boolean
  'true' to recursively expand task groups. Default is 'false'.
- OptionaltaskIdFilter: string
  Guid of the taskId to filter.
- Optionaldeleted: boolean
  'true'to include deleted task groups. Default is 'false'.
- Optionaltop: number
  Number of task groups to get.
- OptionalcontinuationToken: Date
  Gets the task groups after the continuation token provided.
- OptionalqueryOrder: TaskGroupQueryOrder
  Gets the results in the defined order. Default is 'CreatedOnDescending'.
Returns Promise<TaskGroup[]>
Implementation of ITaskAgentApiBase.getTaskGroups
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6276

getTaskHubLicenseDetails

getTaskHubLicenseDetails(
    hubName: string,
    includeEnterpriseUsersCount?: boolean,
    includeHostedAgentMinutesCount?: boolean,
): Promise<TaskHubLicenseDetails>
Parameters
- hubName: string
- OptionalincludeEnterpriseUsersCount: boolean
- OptionalincludeHostedAgentMinutesCount: boolean
Returns Promise<TaskHubLicenseDetails>
Implementation of ITaskAgentApiBase.getTaskHubLicenseDetails
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1981

getVariableGroup

getVariableGroup(project: string, groupId: number): Promise<VariableGroup>
Get a variable group.
Parameters
- project: string
  Project ID or project name
- groupId: number
  Id of the variable group.
Returns Promise<VariableGroup>
Implementation of ITaskAgentApiBase.getVariableGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6992

getVariableGroups

getVariableGroups(
    project: string,
    groupName?: string,
    actionFilter?: VariableGroupActionFilter,
    top?: number,
    continuationToken?: number,
    queryOrder?: VariableGroupQueryOrder,
): Promise<VariableGroup[]>
Get variable groups.
Parameters
- project: string
  Project ID or project name
- OptionalgroupName: string
  Name of variable group.
- OptionalactionFilter: VariableGroupActionFilter
  Action filter for the variable group. It specifies the action which can be performed on the variable groups.
- Optionaltop: number
  Number of variable groups to get.
- OptionalcontinuationToken: number
  Gets the variable groups after the continuation token provided.
- OptionalqueryOrder: VariableGroupQueryOrder
  Gets the results in the defined order. Default is 'IdDescending'.
Returns Promise<VariableGroup[]>
Implementation of ITaskAgentApiBase.getVariableGroups
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:7040

getVariableGroupsById

getVariableGroupsById(
    project: string,
    groupIds: number[],
    loadSecrets?: boolean,
): Promise<VariableGroup[]>
Get variable groups by ids.
Parameters
- project: string
  Project ID or project name
- groupIds: number[]
  Comma separated list of Ids of variable groups.
- OptionalloadSecrets: boolean
Returns Promise<VariableGroup[]>
Implementation of ITaskAgentApiBase.getVariableGroupsById
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:7097

getVirtualMachineGroup

getVirtualMachineGroup(
    project: string,
    environmentId: number,
    resourceId: number,
): Promise<VirtualMachineGroup>
Parameters
- project: string
  Project ID or project name
- environmentId: number
- resourceId: number
Returns Promise<VirtualMachineGroup>
Implementation of ITaskAgentApiBase.getVirtualMachineGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:7238

getVirtualMachines

getVirtualMachines(
    project: string,
    environmentId: number,
    resourceId: number,
    continuationToken?: string,
    name?: string,
    partialNameMatch?: boolean,
    tags?: string[],
    top?: number,
): Promise<PagedList<VirtualMachine>>
Parameters
- project: string
  Project ID or project name
- environmentId: number
- resourceId: number
- OptionalcontinuationToken: string
- Optionalname: string
- OptionalpartialNameMatch: boolean
- Optionaltags: string[]
- Optionaltop: number
Returns Promise<PagedList<VirtualMachine>>
Implementation of ITaskAgentApiBase.getVirtualMachines
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:7332

getVstsAadTenantId

getVstsAadTenantId(): Promise<string>
Returns Promise<string>
Implementation of ITaskAgentApiBase.getVstsAadTenantId
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:7496

getYamlSchema

getYamlSchema(validateTaskNames?: boolean): Promise<any>
GET the Yaml schema used for Yaml file validation.
Parameters
- OptionalvalidateTaskNames: boolean
  Whether the schema should validate that tasks are actually installed (useful for offline tools where you don't want validation).
Returns Promise<any>
Implementation of ITaskAgentApiBase.getYamlSchema
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:7535

hasPoolPermissions

hasPoolPermissions(poolId: number, permissions: number): Promise<boolean>
Checks if current identity has passed permissions on a pool.
Parameters
- poolId: number
  Id of the pool to check
- permissions: number
  Permissions to check. Multiple permissions might be merged into single value using bitwise OR operator (e.g. AgentPoolPermissions.Manage | AgentPoolPermissions.View)
Returns Promise<boolean>
Implementation of ITaskAgentApiBase.hasPoolPermissions
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4219

publishTaskGroup

publishTaskGroup(
    taskGroupMetadata: PublishTaskGroupMetadata,
    project: string,
    parentTaskGroupId: string,
): Promise<TaskGroup[]>
Parameters
- taskGroupMetadata: PublishTaskGroupMetadata
- project: string
  Project ID or project name
- parentTaskGroupId: string
Returns Promise<TaskGroup[]>
Implementation of ITaskAgentApiBase.publishTaskGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6335

queryEndpoint

queryEndpoint(endpoint: TaskDefinitionEndpoint): Promise<string[]>
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.
Parameters
- endpoint: TaskDefinitionEndpoint
  Describes the URL to fetch.
Returns Promise<string[]>
Implementation of ITaskAgentApiBase.queryEndpoint
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1649

querySecureFilesByProperties

querySecureFilesByProperties(
    condition: string,
    project: string,
    namePattern?: string,
): Promise<SecureFile[]>
Query secure files using a name pattern and a condition on file properties.
Parameters
- condition: string
  The main condition syntax is described here. 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' ) )
- project: string
  Project ID or project name
- OptionalnamePattern: string
  Name of the secure file to match. Can include wildcards to match multiple files.
Returns Promise<SecureFile[]>
Implementation of ITaskAgentApiBase.querySecureFilesByProperties
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5424

queueAgentPoolMaintenanceJob

queueAgentPoolMaintenanceJob(
job: TaskAgentPoolMaintenanceJob,
poolId: number,
): Promise<TaskAgentPoolMaintenanceJob>
Parameters
- job: TaskAgentPoolMaintenanceJob
- poolId: number
Returns Promise<TaskAgentPoolMaintenanceJob>
Implementation of ITaskAgentApiBase.queueAgentPoolMaintenanceJob
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3718

queueAgentRequest

queueAgentRequest(
    request: TaskAgentJobRequest,
    project: string,
    queueId: number,
): Promise<TaskAgentJobRequest>
Parameters
- request: TaskAgentJobRequest
- project: string
  Project ID or project name
- queueId: number
Returns Promise<TaskAgentJobRequest>
Implementation of ITaskAgentApiBase.queueAgentRequest
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:477

queueAgentRequestByPool

queueAgentRequestByPool(
request: TaskAgentJobRequest,
poolId: number,
): Promise<TaskAgentJobRequest>
Parameters
- request: TaskAgentJobRequest
- poolId: number
Returns Promise<TaskAgentJobRequest>
Implementation of ITaskAgentApiBase.queueAgentRequestByPool
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2420

refreshAgent

refreshAgent(poolId: number, agentId: number): Promise<void>
Parameters
- poolId: number
- agentId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.refreshAgent
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3907

refreshAgents

refreshAgents(poolId: number): Promise<void>
Parameters
- poolId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.refreshAgents
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3955

refreshDeploymentMachines

refreshDeploymentMachines(
project: string,
deploymentGroupId: number,
): Promise<void>
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.refreshDeploymentMachines
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1353

refreshDeploymentTargets

refreshDeploymentTargets(
project: string,
deploymentGroupId: number,
): Promise<void>
Upgrade the deployment targets in a deployment group.
Parameters
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group.
Returns Promise<void>
Implementation of ITaskAgentApiBase.refreshDeploymentTargets
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1606

replaceAgent

replaceAgent(
    agent: TaskAgent,
    poolId: number,
    agentId: number,
): Promise<TaskAgent>
Replace an agent. You probably don't want to call this endpoint directly. Instead, use the agent configuration script to remove and reconfigure an agent from your organization.
Parameters
- agent: TaskAgent
  Updated details about the replacing agent
- poolId: number
  The agent pool to use
- agentId: number
  The agent to replace
Returns Promise<TaskAgent>
Implementation of ITaskAgentApiBase.replaceAgent
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:733

replaceDeploymentMachine

replaceDeploymentMachine(
    machine: DeploymentMachine,
    project: string,
    deploymentGroupId: number,
    machineId: number,
): Promise<DeploymentMachine>
Parameters
- machine: DeploymentMachine
- project: string
  Project ID or project name
- deploymentGroupId: number
- machineId: number
Returns Promise<DeploymentMachine>
Implementation of ITaskAgentApiBase.replaceDeploymentMachine
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3210

replaceDeploymentTarget

replaceDeploymentTarget(
    machine: DeploymentMachine,
    project: string,
    deploymentGroupId: number,
    targetId: number,
): Promise<DeploymentMachine>
Replace a deployment target in a deployment group. Generally this is called by agent configuration tool.
Parameters
- machine: DeploymentMachine
  New deployment target.
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group in which deployment target is replaced.
- targetId: number
  ID of the deployment target to replace.
Returns Promise<DeploymentMachine>
Implementation of ITaskAgentApiBase.replaceDeploymentTarget
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5933

sendMessage

sendMessage(
    message: TaskAgentMessage,
    poolId: number,
    requestId: number,
): Promise<void>
Parameters
- message: TaskAgentMessage
- poolId: number
- requestId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.sendMessage
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3996

setAgentPoolMetadata

setAgentPoolMetadata(
    customHeaders: any,
    agentPoolMetadata: any,
    poolId: number,
): Promise<void>
Parameters
- customHeaders: any
- agentPoolMetadata: any
- poolId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.setAgentPoolMetadata
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4171

shareVariableGroup

shareVariableGroup(
variableGroupProjectReferences: VariableGroupProjectReference[],
variableGroupId: number,
): Promise<void>
Add a variable group.
Parameters
- variableGroupProjectReferences: VariableGroupProjectReference[]
- variableGroupId: number
Returns Promise<void>
Implementation of ITaskAgentApiBase.shareVariableGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6899

undeleteTaskGroup

undeleteTaskGroup(taskGroup: TaskGroup, project: string): Promise<TaskGroup[]>
Parameters
- taskGroup: TaskGroup
- project: string
  Project ID or project name
Returns Promise<TaskGroup[]>
Implementation of ITaskAgentApiBase.undeleteTaskGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6385

updateAgent

updateAgent(
    agent: TaskAgent,
    poolId: number,
    agentId: number,
): Promise<TaskAgent>
Update agent details.
Parameters
- agent: TaskAgent
  Updated details about the agent
- poolId: number
  The agent pool to use
- agentId: number
  The agent to update
Returns Promise<TaskAgent>
Implementation of ITaskAgentApiBase.updateAgent
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:779

updateAgentCloud

updateAgentCloud(
updatedCloud: TaskAgentCloud,
agentCloudId: number,
): Promise<TaskAgentCloud>
Parameters
- updatedCloud: TaskAgentCloud
- agentCloudId: number
Returns Promise<TaskAgentCloud>
Implementation of ITaskAgentApiBase.updateAgentCloud
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:342

updateAgentPool

updateAgentPool(pool: TaskAgentPool, poolId: number): Promise<TaskAgentPool>
Update properties on an agent pool
Parameters
- pool: TaskAgentPool
  Updated agent pool details
- poolId: number
  The agent pool to update
Returns Promise<TaskAgentPool>
Implementation of ITaskAgentApiBase.updateAgentPool
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:4500

updateAgentPoolMaintenanceDefinition

updateAgentPoolMaintenanceDefinition(
    definition: TaskAgentPoolMaintenanceDefinition,
    poolId: number,
    definitionId: number,
): Promise<TaskAgentPoolMaintenanceDefinition>
Parameters
- definition: TaskAgentPoolMaintenanceDefinition
- poolId: number
- definitionId: number
Returns Promise<TaskAgentPoolMaintenanceDefinition>
Implementation of ITaskAgentApiBase.updateAgentPoolMaintenanceDefinition
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3511

updateAgentPoolMaintenanceJob

updateAgentPoolMaintenanceJob(
    job: TaskAgentPoolMaintenanceJob,
    poolId: number,
    jobId: number,
): Promise<TaskAgentPoolMaintenanceJob>
Parameters
- job: TaskAgentPoolMaintenanceJob
- poolId: number
- jobId: number
Returns Promise<TaskAgentPoolMaintenanceJob>
Implementation of ITaskAgentApiBase.updateAgentPoolMaintenanceJob
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3760

updateAgentRequest

updateAgentRequest(
    request: TaskAgentJobRequest,
    poolId: number,
    requestId: number,
    lockToken: string,
    updateOptions?: TaskAgentRequestUpdateOptions,
): Promise<TaskAgentJobRequest>
Parameters
- request: TaskAgentJobRequest
- poolId: number
- requestId: number
- lockToken: string
- OptionalupdateOptions: TaskAgentRequestUpdateOptions
Returns Promise<TaskAgentJobRequest>
Implementation of ITaskAgentApiBase.updateAgentRequest
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2464

updateAgentUpdateState

updateAgentUpdateState(
    poolId: number,
    agentId: number,
    currentState: string,
): Promise<TaskAgent>
Parameters
- poolId: number
- agentId: number
- currentState: string
Returns Promise<TaskAgent>
Implementation of ITaskAgentApiBase.updateAgentUpdateState
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6711

updateAgentUserCapabilities

updateAgentUserCapabilities(
    userCapabilities: { [key: string]: string },
    poolId: number,
    agentId: number,
): Promise<TaskAgent>
Parameters
- userCapabilities: { [key: string]: string }
- poolId: number
- agentId: number
Returns Promise<TaskAgent>
Implementation of ITaskAgentApiBase.updateAgentUserCapabilities
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6763

updateDeploymentGroup

updateDeploymentGroup(
    deploymentGroup: DeploymentGroupUpdateParameter,
    project: string,
    deploymentGroupId: number,
): Promise<DeploymentGroup>
Update a deployment group.
Parameters
- deploymentGroup: DeploymentGroupUpdateParameter
  Deployment group to update.
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group.
Returns Promise<DeploymentGroup>
Implementation of ITaskAgentApiBase.updateDeploymentGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1149

updateDeploymentMachine

updateDeploymentMachine(
    machine: DeploymentMachine,
    project: string,
    deploymentGroupId: number,
    machineId: number,
): Promise<DeploymentMachine>
Parameters
- machine: DeploymentMachine
- project: string
  Project ID or project name
- deploymentGroupId: number
- machineId: number
Returns Promise<DeploymentMachine>
Implementation of ITaskAgentApiBase.updateDeploymentMachine
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3257

updateDeploymentMachineGroup

updateDeploymentMachineGroup(
    machineGroup: DeploymentMachineGroup,
    project: string,
    machineGroupId: number,
): Promise<DeploymentMachineGroup>
Parameters
- machineGroup: DeploymentMachineGroup
- project: string
  Project ID or project name
- machineGroupId: number
Returns Promise<DeploymentMachineGroup>
Implementation of ITaskAgentApiBase.updateDeploymentMachineGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2876

updateDeploymentMachineGroupMachines

updateDeploymentMachineGroupMachines(
    deploymentMachines: DeploymentMachine[],
    project: string,
    machineGroupId: number,
): Promise<DeploymentMachine[]>
Parameters
- deploymentMachines: DeploymentMachine[]
- project: string
  Project ID or project name
- machineGroupId: number
Returns Promise<DeploymentMachine[]>
Implementation of ITaskAgentApiBase.updateDeploymentMachineGroupMachines
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2969

updateDeploymentMachines

updateDeploymentMachines(
    machines: DeploymentMachine[],
    project: string,
    deploymentGroupId: number,
): Promise<DeploymentMachine[]>
Parameters
- machines: DeploymentMachine[]
- project: string
  Project ID or project name
- deploymentGroupId: number
Returns Promise<DeploymentMachine[]>
Implementation of ITaskAgentApiBase.updateDeploymentMachines
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:3303

updateDeploymentTarget

updateDeploymentTarget(
    machine: DeploymentMachine,
    project: string,
    deploymentGroupId: number,
    targetId: number,
): Promise<DeploymentMachine>
Update a deployment target and its agent properties in a deployment group. Generally this is called by agent configuration tool.
Parameters
- machine: DeploymentMachine
  Deployment target to update.
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group in which deployment target is updated.
- targetId: number
  ID of the deployment target to update.
Returns Promise<DeploymentMachine>
Implementation of ITaskAgentApiBase.updateDeploymentTarget
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5982

updateDeploymentTargets

updateDeploymentTargets(
    machines: DeploymentTargetUpdateParameter[],
    project: string,
    deploymentGroupId: number,
): Promise<DeploymentMachine[]>
Update tags of a list of deployment targets in a deployment group.
Parameters
- machines: DeploymentTargetUpdateParameter[]
  Deployment targets with tags to udpdate.
- project: string
  Project ID or project name
- deploymentGroupId: number
  ID of the deployment group in which deployment targets are updated.
Returns Promise<DeploymentMachine[]>
Implementation of ITaskAgentApiBase.updateDeploymentTargets
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6030

updateEnvironment

updateEnvironment(
    environmentUpdateParameter: EnvironmentUpdateParameter,
    project: string,
    environmentId: number,
): Promise<EnvironmentInstance>
Update the specified environment.
Parameters
- environmentUpdateParameter: EnvironmentUpdateParameter
  Environment data to update.
- project: string
  Project ID or project name
- environmentId: number
  ID of the environment.
Returns Promise<EnvironmentInstance>
Implementation of ITaskAgentApiBase.updateEnvironment
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:1937

updateSecureFile

updateSecureFile(
    secureFile: SecureFile,
    project: string,
    secureFileId: string,
): Promise<SecureFile>
Update the name or properties of an existing secure file
Parameters
- secureFile: SecureFile
  The secure file with updated name and/or properties
- project: string
  Project ID or project name
- secureFileId: string
  The unique secure file Id
Returns Promise<SecureFile>
Implementation of ITaskAgentApiBase.updateSecureFile
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5474

updateSecureFiles

updateSecureFiles(
secureFiles: SecureFile[],
project: string,
): Promise<SecureFile[]>
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.
Parameters
- secureFiles: SecureFile[]
  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.
- project: string
  Project ID or project name
Returns Promise<SecureFile[]>
Implementation of ITaskAgentApiBase.updateSecureFiles
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5519

updateTaskGroup

updateTaskGroup(
    taskGroup: TaskGroupUpdateParameter,
    project: string,
    taskGroupId?: string,
): Promise<TaskGroup>
Update a task group.
Parameters
- taskGroup: TaskGroupUpdateParameter
  Task group to update.
- project: string
  Project ID or project name
- OptionaltaskGroupId: string
  Id of the task group to update.
Returns Promise<TaskGroup>
Implementation of ITaskAgentApiBase.updateTaskGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6429

updateTaskGroupProperties

updateTaskGroupProperties(
    taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase,
    project: string,
    taskGroupId: string,
    disablePriorVersions?: boolean,
): Promise<TaskGroup[]>
Parameters
- taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase
- project: string
  Project ID or project name
- taskGroupId: string
- OptionaldisablePriorVersions: boolean
Returns Promise<TaskGroup[]>
Implementation of ITaskAgentApiBase.updateTaskGroupProperties
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6474

updateTaskHubLicenseDetails

updateTaskHubLicenseDetails(
taskHubLicenseDetails: TaskHubLicenseDetails,
hubName: string,
): Promise<TaskHubLicenseDetails>
Parameters
- taskHubLicenseDetails: TaskHubLicenseDetails
- hubName: string
Returns Promise<TaskHubLicenseDetails>
Implementation of ITaskAgentApiBase.updateTaskHubLicenseDetails
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2029

updateVariableGroup

updateVariableGroup(
variableGroupParameters: VariableGroupParameters,
groupId: number,
): Promise<VariableGroup>
Update a variable group.
Parameters
- variableGroupParameters: VariableGroupParameters
- groupId: number
  Id of the variable group to update.
Returns Promise<VariableGroup>
Implementation of ITaskAgentApiBase.updateVariableGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:6949

updateVirtualMachineGroup

updateVirtualMachineGroup(
    resource: VirtualMachineGroup,
    project: string,
    environmentId: number,
): Promise<VirtualMachineGroup>
Parameters
- resource: VirtualMachineGroup
- project: string
  Project ID or project name
- environmentId: number
Returns Promise<VirtualMachineGroup>
Implementation of ITaskAgentApiBase.updateVirtualMachineGroup
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:7283

updateVirtualMachines

updateVirtualMachines(
    machines: VirtualMachine[],
    project: string,
    environmentId: number,
    resourceId: number,
): Promise<VirtualMachine[]>
Parameters
- machines: VirtualMachine[]
- project: string
  Project ID or project name
- environmentId: number
- resourceId: number
Returns Promise<VirtualMachine[]>
Implementation of ITaskAgentApiBase.updateVirtualMachines
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:7392

uploadSecureFile

uploadSecureFile(
    customHeaders: any,
    contentStream: ReadableStream,
    project: string,
    name: string,
    authorizePipelines?: boolean,
): Promise<SecureFile>
Upload a secure file, include the file stream in the request body
Parameters
- customHeaders: any
- contentStream: ReadableStream
  Content to upload
- project: string
  Project ID or project name
- name: string
  Name of the file to upload
- OptionalauthorizePipelines: boolean
  If authorizePipelines is true, then the secure file is authorized for use by all pipelines in the project.
Returns Promise<SecureFile>
Implementation of ITaskAgentApiBase.uploadSecureFile
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:5564

validateInputs

validateInputs(
inputValidationRequest: InputValidationRequest,
): Promise<InputValidationRequest>
Parameters
- inputValidationRequest: InputValidationRequest
Returns Promise<InputValidationRequest>
Implementation of ITaskAgentApiBase.validateInputs
- Defined in repos/azure-devops-node-api/api/TaskAgentApiBase.ts:2069

Class TaskAgentApiBase

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TaskAgentApiBase

Properties

baseUrl

http

rest

userAgent

vsoClient

Static ReadonlyRESOURCE_AREA_ID

Methods

addAgent

Parameters

Returns Promise<TaskAgent>

addAgentCloud

Parameters

Returns Promise<TaskAgentCloud>

addAgentPool

Parameters

Returns Promise<TaskAgentPool>

addAgentQueue

Parameters

Returns Promise<TaskAgentQueue>

addDeploymentGroup

Parameters

Returns Promise<DeploymentGroup>

addDeploymentMachine

Parameters

Returns Promise<DeploymentMachine>

addDeploymentMachineGroup

Parameters

Returns Promise<DeploymentMachineGroup>

addDeploymentTarget

Parameters

Returns Promise<DeploymentMachine>

addEnvironment

Parameters

Returns Promise<EnvironmentInstance>

addKubernetesResource

Parameters

Returns Promise<KubernetesResource>

addTaskGroup

Parameters

Returns Promise<TaskGroup>

addVariableGroup

Parameters

Returns Promise<VariableGroup>

addVirtualMachineGroup

Parameters

Returns Promise<VirtualMachineGroup>

createAadOAuthRequest

Parameters

Returns Promise<string>

createAcceptHeader

Parameters

Returns string

createAgentPoolMaintenanceDefinition

Parameters

Returns Promise<TaskAgentPoolMaintenanceDefinition>

createAgentSession

Parameters

Returns Promise<TaskAgentSession>

createRequestOptions

Parameters

Returns IRequestOptions

createTeamProject

Parameters

Returns Promise<void>

deleteAgent

Parameters

Returns Promise<void>

deleteAgentCloud

`Static` `Readonly`RESOURCE_AREA_ID