Interface ITaskAgentApiBase

interface ITaskAgentApiBase {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    addAgent(agent: TaskAgent, poolId: number): Promise<TaskAgent>;
    addAgentCloud(agentCloud: TaskAgentCloud): Promise<TaskAgentCloud>;
    addAgentPool(pool: TaskAgentPool): Promise<TaskAgentPool>;
    addAgentQueue(
        queue: TaskAgentQueue,
        project?: string,
        authorizePipelines?: boolean,
    ): Promise<TaskAgentQueue>;
    addDeploymentGroup(
        deploymentGroup: DeploymentGroupCreateParameter,
        project: string,
    ): Promise<DeploymentGroup>;
    addDeploymentMachine(
        machine: DeploymentMachine,
        project: string,
        deploymentGroupId: number,
    ): Promise<DeploymentMachine>;
    addDeploymentMachineGroup(
        machineGroup: DeploymentMachineGroup,
        project: string,
    ): Promise<DeploymentMachineGroup>;
    addDeploymentTarget(
        machine: DeploymentMachine,
        project: string,
        deploymentGroupId: number,
    ): Promise<DeploymentMachine>;
    addEnvironment(
        environmentCreateParameter: EnvironmentCreateParameter,
        project: string,
    ): Promise<EnvironmentInstance>;
    addKubernetesResource(
        createParameters: KubernetesResourceCreateParameters,
        project: string,
        environmentId: number,
    ): Promise<KubernetesResource>;
    addTaskGroup(
        taskGroup: TaskGroupCreateParameter,
        project: string,
    ): Promise<TaskGroup>;
    addVariableGroup(
        variableGroupParameters: VariableGroupParameters,
    ): Promise<VariableGroup>;
    addVirtualMachineGroup(
        createParameters: VirtualMachineGroupCreateParameters,
        project: string,
        environmentId: number,
    ): Promise<VirtualMachineGroup>;
    createAadOAuthRequest(
        tenantId: string,
        redirectUri: string,
        promptOption?: AadLoginPromptOption,
        completeCallbackPayload?: string,
        completeCallbackByAuthCode?: boolean,
    ): Promise<string>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createAgentPoolMaintenanceDefinition(
        definition: TaskAgentPoolMaintenanceDefinition,
        poolId: number,
    ): Promise<TaskAgentPoolMaintenanceDefinition>;
    createAgentSession(
        session: TaskAgentSession,
        poolId: number,
    ): Promise<TaskAgentSession>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createTeamProject(project?: string): Promise<void>;
    deleteAgent(poolId: number, agentId: number): Promise<void>;
    deleteAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>;
    deleteAgentPool(poolId: number): Promise<void>;
    deleteAgentPoolMaintenanceDefinition(
        poolId: number,
        definitionId: number,
    ): Promise<void>;
    deleteAgentPoolMaintenanceJob(poolId: number, jobId: number): Promise<void>;
    deleteAgentQueue(queueId: number, project?: string): Promise<void>;
    deleteAgentRequest(
        poolId: number,
        requestId: number,
        lockToken: string,
        result?: TaskResult,
        agentShuttingDown?: boolean,
    ): Promise<void>;
    deleteAgentSession(poolId: number, sessionId: string): Promise<void>;
    deleteDeploymentGroup(
        project: string,
        deploymentGroupId: number,
    ): Promise<void>;
    deleteDeploymentMachine(
        project: string,
        deploymentGroupId: number,
        machineId: number,
    ): Promise<void>;
    deleteDeploymentMachineGroup(
        project: string,
        machineGroupId: number,
    ): Promise<void>;
    deleteDeploymentTarget(
        project: string,
        deploymentGroupId: number,
        targetId: number,
    ): Promise<void>;
    deleteEnvironment(project: string, environmentId: number): Promise<void>;
    deleteKubernetesResource(
        project: string,
        environmentId: number,
        resourceId: number,
    ): Promise<void>;
    deleteMessage(
        poolId: number,
        messageId: number,
        sessionId: string,
    ): Promise<void>;
    deleteSecureFile(project: string, secureFileId: string): Promise<void>;
    deleteTaskDefinition(taskId: string): Promise<void>;
    deleteTaskGroup(
        project: string,
        taskGroupId: string,
        comment?: string,
    ): Promise<void>;
    deleteVariableGroup(groupId: number, projectIds: string[]): Promise<void>;
    deleteVirtualMachineGroup(
        project: string,
        environmentId: number,
        resourceId: number,
    ): Promise<void>;
    downloadSecureFile(
        project: string,
        secureFileId: string,
        ticket: string,
        download?: boolean,
    ): Promise<ReadableStream>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    generateDeploymentGroupAccessToken(
        project: string,
        deploymentGroupId: number,
    ): Promise<string>;
    generateDeploymentMachineGroupAccessToken(
        project: string,
        machineGroupId: number,
    ): Promise<string>;
    generateDeploymentPoolAccessToken(poolId: number): Promise<string>;
    getAgent(
        poolId: number,
        agentId: number,
        includeCapabilities?: boolean,
        includeAssignedRequest?: boolean,
        includeLastCompletedRequest?: boolean,
        propertyFilters?: string[],
    ): Promise<TaskAgent>;
    getAgentCloud(agentCloudId: number): Promise<TaskAgentCloud>;
    getAgentCloudRequests(
        agentCloudId: number,
    ): Promise<TaskAgentCloudRequest[]>;
    getAgentClouds(): Promise<TaskAgentCloud[]>;
    getAgentCloudTypes(): Promise<TaskAgentCloudType[]>;
    getAgentPool(
        poolId: number,
        properties?: string[],
        actionFilter?: TaskAgentPoolActionFilter,
    ): Promise<TaskAgentPool>;
    getAgentPoolMaintenanceDefinition(
        poolId: number,
        definitionId: number,
    ): Promise<TaskAgentPoolMaintenanceDefinition>;
    getAgentPoolMaintenanceDefinitions(
        poolId: number,
    ): Promise<TaskAgentPoolMaintenanceDefinition[]>;
    getAgentPoolMaintenanceJob(
        poolId: number,
        jobId: number,
    ): Promise<TaskAgentPoolMaintenanceJob>;
    getAgentPoolMaintenanceJobLogs(
        poolId: number,
        jobId: number,
    ): Promise<ReadableStream>;
    getAgentPoolMaintenanceJobs(
        poolId: number,
        definitionId?: number,
    ): Promise<TaskAgentPoolMaintenanceJob[]>;
    getAgentPoolMetadata(poolId: number): Promise<ReadableStream>;
    getAgentPools(
        poolName?: string,
        properties?: string[],
        poolType?: TaskAgentPoolType,
        actionFilter?: TaskAgentPoolActionFilter,
    ): Promise<TaskAgentPool[]>;
    getAgentPoolsByIds(
        poolIds: number[],
        actionFilter?: TaskAgentPoolActionFilter,
    ): Promise<TaskAgentPool[]>;
    getAgentQueue(
        queueId: number,
        project?: string,
        actionFilter?: TaskAgentQueueActionFilter,
    ): Promise<TaskAgentQueue>;
    getAgentQueues(
        project?: string,
        queueName?: string,
        actionFilter?: TaskAgentQueueActionFilter,
    ): Promise<TaskAgentQueue[]>;
    getAgentQueuesByIds(
        queueIds: number[],
        project?: string,
        actionFilter?: TaskAgentQueueActionFilter,
    ): Promise<TaskAgentQueue[]>;
    getAgentQueuesByNames(
        queueNames: string[],
        project?: string,
        actionFilter?: TaskAgentQueueActionFilter,
    ): Promise<TaskAgentQueue[]>;
    getAgentQueuesForPools(
        poolIds: number[],
        project?: string,
        actionFilter?: TaskAgentQueueActionFilter,
    ): Promise<TaskAgentQueue[]>;
    getAgentRequest(
        poolId: number,
        requestId: number,
        includeStatus?: boolean,
    ): Promise<TaskAgentJobRequest>;
    getAgentRequests(
        poolId: number,
        top: number,
        continuationToken?: string,
    ): Promise<PagedList<TaskAgentJobRequest>>;
    getAgentRequestsForAgent(
        poolId: number,
        agentId: number,
        completedRequestCount?: number,
    ): Promise<TaskAgentJobRequest[]>;
    getAgentRequestsForAgents(
        poolId: number,
        agentIds?: number[],
        completedRequestCount?: number,
    ): Promise<TaskAgentJobRequest[]>;
    getAgentRequestsForDeploymentMachine(
        project: string,
        deploymentGroupId: number,
        machineId: number,
        completedRequestCount?: number,
    ): Promise<TaskAgentJobRequest[]>;
    getAgentRequestsForDeploymentMachines(
        project: string,
        deploymentGroupId: number,
        machineIds?: number[],
        completedRequestCount?: number,
    ): Promise<TaskAgentJobRequest[]>;
    getAgentRequestsForDeploymentTarget(
        project: string,
        deploymentGroupId: number,
        targetId: number,
        completedRequestCount?: number,
    ): Promise<TaskAgentJobRequest[]>;
    getAgentRequestsForDeploymentTargets(
        project: string,
        deploymentGroupId: number,
        targetIds?: number[],
        ownerId?: number,
        completedOn?: Date,
        completedRequestCount?: number,
    ): Promise<TaskAgentJobRequest[]>;
    getAgentRequestsForPlan(
        poolId: number,
        planId: string,
        jobId?: string,
    ): Promise<TaskAgentJobRequest[]>;
    getAgentRequestsForQueue(
        project: string,
        queueId: number,
        top: number,
        continuationToken?: string,
    ): Promise<PagedList<TaskAgentJobRequest>>;
    getAgents(
        poolId: number,
        agentName?: string,
        includeCapabilities?: boolean,
        includeAssignedRequest?: boolean,
        includeLastCompletedRequest?: boolean,
        propertyFilters?: string[],
        demands?: string[],
    ): Promise<TaskAgent[]>;
    getAzureManagementGroups(): Promise<AzureManagementGroupQueryResult>;
    getAzureSubscriptions(): Promise<AzureSubscriptionQueryResult>;
    getDeploymentGroup(
        project: string,
        deploymentGroupId: number,
        actionFilter?: DeploymentGroupActionFilter,
        expand?: DeploymentGroupExpands,
    ): Promise<DeploymentGroup>;
    getDeploymentGroups(
        project: string,
        name?: string,
        actionFilter?: DeploymentGroupActionFilter,
        expand?: DeploymentGroupExpands,
        continuationToken?: string,
        top?: number,
        ids?: number[],
    ): Promise<PagedList<DeploymentGroup>>;
    getDeploymentGroupsMetrics(
        project: string,
        deploymentGroupName?: string,
        continuationToken?: string,
        top?: number,
    ): Promise<PagedList<DeploymentGroupMetrics>>;
    getDeploymentMachine(
        project: string,
        deploymentGroupId: number,
        machineId: number,
        expand?: DeploymentMachineExpands,
    ): Promise<DeploymentMachine>;
    getDeploymentMachineGroup(
        project: string,
        machineGroupId: number,
        actionFilter?: MachineGroupActionFilter,
    ): Promise<DeploymentMachineGroup>;
    getDeploymentMachineGroupMachines(
        project: string,
        machineGroupId: number,
        tagFilters?: string[],
    ): Promise<DeploymentMachine[]>;
    getDeploymentMachineGroups(
        project: string,
        machineGroupName?: string,
        actionFilter?: MachineGroupActionFilter,
    ): Promise<DeploymentMachineGroup[]>;
    getDeploymentMachines(
        project: string,
        deploymentGroupId: number,
        tags?: string[],
        name?: string,
        expand?: DeploymentMachineExpands,
    ): Promise<DeploymentMachine[]>;
    getDeploymentPoolsSummary(
        poolName?: string,
        expands?: DeploymentPoolSummaryExpands,
        poolIds?: number[],
    ): Promise<DeploymentPoolSummary[]>;
    getDeploymentTarget(
        project: string,
        deploymentGroupId: number,
        targetId: number,
        expand?: DeploymentTargetExpands,
    ): Promise<DeploymentMachine>;
    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>>;
    getEnvironmentById(
        project: string,
        environmentId: number,
        expands?: EnvironmentExpands,
    ): Promise<EnvironmentInstance>;
    getEnvironmentDeploymentExecutionRecords(
        project: string,
        environmentId: number,
        continuationToken?: string,
        top?: number,
    ): Promise<PagedList<EnvironmentDeploymentExecutionRecord>>;
    getEnvironments(
        project: string,
        name?: string,
        continuationToken?: string,
        top?: number,
    ): Promise<PagedList<EnvironmentInstance>>;
    getKubernetesResource(
        project: string,
        environmentId: number,
        resourceId: number,
    ): Promise<KubernetesResource>;
    getMessage(
        poolId: number,
        sessionId: string,
        lastMessageId?: number,
    ): Promise<TaskAgentMessage>;
    getPackage(
        packageType: string,
        platform: string,
        version: string,
    ): Promise<PackageMetadata>;
    getPackages(
        packageType: string,
        platform?: string,
        top?: number,
    ): Promise<PackageMetadata[]>;
    getResourceLimits(): Promise<ResourceLimit[]>;
    getResourceUsage(
        parallelismTag?: string,
        poolIsHosted?: boolean,
        includeRunningRequests?: boolean,
    ): Promise<ResourceUsage>;
    getSecureFile(
        project: string,
        secureFileId: string,
        includeDownloadTicket?: boolean,
        actionFilter?: SecureFileActionFilter,
    ): Promise<SecureFile>;
    getSecureFiles(
        project: string,
        namePattern?: string,
        includeDownloadTickets?: boolean,
        actionFilter?: SecureFileActionFilter,
    ): Promise<SecureFile[]>;
    getSecureFilesByIds(
        project: string,
        secureFileIds: string[],
        includeDownloadTickets?: boolean,
        actionFilter?: SecureFileActionFilter,
    ): Promise<SecureFile[]>;
    getSecureFilesByNames(
        project: string,
        secureFileNames: string[],
        includeDownloadTickets?: boolean,
        actionFilter?: SecureFileActionFilter,
    ): Promise<SecureFile[]>;
    getTaskContentZip(
        taskId: string,
        versionString: string,
        visibility?: string[],
        scopeLocal?: boolean,
    ): Promise<ReadableStream>;
    getTaskDefinition(
        taskId: string,
        versionString: string,
        visibility?: string[],
        scopeLocal?: boolean,
    ): Promise<TaskDefinition>;
    getTaskDefinitions(
        taskId?: string,
        visibility?: string[],
        scopeLocal?: boolean,
        allVersions?: boolean,
    ): Promise<TaskDefinition[]>;
    getTaskGroup(
        project: string,
        taskGroupId: string,
        versionSpec: string,
        expand?: TaskGroupExpands,
    ): Promise<TaskGroup>;
    getTaskGroupHistory(
        project: string,
        taskGroupId: string,
    ): Promise<TaskGroupRevision[]>;
    getTaskGroupRevision(
        project: string,
        taskGroupId: string,
        revision: number,
    ): Promise<ReadableStream>;
    getTaskGroups(
        project: string,
        taskGroupId?: string,
        expanded?: boolean,
        taskIdFilter?: string,
        deleted?: boolean,
        top?: number,
        continuationToken?: Date,
        queryOrder?: TaskGroupQueryOrder,
    ): Promise<TaskGroup[]>;
    getTaskHubLicenseDetails(
        hubName: string,
        includeEnterpriseUsersCount?: boolean,
        includeHostedAgentMinutesCount?: boolean,
    ): Promise<TaskHubLicenseDetails>;
    getVariableGroup(project: string, groupId: number): Promise<VariableGroup>;
    getVariableGroups(
        project: string,
        groupName?: string,
        actionFilter?: VariableGroupActionFilter,
        top?: number,
        continuationToken?: number,
        queryOrder?: VariableGroupQueryOrder,
    ): Promise<VariableGroup[]>;
    getVariableGroupsById(
        project: string,
        groupIds: number[],
        loadSecrets?: boolean,
    ): Promise<VariableGroup[]>;
    getVirtualMachineGroup(
        project: string,
        environmentId: number,
        resourceId: number,
    ): Promise<VirtualMachineGroup>;
    getVirtualMachines(
        project: string,
        environmentId: number,
        resourceId: number,
        continuationToken?: string,
        name?: string,
        partialNameMatch?: boolean,
        tags?: string[],
        top?: number,
    ): Promise<PagedList<VirtualMachine>>;
    getVstsAadTenantId(): Promise<string>;
    getYamlSchema(validateTaskNames?: boolean): Promise<any>;
    hasPoolPermissions(poolId: number, permissions: number): Promise<boolean>;
    publishTaskGroup(
        taskGroupMetadata: PublishTaskGroupMetadata,
        project: string,
        parentTaskGroupId: string,
    ): Promise<TaskGroup[]>;
    queryEndpoint(endpoint: TaskDefinitionEndpoint): Promise<string[]>;
    querySecureFilesByProperties(
        condition: string,
        project: string,
        namePattern?: string,
    ): Promise<SecureFile[]>;
    queueAgentPoolMaintenanceJob(
        job: TaskAgentPoolMaintenanceJob,
        poolId: number,
    ): Promise<TaskAgentPoolMaintenanceJob>;
    queueAgentRequest(
        request: TaskAgentJobRequest,
        project: string,
        queueId: number,
    ): Promise<TaskAgentJobRequest>;
    queueAgentRequestByPool(
        request: TaskAgentJobRequest,
        poolId: number,
    ): Promise<TaskAgentJobRequest>;
    refreshAgent(poolId: number, agentId: number): Promise<void>;
    refreshAgents(poolId: number): Promise<void>;
    refreshDeploymentMachines(
        project: string,
        deploymentGroupId: number,
    ): Promise<void>;
    refreshDeploymentTargets(
        project: string,
        deploymentGroupId: number,
    ): Promise<void>;
    replaceAgent(
        agent: TaskAgent,
        poolId: number,
        agentId: number,
    ): Promise<TaskAgent>;
    replaceDeploymentMachine(
        machine: DeploymentMachine,
        project: string,
        deploymentGroupId: number,
        machineId: number,
    ): Promise<DeploymentMachine>;
    replaceDeploymentTarget(
        machine: DeploymentMachine,
        project: string,
        deploymentGroupId: number,
        targetId: number,
    ): Promise<DeploymentMachine>;
    sendMessage(
        message: TaskAgentMessage,
        poolId: number,
        requestId: number,
    ): Promise<void>;
    setAgentPoolMetadata(
        customHeaders: any,
        agentPoolMetadata: any,
        poolId: number,
    ): Promise<void>;
    shareVariableGroup(
        variableGroupProjectReferences: VariableGroupProjectReference[],
        variableGroupId: number,
    ): Promise<void>;
    undeleteTaskGroup(
        taskGroup: TaskGroup,
        project: string,
    ): Promise<TaskGroup[]>;
    updateAgent(
        agent: TaskAgent,
        poolId: number,
        agentId: number,
    ): Promise<TaskAgent>;
    updateAgentCloud(
        updatedCloud: TaskAgentCloud,
        agentCloudId: number,
    ): Promise<TaskAgentCloud>;
    updateAgentPool(
        pool: TaskAgentPool,
        poolId: number,
    ): Promise<TaskAgentPool>;
    updateAgentPoolMaintenanceDefinition(
        definition: TaskAgentPoolMaintenanceDefinition,
        poolId: number,
        definitionId: number,
    ): Promise<TaskAgentPoolMaintenanceDefinition>;
    updateAgentPoolMaintenanceJob(
        job: TaskAgentPoolMaintenanceJob,
        poolId: number,
        jobId: number,
    ): Promise<TaskAgentPoolMaintenanceJob>;
    updateAgentRequest(
        request: TaskAgentJobRequest,
        poolId: number,
        requestId: number,
        lockToken: string,
        updateOptions?: TaskAgentRequestUpdateOptions,
    ): Promise<TaskAgentJobRequest>;
    updateAgentUpdateState(
        poolId: number,
        agentId: number,
        currentState: string,
    ): Promise<TaskAgent>;
    updateAgentUserCapabilities(
        userCapabilities: { [key: string]: string },
        poolId: number,
        agentId: number,
    ): Promise<TaskAgent>;
    updateDeploymentGroup(
        deploymentGroup: DeploymentGroupUpdateParameter,
        project: string,
        deploymentGroupId: number,
    ): Promise<DeploymentGroup>;
    updateDeploymentMachine(
        machine: DeploymentMachine,
        project: string,
        deploymentGroupId: number,
        machineId: number,
    ): Promise<DeploymentMachine>;
    updateDeploymentMachineGroup(
        machineGroup: DeploymentMachineGroup,
        project: string,
        machineGroupId: number,
    ): Promise<DeploymentMachineGroup>;
    updateDeploymentMachineGroupMachines(
        deploymentMachines: DeploymentMachine[],
        project: string,
        machineGroupId: number,
    ): Promise<DeploymentMachine[]>;
    updateDeploymentMachines(
        machines: DeploymentMachine[],
        project: string,
        deploymentGroupId: number,
    ): Promise<DeploymentMachine[]>;
    updateDeploymentTarget(
        machine: DeploymentMachine,
        project: string,
        deploymentGroupId: number,
        targetId: number,
    ): Promise<DeploymentMachine>;
    updateDeploymentTargets(
        machines: DeploymentTargetUpdateParameter[],
        project: string,
        deploymentGroupId: number,
    ): Promise<DeploymentMachine[]>;
    updateEnvironment(
        environmentUpdateParameter: EnvironmentUpdateParameter,
        project: string,
        environmentId: number,
    ): Promise<EnvironmentInstance>;
    updateSecureFile(
        secureFile: SecureFile,
        project: string,
        secureFileId: string,
    ): Promise<SecureFile>;
    updateSecureFiles(
        secureFiles: SecureFile[],
        project: string,
    ): Promise<SecureFile[]>;
    updateTaskGroup(
        taskGroup: TaskGroupUpdateParameter,
        project: string,
        taskGroupId?: string,
    ): Promise<TaskGroup>;
    updateTaskGroupProperties(
        taskGroupUpdateProperties: TaskGroupUpdatePropertiesBase,
        project: string,
        taskGroupId: string,
        disablePriorVersions?: boolean,
    ): Promise<TaskGroup[]>;
    updateTaskHubLicenseDetails(
        taskHubLicenseDetails: TaskHubLicenseDetails,
        hubName: string,
    ): Promise<TaskHubLicenseDetails>;
    updateVariableGroup(
        variableGroupParameters: VariableGroupParameters,
        groupId: number,
    ): Promise<VariableGroup>;
    updateVirtualMachineGroup(
        resource: VirtualMachineGroup,
        project: string,
        environmentId: number,
    ): Promise<VirtualMachineGroup>;
    updateVirtualMachines(
        machines: VirtualMachine[],
        project: string,
        environmentId: number,
        resourceId: number,
    ): Promise<VirtualMachine[]>;
    uploadSecureFile(
        customHeaders: any,
        contentStream: ReadableStream,
        project: string,
        name: string,
        authorizePipelines?: boolean,
    ): Promise<SecureFile>;
    validateInputs(
        inputValidationRequest: InputValidationRequest,
    ): Promise<InputValidationRequest>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl http rest userAgent vsoClient

Methods

addAgent addAgentCloud addAgentPool addAgentQueue addDeploymentGroup addDeploymentMachine addDeploymentMachineGroup addDeploymentTarget addEnvironment addKubernetesResource addTaskGroup addVariableGroup addVirtualMachineGroup createAadOAuthRequest createAcceptHeader createAgentPoolMaintenanceDefinition createAgentSession createRequestOptions createTeamProject deleteAgent deleteAgentCloud deleteAgentPool deleteAgentPoolMaintenanceDefinition deleteAgentPoolMaintenanceJob deleteAgentQueue deleteAgentRequest deleteAgentSession deleteDeploymentGroup deleteDeploymentMachine deleteDeploymentMachineGroup deleteDeploymentTarget deleteEnvironment deleteKubernetesResource deleteMessage deleteSecureFile deleteTaskDefinition deleteTaskGroup deleteVariableGroup deleteVirtualMachineGroup downloadSecureFile formatResponse generateDeploymentGroupAccessToken generateDeploymentMachineGroupAccessToken generateDeploymentPoolAccessToken getAgent getAgentCloud getAgentCloudRequests getAgentClouds getAgentCloudTypes getAgentPool getAgentPoolMaintenanceDefinition getAgentPoolMaintenanceDefinitions getAgentPoolMaintenanceJob getAgentPoolMaintenanceJobLogs getAgentPoolMaintenanceJobs getAgentPoolMetadata getAgentPools getAgentPoolsByIds getAgentQueue getAgentQueues getAgentQueuesByIds getAgentQueuesByNames getAgentQueuesForPools getAgentRequest getAgentRequests getAgentRequestsForAgent getAgentRequestsForAgents getAgentRequestsForDeploymentMachine getAgentRequestsForDeploymentMachines getAgentRequestsForDeploymentTarget getAgentRequestsForDeploymentTargets getAgentRequestsForPlan getAgentRequestsForQueue getAgents getAzureManagementGroups getAzureSubscriptions getDeploymentGroup getDeploymentGroups getDeploymentGroupsMetrics getDeploymentMachine getDeploymentMachineGroup getDeploymentMachineGroupMachines getDeploymentMachineGroups getDeploymentMachines getDeploymentPoolsSummary getDeploymentTarget getDeploymentTargets getEnvironmentById getEnvironmentDeploymentExecutionRecords getEnvironments getKubernetesResource getMessage getPackage getPackages getResourceLimits getResourceUsage getSecureFile getSecureFiles getSecureFilesByIds getSecureFilesByNames getTaskContentZip getTaskDefinition getTaskDefinitions getTaskGroup getTaskGroupHistory getTaskGroupRevision getTaskGroups getTaskHubLicenseDetails getVariableGroup getVariableGroups getVariableGroupsById getVirtualMachineGroup getVirtualMachines getVstsAadTenantId getYamlSchema hasPoolPermissions publishTaskGroup queryEndpoint querySecureFilesByProperties queueAgentPoolMaintenanceJob queueAgentRequest queueAgentRequestByPool refreshAgent refreshAgents refreshDeploymentMachines refreshDeploymentTargets replaceAgent replaceDeploymentMachine replaceDeploymentTarget sendMessage setAgentPoolMetadata shareVariableGroup undeleteTaskGroup updateAgent updateAgentCloud updateAgentPool updateAgentPoolMaintenanceDefinition updateAgentPoolMaintenanceJob updateAgentRequest updateAgentUpdateState updateAgentUserCapabilities updateDeploymentGroup updateDeploymentMachine updateDeploymentMachineGroup updateDeploymentMachineGroupMachines updateDeploymentMachines updateDeploymentTarget updateDeploymentTargets updateEnvironment updateSecureFile updateSecureFiles updateTaskGroup updateTaskGroupProperties updateTaskHubLicenseDetails updateVariableGroup updateVirtualMachineGroup updateVirtualMachines uploadSecureFile validateInputs

Properties

baseUrl

baseUrl: string

http

http: HttpClient

rest

rest: RestClient

userAgent

userAgent: string

vsoClient

vsoClient: VsoClient

Methods

addAgent

addAgentCloud

addAgentPool

addAgentQueue

addDeploymentGroup

addDeploymentMachine

addDeploymentMachineGroup

addDeploymentTarget

addEnvironment

addKubernetesResource

addTaskGroup

addVariableGroup

addVirtualMachineGroup

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>

createAcceptHeader

createAgentPoolMaintenanceDefinition

createAgentSession

createRequestOptions

createTeamProject

deleteAgent

deleteAgentCloud

deleteAgentPool

deleteAgentPoolMaintenanceDefinition

deleteAgentPoolMaintenanceJob

deleteAgentQueue

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>

deleteAgentSession

deleteDeploymentGroup

deleteDeploymentMachine

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

