Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BuildsApi

Hierarchy

  • BuildsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new BuildsApi(basePath?: string): BuildsApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

deleteBuild

  • deleteBuild(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

  • Deletes a build.

    Parameters

    • params: object
      • apiVersion: string
      • buildId: number
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

getBuild

  • getBuild(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Build>

  • Gets a build

    Parameters

    • params: object
      • apiVersion: string
      • buildId: number
      • organization: string
      • project: string
      • Optional propertyFilters?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Build>

getBuildChanges

  • getBuildChanges(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Change>>

  • Gets the changes associated with a build

    Parameters

    • params: object
      • Optional $Top?: number
      • apiVersion: string
      • buildId: number
      • Optional continuationToken?: string
      • Optional includeSourceChange?: boolean
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<Change>>

getBuildLog

  • getBuildLog(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<string>

  • Gets an individual log file for a build.

    Parameters

    • params: object
      • apiVersion: string
      • buildId: number
      • Optional endLine?: number
      • logId: number
      • organization: string
      • project: string
      • Optional startLine?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<string>

getBuildLogs

  • getBuildLogs(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<BuildLog>>

  • Gets the logs for a build.

    Parameters

    • params: object
      • apiVersion: string
      • buildId: number
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<BuildLog>>

getBuildWorkItemsRefs

  • getBuildWorkItemsRefs(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<ResourceRef>>

  • Gets the work items associated with a build.

    Parameters

    • params: object
      • Optional $Top?: number
      • apiVersion: string
      • buildId: number
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<ResourceRef>>

getBuildWorkItemsRefsFromCommits

  • getBuildWorkItemsRefsFromCommits(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<ResourceRef>>

  • Gets the work items associated with a build, filtered to specific commits.

    Parameters

    • params: object
      • Optional $Top?: number
      • apiVersion: string
      • body: Array<string>
      • buildId: number
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<ResourceRef>>

getBuilds

  • getBuilds(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Build>>

  • Gets a list of builds.

    Parameters

    • params: object
      • Optional $Top?: number
      • apiVersion: string
      • Optional branchName?: string
      • Optional buildIds?: string
      • Optional buildNumber?: string
      • Optional continuationToken?: string
      • Optional definitions?: string
      • Optional deletedFilter?: string
      • Optional maxBuildsPerDefinition?: number
      • Optional maxTime?: Date
      • Optional minTime?: Date
      • organization: string
      • project: string
      • Optional properties?: string
      • Optional queryOrder?: string
      • Optional queues?: string
      • Optional reasonFilter?: string
      • Optional repositoryId?: string
      • Optional repositoryType?: string
      • Optional requestedFor?: string
      • Optional resultFilter?: string
      • Optional statusFilter?: string
      • Optional tagFilters?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<Build>>

getChangesBetweenBuilds

  • getChangesBetweenBuilds(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Change>>

  • Gets the changes made to the repository between two given builds.

    Parameters

    • params: object
      • Optional $Top?: number
      • apiVersion: string
      • Optional fromBuildId?: number
      • organization: string
      • project: string
      • Optional toBuildId?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<Change>>

getWorkItemsBetweenBuilds

  • getWorkItemsBetweenBuilds(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<ResourceRef>>

  • Gets all the work items between two builds.

    Parameters

    • params: object
      • Optional $Top?: number
      • apiVersion: string
      • fromBuildId: number
      • organization: string
      • project: string
      • toBuildId: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<ResourceRef>>

queueBuild

  • queueBuild(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Build>

  • Queues a build

    Parameters

    • params: object
      • apiVersion: string
      • body: Build
      • Optional checkInTicket?: string
      • Optional ignoreWarnings?: boolean
      • organization: string
      • project: string
      • Optional sourceBuildId?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Build>

updateBuild

  • updateBuild(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Build>

  • Updates a build.

    Parameters

    • params: object
      • apiVersion: string
      • body: Build
      • buildId: number
      • organization: string
      • project: string
      • Optional retry?: boolean
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Build>

updateBuilds

  • updateBuilds(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Build>>

  • Updates multiple builds.

    Parameters

    • params: object
      • apiVersion: string
      • body: Array<Build>
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<Build>>

Generated using TypeDoc