    Parameters

    • project: string
    • deploymentGroupId: number
    • machineId: number

    Returns Promise<void>

deleteDeploymentMachineGroup

deleteDeploymentTarget

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

    Parameters

    • project: string
    • deploymentGroupId: number
    • targetId: number

    Returns Promise<void>

deleteEnvironment

deleteKubernetesResource

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

    Parameters

    • project: string
    • environmentId: number
    • resourceId: number

    Returns Promise<void>

deleteMessage

deleteSecureFile

deleteTaskDefinition

deleteTaskGroup

deleteVariableGroup

deleteVirtualMachineGroup

downloadSecureFile

  • downloadSecureFile(
        project: string,
        secureFileId: string,
        ticket: string,
        download?: boolean,
    ): Promise<ReadableStream>

    Parameters

    • project: string
    • secureFileId: string
    • ticket: string
    • Optionaldownload: boolean

    Returns Promise<ReadableStream>

formatResponse

generateDeploymentGroupAccessToken

generateDeploymentMachineGroupAccessToken

generateDeploymentPoolAccessToken

getAgent

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

    Parameters

    • poolId: number
    • agentId: number
    • OptionalincludeCapabilities: boolean
    • OptionalincludeAssignedRequest: boolean
    • OptionalincludeLastCompletedRequest: boolean
    • OptionalpropertyFilters: string[]

    Returns Promise<TaskAgent>

getAgentCloud

getAgentCloudRequests

getAgentClouds

getAgentCloudTypes

getAgentPool

getAgentPoolMaintenanceDefinition

getAgentPoolMaintenanceDefinitions

getAgentPoolMaintenanceJob

getAgentPoolMaintenanceJobLogs

getAgentPoolMaintenanceJobs

getAgentPoolMetadata

getAgentPools

getAgentPoolsByIds

getAgentQueue

getAgentQueues

getAgentQueuesByIds

getAgentQueuesByNames

getAgentQueuesForPools

getAgentRequest

getAgentRequests

getAgentRequestsForAgent

getAgentRequestsForAgents

getAgentRequestsForDeploymentMachine

getAgentRequestsForDeploymentMachines

getAgentRequestsForDeploymentTarget

getAgentRequestsForDeploymentTargets

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

    Parameters

    • project: string
    • deploymentGroupId: number
    • OptionaltargetIds: number[]
    • OptionalownerId: number
    • OptionalcompletedOn: Date
    • OptionalcompletedRequestCount: number

    Returns Promise<TaskAgentJobRequest[]>

getAgentRequestsForPlan

getAgentRequestsForQueue

getAgents

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

    Parameters

    • poolId: number
    • OptionalagentName: string
    • OptionalincludeCapabilities: boolean
    • OptionalincludeAssignedRequest: boolean
    • OptionalincludeLastCompletedRequest: boolean
    • OptionalpropertyFilters: string[]
    • Optionaldemands: string[]

    Returns Promise<TaskAgent[]>

getAzureManagementGroups

getAzureSubscriptions

getDeploymentGroup

getDeploymentGroups

getDeploymentGroupsMetrics

getDeploymentMachine

getDeploymentMachineGroup

getDeploymentMachineGroupMachines

getDeploymentMachineGroups

getDeploymentMachines

getDeploymentPoolsSummary

getDeploymentTarget

getDeploymentTargets

getEnvironmentById

getEnvironmentDeploymentExecutionRecords

getEnvironments

getKubernetesResource

getMessage

getPackage

getPackages

getResourceLimits

getResourceUsage

getSecureFile

getSecureFiles

getSecureFilesByIds

getSecureFilesByNames

getTaskContentZip

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

    Parameters

    • taskId: string
    • versionString: string
    • Optionalvisibility: string[]
    • OptionalscopeLocal: boolean

    Returns Promise<ReadableStream>

getTaskDefinition

getTaskDefinitions

getTaskGroup

getTaskGroupHistory

getTaskGroupRevision

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

    Parameters

    • project: string
    • taskGroupId: string
    • revision: number

    Returns Promise<ReadableStream>

getTaskGroups

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

    Parameters

    • project: string
    • OptionaltaskGroupId: string
    • Optionalexpanded: boolean
    • OptionaltaskIdFilter: string
    • Optionaldeleted: boolean
    • Optionaltop: number
    • OptionalcontinuationToken: Date
    • OptionalqueryOrder: TaskGroupQueryOrder

    Returns Promise<TaskGroup[]>

getTaskHubLicenseDetails

getVariableGroup

getVariableGroups

getVariableGroupsById

getVirtualMachineGroup

getVirtualMachines

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

    Parameters

    • project: string
    • environmentId: number
    • resourceId: number
    • OptionalcontinuationToken: string
    • Optionalname: string
    • OptionalpartialNameMatch: boolean
    • Optionaltags: string[]
    • Optionaltop: number

    Returns Promise<PagedList<VirtualMachine>>

getVstsAadTenantId

getYamlSchema

hasPoolPermissions

publishTaskGroup

queryEndpoint

querySecureFilesByProperties

queueAgentPoolMaintenanceJob

queueAgentRequest

queueAgentRequestByPool

refreshAgent

refreshAgents

refreshDeploymentMachines

refreshDeploymentTargets

replaceAgent

replaceDeploymentMachine

replaceDeploymentTarget

sendMessage

setAgentPoolMetadata

shareVariableGroup

undeleteTaskGroup

updateAgent

updateAgentCloud

updateAgentPool

updateAgentPoolMaintenanceDefinition

updateAgentPoolMaintenanceJob

updateAgentRequest

updateAgentUpdateState

updateAgentUserCapabilities

updateDeploymentGroup

updateDeploymentMachine

updateDeploymentMachineGroup

updateDeploymentMachineGroupMachines

updateDeploymentMachines

updateDeploymentTarget

updateDeploymentTargets

updateEnvironment

updateSecureFile

updateSecureFiles

updateTaskGroup

updateTaskGroupProperties

updateTaskHubLicenseDetails

updateVariableGroup

updateVirtualMachineGroup

updateVirtualMachines

uploadSecureFile

  • uploadSecureFile(
        customHeaders: any,
        contentStream: ReadableStream,
        project: string,
        name: string,
        authorizePipelines?: boolean,
    ): Promise<SecureFile>

    Parameters

    • customHeaders: any
    • contentStream: ReadableStream
    • project: string
    • name: string
    • OptionalauthorizePipelines: boolean

    Returns Promise<SecureFile>

validateInputs

Settings

Member Visibility

On This Page

Properties
Methods
addAgentaddAgentCloudaddAgentPooladdAgentQueueaddDeploymentGroupaddDeploymentMachineaddDeploymentMachineGroupaddDeploymentTargetaddEnvironmentaddKubernetesResourceaddTaskGroupaddVariableGroupaddVirtualMachineGroupcreateAadOAuthRequestcreateAcceptHeadercreateAgentPoolMaintenanceDefinitioncreateAgentSessioncreateRequestOptionscreateTeamProjectdeleteAgentdeleteAgentClouddeleteAgentPooldeleteAgentPoolMaintenanceDefinitiondeleteAgentPoolMaintenanceJobdeleteAgentQueuedeleteAgentRequestdeleteAgentSessiondeleteDeploymentGroupdeleteDeploymentMachinedeleteDeploymentMachineGroupdeleteDeploymentTargetdeleteEnvironmentdeleteKubernetesResourcedeleteMessagedeleteSecureFiledeleteTaskDefinitiondeleteTaskGroupdeleteVariableGroupdeleteVirtualMachineGroupdownloadSecureFileformatResponsegenerateDeploymentGroupAccessTokengenerateDeploymentMachineGroupAccessTokengenerateDeploymentPoolAccessTokengetAgentgetAgentCloudgetAgentCloudRequestsgetAgentCloudsgetAgentCloudTypesgetAgentPoolgetAgentPoolMaintenanceDefinitiongetAgentPoolMaintenanceDefinitionsgetAgentPoolMaintenanceJobgetAgentPoolMaintenanceJobLogsgetAgentPoolMaintenanceJobsgetAgentPoolMetadatagetAgentPoolsgetAgentPoolsByIdsgetAgentQueuegetAgentQueuesgetAgentQueuesByIdsgetAgentQueuesByNamesgetAgentQueuesForPoolsgetAgentRequestgetAgentRequestsgetAgentRequestsForAgentgetAgentRequestsForAgentsgetAgentRequestsForDeploymentMachinegetAgentRequestsForDeploymentMachinesgetAgentRequestsForDeploymentTargetgetAgentRequestsForDeploymentTargetsgetAgentRequestsForPlangetAgentRequestsForQueuegetAgentsgetAzureManagementGroupsgetAzureSubscriptionsgetDeploymentGroupgetDeploymentGroupsgetDeploymentGroupsMetricsgetDeploymentMachinegetDeploymentMachineGroupgetDeploymentMachineGroupMachinesgetDeploymentMachineGroupsgetDeploymentMachinesgetDeploymentPoolsSummarygetDeploymentTargetgetDeploymentTargetsgetEnvironmentByIdgetEnvironmentDeploymentExecutionRecordsgetEnvironmentsgetKubernetesResourcegetMessagegetPackagegetPackagesgetResourceLimitsgetResourceUsagegetSecureFilegetSecureFilesgetSecureFilesByIdsgetSecureFilesByNamesgetTaskContentZipgetTaskDefinitiongetTaskDefinitionsgetTaskGroupgetTaskGroupHistorygetTaskGroupRevisiongetTaskGroupsgetTaskHubLicenseDetailsgetVariableGroupgetVariableGroupsgetVariableGroupsByIdgetVirtualMachineGroupgetVirtualMachinesgetVstsAadTenantIdgetYamlSchemahasPoolPermissionspublishTaskGroupqueryEndpointquerySecureFilesByPropertiesqueueAgentPoolMaintenanceJobqueueAgentRequestqueueAgentRequestByPoolrefreshAgentrefreshAgentsrefreshDeploymentMachinesrefreshDeploymentTargetsreplaceAgentreplaceDeploymentMachinereplaceDeploymentTargetsendMessagesetAgentPoolMetadatashareVariableGroupundeleteTaskGroupupdateAgentupdateAgentCloudupdateAgentPoolupdateAgentPoolMaintenanceDefinitionupdateAgentPoolMaintenanceJobupdateAgentRequestupdateAgentUpdateStateupdateAgentUserCapabilitiesupdateDeploymentGroupupdateDeploymentMachineupdateDeploymentMachineGroupupdateDeploymentMachineGroupMachinesupdateDeploymentMachinesupdateDeploymentTargetupdateDeploymentTargetsupdateEnvironmentupdateSecureFileupdateSecureFilesupdateTaskGroupupdateTaskGroupPropertiesupdateTaskHubLicenseDetailsupdateVariableGroupupdateVirtualMachineGroupupdateVirtualMachinesuploadSecureFilevalidateInputs