Class BuildApi

constructor

• new BuildApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): BuildApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns BuildApi

Static ReadonlyRESOURCE_AREA_ID

addBuildTag

• addBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

  Adds a tag to a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • tag: string

    The tag to add.

  Returns Promise<string[]>

addBuildTags

• addBuildTags(
      tags: string[],
      project: string,
      buildId: number,
  ): Promise<string[]>

  Adds tags to a build.

  Parameters

  • tags: string[]

    The tags to add. Request body is composed directly from listed tags.
  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.

  Returns Promise<string[]>

addDefinitionTag

• addDefinitionTag(
      project: string,
      definitionId: number,
      tag: string,
  ): Promise<string[]>

  Adds a tag to a definition

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    The ID of the definition.
  • tag: string

    The tag to add.

  Returns Promise<string[]>

addDefinitionTags

• addDefinitionTags(
      tags: string[],
      project: string,
      definitionId: number,
  ): Promise<string[]>

  Adds multiple tags to a definition.

  Parameters

  • tags: string[]

    The tags to add.
  • project: string

    Project ID or project name
  • definitionId: number

    The ID of the definition.

  Returns Promise<string[]>

addRetentionLeases

• addRetentionLeases(
      newLeases: NewRetentionLease[],
      project: string,
  ): Promise<RetentionLease[]>

  Adds new leases for pipeline runs.

  Parameters

  • newLeases: NewRetentionLease[]
  • project: string

    Project ID or project name

  Returns Promise<RetentionLease[]>

authorizeDefinitionResources

• authorizeDefinitionResources(
      resources: DefinitionResourceReference[],
      project: string,
      definitionId: number,
  ): Promise<DefinitionResourceReference[]>

  Parameters

  • resources: DefinitionResourceReference[]
  • project: string

    Project ID or project name
  • definitionId: number

  Returns Promise<DefinitionResourceReference[]>

authorizeProjectResources

• authorizeProjectResources(
      resources: DefinitionResourceReference[],
      project: string,
  ): Promise<DefinitionResourceReference[]>

  Parameters

  • resources: DefinitionResourceReference[]
  • project: string

    Project ID or project name

  Returns Promise<DefinitionResourceReference[]>

createArtifact

• createArtifact(
      artifact: BuildArtifact,
      project: string,
      buildId: number,
  ): Promise<BuildArtifact>

  Associates an artifact with a build.

  Parameters

  • artifact: BuildArtifact

    The artifact.
  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.

  Returns Promise<BuildArtifact>

createDefinition

• createDefinition(
      definition: BuildDefinition,
      project: string,
      definitionToCloneId?: number,
      definitionToCloneRevision?: number,
  ): Promise<BuildDefinition>

  Creates a new definition.

  Parameters

  • definition: BuildDefinition

    The definition.
  • project: string

    Project ID or project name
  • OptionaldefinitionToCloneId: number
  • OptionaldefinitionToCloneRevision: number

  Returns Promise<BuildDefinition>

createFolder

• createFolder(folder: Folder, project: string, path: string): Promise<Folder>

  Creates a new folder.

  Parameters

  • folder: Folder

    The folder.
  • project: string

    Project ID or project name
  • path: string

    The full path of the folder.

  Returns Promise<Folder>

deleteBuild

• deleteBuild(project: string, buildId: number): Promise<void>

  Deletes a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.

  Returns Promise<void>

deleteBuildTag

• deleteBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

  Removes a tag from a build. NOTE: This API will not work for tags with special characters. To remove tags with special characters, use the PATCH method instead (in 6.0+)

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • tag: string

    The tag to remove.

  Returns Promise<string[]>

deleteDefinition

• deleteDefinition(project: string, definitionId: number): Promise<void>

  Deletes a definition and all associated builds.

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    The ID of the definition.

  Returns Promise<void>

deleteDefinitionTag

• deleteDefinitionTag(
      project: string,
      definitionId: number,
      tag: string,
  ): Promise<string[]>

  Removes a tag from a definition. NOTE: This API will not work for tags with special characters. To remove tags with special characters, use the PATCH method instead (in 6.0+)

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    The ID of the definition.
  • tag: string

    The tag to remove.

  Returns Promise<string[]>

deleteFolder

• deleteFolder(project: string, path: string): Promise<void>

  Deletes a definition folder. Definitions and their corresponding builds will also be deleted.

  Parameters

  • project: string

    Project ID or project name
  • path: string

    The full path to the folder.

  Returns Promise<void>

deleteRetentionLeasesById

• deleteRetentionLeasesById(project: string, ids: number[]): Promise<void>

  Removes specific retention leases.

  Parameters

  • project: string

    Project ID or project name
  • ids: number[]

  Returns Promise<void>

deleteTag

• deleteTag(project: string, tag: string): Promise<string[]>

  Removes a tag from builds, definitions, and from the tag store

  Parameters

  • project: string

    Project ID or project name
  • tag: string

    The tag to remove.

  Returns Promise<string[]>

deleteTemplate

• deleteTemplate(project: string, templateId: string): Promise<void>

  Deletes a build definition template.

  Parameters

  • project: string

    Project ID or project name
  • templateId: string

    The ID of the template.

  Returns Promise<void>

getArtifact

• getArtifact(
      project: string,
      buildId: number,
      artifactName: string,
  ): Promise<BuildArtifact>

  Gets a specific artifact for a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • artifactName: string

    The name of the artifact.

  Returns Promise<BuildArtifact>

getArtifactContentZip

• getArtifactContentZip(
      project: string,
      buildId: number,
      artifactName: string,
  ): Promise<ReadableStream>

  Gets a specific artifact for a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • artifactName: string

    The name of the artifact.

  Returns Promise<ReadableStream>

getArtifacts

• getArtifacts(project: string, buildId: number): Promise<BuildArtifact[]>

  Gets all artifacts for a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.

  Returns Promise<BuildArtifact[]>

getAttachment

• getAttachment(
      project: string,
      buildId: number,
      timelineId: string,
      recordId: string,
      type: string,
      name: string,
  ): Promise<ReadableStream>

  Gets a specific attachment.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • timelineId: string

    The ID of the timeline.
  • recordId: string

    The ID of the timeline record.
  • type: string

    The type of the attachment.
  • name: string

    The name of the attachment.

  Returns Promise<ReadableStream>

getAttachments

• getAttachments(
      project: string,
      buildId: number,
      type: string,
  ): Promise<Attachment[]>

  Gets the list of attachments of a specific type that are associated with a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • type: string

    The type of attachment.

  Returns Promise<Attachment[]>

getBadge

• getBadge(
      project: string,
      definitionId: number,
      branchName?: string,
  ): Promise<string>

  Gets a badge that indicates the status of the most recent build for a definition. Note that this API is deprecated. Prefer StatusBadgeController.GetStatusBadge.

  Parameters

  • project: string

    The project ID or name.
  • definitionId: number

    The ID of the definition.
  • OptionalbranchName: string

    The name of the branch.

  Returns Promise<string>

getBuild

• getBuild(
      project: string,
      buildId: number,
      propertyFilters?: string,
  ): Promise<Build>

  Gets a build

  Parameters

  • project: string

    Project ID or project name
  • buildId: number
  • OptionalpropertyFilters: string

  Returns Promise<Build>

getBuildBadge

• getBuildBadge(
      project: string,
      repoType: string,
      repoId?: string,
      branchName?: string,
  ): Promise<BuildBadge>

  Gets a badge that indicates the status of the most recent build for the specified branch.

  Parameters

  • project: string

    Project ID or project name
  • repoType: string

    The repository type.
  • OptionalrepoId: string

    The repository ID.
  • OptionalbranchName: string

    The branch name.

  Returns Promise<BuildBadge>

getBuildBadgeData

• getBuildBadgeData(
      project: string,
      repoType: string,
      repoId?: string,
      branchName?: string,
  ): Promise<string>

  Gets a badge that indicates the status of the most recent build for the specified branch.

  Parameters

  • project: string

    Project ID or project name
  • repoType: string

    The repository type.
  • OptionalrepoId: string

    The repository ID.
  • OptionalbranchName: string

    The branch name.

  Returns Promise<string>

getBuildChanges

• getBuildChanges(
      project: string,
      buildId: number,
      continuationToken?: string,
      top?: number,
      includeSourceChange?: boolean,
  ): Promise<PagedList<Change>>

  Gets the changes associated with a build

  Parameters

  • project: string

    Project ID or project name
  • buildId: number
  • OptionalcontinuationToken: string
  • Optionaltop: number

    The maximum number of changes to return
  • OptionalincludeSourceChange: boolean

  Returns Promise<PagedList<Change>>

getBuildController

• getBuildController(controllerId: number): Promise<BuildController>

  Gets a controller

  Parameters

  • controllerId: number

  Returns Promise<BuildController>

getBuildControllers

• getBuildControllers(name?: string): Promise<BuildController[]>

  Gets controller, optionally filtered by name

  Parameters

  • Optionalname: string

  Returns Promise<BuildController[]>

getBuildGeneralSettings

• getBuildGeneralSettings(project: string): Promise<PipelineGeneralSettings>

  Gets pipeline general settings.

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<PipelineGeneralSettings>

getBuildLog

• getBuildLog(
      project: string,
      buildId: number,
      logId: number,
      startLine?: number,
      endLine?: number,
  ): Promise<ReadableStream>

  Gets an individual log file for a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • logId: number

    The ID of the log file.
  • OptionalstartLine: number

    The start line.
  • OptionalendLine: number

    The end line.

  Returns Promise<ReadableStream>

getBuildLogLines

• getBuildLogLines(
      project: string,
      buildId: number,
      logId: number,
      startLine?: number,
      endLine?: number,
  ): Promise<string[]>

  Gets an individual log file for a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • logId: number

    The ID of the log file.
  • OptionalstartLine: number

    The start line.
  • OptionalendLine: number

    The end line.

  Returns Promise<string[]>

getBuildLogs

• getBuildLogs(project: string, buildId: number): Promise<BuildLog[]>

  Gets the logs for a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.

  Returns Promise<BuildLog[]>

getBuildLogsZip

• getBuildLogsZip(project: string, buildId: number): Promise<ReadableStream>

  Gets the logs for a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.

  Returns Promise<ReadableStream>

getBuildLogZip

• getBuildLogZip(
      project: string,
      buildId: number,
      logId: number,
      startLine?: number,
      endLine?: number,
  ): Promise<ReadableStream>

  Gets an individual log file for a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • logId: number

    The ID of the log file.
  • OptionalstartLine: number

    The start line.
  • OptionalendLine: number

    The end line.

  Returns Promise<ReadableStream>

getBuildOptionDefinitions

• getBuildOptionDefinitions(project?: string): Promise<BuildOptionDefinition[]>

  Gets all build definition options supported by the system.

  Parameters

  • Optionalproject: string

    Project ID or project name

  Returns Promise<BuildOptionDefinition[]>

getBuildProperties

• getBuildProperties(
      project: string,
      buildId: number,
      filter?: string[],
  ): Promise<any>

  Gets properties for a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • Optionalfilter: string[]

    A comma-delimited list of properties. If specified, filters to these specific properties.

  Returns Promise<any>

getBuildReport

• getBuildReport(
      project: string,
      buildId: number,
      type?: string,
  ): Promise<BuildReportMetadata>

  Gets a build report.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • Optionaltype: string

  Returns Promise<BuildReportMetadata>

getBuildReportHtmlContent

• getBuildReportHtmlContent(
      project: string,
      buildId: number,
      type?: string,
  ): Promise<ReadableStream>

  Gets a build report.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • Optionaltype: string

  Returns Promise<ReadableStream>

getBuilds

• getBuilds(
      project: string,
      definitions?: number[],
      queues?: number[],
      buildNumber?: string,
      minTime?: Date,
      maxTime?: Date,
      requestedFor?: string,
      reasonFilter?: BuildReason,
      statusFilter?: BuildStatus,
      resultFilter?: BuildResult,
      tagFilters?: string[],
      properties?: string[],
      top?: number,
      continuationToken?: string,
      maxBuildsPerDefinition?: number,
      deletedFilter?: QueryDeletedOption,
      queryOrder?: BuildQueryOrder,
      branchName?: string,
      buildIds?: number[],
      repositoryId?: string,
      repositoryType?: string,
  ): Promise<PagedList<Build>>

  Gets a list of builds.

  Parameters

  • project: string

    Project ID or project name
  • Optionaldefinitions: number[]

    A comma-delimited list of definition IDs. If specified, filters to builds for these definitions.
  • Optionalqueues: number[]

    A comma-delimited list of queue IDs. If specified, filters to builds that ran against these queues.
  • OptionalbuildNumber: string

    If specified, filters to builds that match this build number. Append * to do a prefix search.
  • OptionalminTime: Date

    If specified, filters to builds that finished/started/queued after this date based on the queryOrder specified.
  • OptionalmaxTime: Date

    If specified, filters to builds that finished/started/queued before this date based on the queryOrder specified.
  • OptionalrequestedFor: string

    If specified, filters to builds requested for the specified user.
  • OptionalreasonFilter: BuildReason

    If specified, filters to builds that match this reason.
  • OptionalstatusFilter: BuildStatus

    If specified, filters to builds that match this status.
  • OptionalresultFilter: BuildResult

    If specified, filters to builds that match this result.
  • OptionaltagFilters: string[]

    A comma-delimited list of tags. If specified, filters to builds that have the specified tags.
  • Optionalproperties: string[]

    A comma-delimited list of properties to retrieve.
  • Optionaltop: number

    The maximum number of builds to return.
  • OptionalcontinuationToken: string

    A continuation token, returned by a previous call to this method, that can be used to return the next set of builds.
  • OptionalmaxBuildsPerDefinition: number

    The maximum number of builds to return per definition.
  • OptionaldeletedFilter: QueryDeletedOption

    Indicates whether to exclude, include, or only return deleted builds.
  • OptionalqueryOrder: BuildQueryOrder

    The order in which builds should be returned.
  • OptionalbranchName: string

    If specified, filters to builds that built branches that built this branch.
  • OptionalbuildIds: number[]

    A comma-delimited list that specifies the IDs of builds to retrieve.
  • OptionalrepositoryId: string

    If specified, filters to builds that built from this repository.
  • OptionalrepositoryType: string

    If specified, filters to builds that built from repositories of this type.

  Returns Promise<PagedList<Build>>

getBuildSettings

• getBuildSettings(project?: string): Promise<BuildSettings>

  Gets the build settings.

  Parameters

  • Optionalproject: string

    Project ID or project name

  Returns Promise<BuildSettings>

getBuildTags

• getBuildTags(project: string, buildId: number): Promise<string[]>

  Gets the tags for a build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.

  Returns Promise<string[]>

getBuildTimeline

• getBuildTimeline(
      project: string,
      buildId: number,
      timelineId?: string,
      changeId?: number,
      planId?: string,
  ): Promise<Timeline>

  Gets details for a build

  Parameters

  • project: string

    Project ID or project name
  • buildId: number
  • OptionaltimelineId: string
  • OptionalchangeId: number
  • OptionalplanId: string

  Returns Promise<Timeline>

getBuildWorkItemsRefs

• getBuildWorkItemsRefs(
      project: string,
      buildId: number,
      top?: number,
  ): Promise<ResourceRef[]>

  Gets the work items associated with a build. Only work items in the same project are returned.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • Optionaltop: number

    The maximum number of work items to return.

  Returns Promise<ResourceRef[]>

getBuildWorkItemsRefsFromCommits

• getBuildWorkItemsRefsFromCommits(
      commitIds: string[],
      project: string,
      buildId: number,
      top?: number,
  ): Promise<ResourceRef[]>

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

  Parameters

  • commitIds: string[]

    A comma-delimited list of commit IDs.
  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • Optionaltop: number

    The maximum number of work items to return, or the number of commits to consider if no commit IDs are specified.

  Returns Promise<ResourceRef[]>

getChangesBetweenBuilds

• getChangesBetweenBuilds(
      project: string,
      fromBuildId?: number,
      toBuildId?: number,
      top?: number,
  ): Promise<Change[]>

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

  Parameters

  • project: string

    Project ID or project name
  • OptionalfromBuildId: number

    The ID of the first build.
  • OptionaltoBuildId: number

    The ID of the last build.
  • Optionaltop: number

    The maximum number of changes to return.

  Returns Promise<Change[]>

getDefinition

• getDefinition(
      project: string,
      definitionId: number,
      revision?: number,
      minMetricsTime?: Date,
      propertyFilters?: string[],
      includeLatestBuilds?: boolean,
  ): Promise<BuildDefinition>

  Gets a definition, optionally at a specific revision.

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    The ID of the definition.
  • Optionalrevision: number

    The revision number to retrieve. If this is not specified, the latest version will be returned.
  • OptionalminMetricsTime: Date

    If specified, indicates the date from which metrics should be included.
  • OptionalpropertyFilters: string[]

    A comma-delimited list of properties to include in the results.
  • OptionalincludeLatestBuilds: boolean

  Returns Promise<BuildDefinition>

getDefinitionMetrics

• getDefinitionMetrics(
      project: string,
      definitionId: number,
      minMetricsTime?: Date,
  ): Promise<BuildMetric[]>

  Gets build metrics for a definition.

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    The ID of the definition.
  • OptionalminMetricsTime: Date

    The date from which to calculate metrics.

  Returns Promise<BuildMetric[]>

getDefinitionProperties

• getDefinitionProperties(
      project: string,
      definitionId: number,
      filter?: string[],
  ): Promise<any>

  Gets properties for a definition.

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    The ID of the definition.
  • Optionalfilter: string[]

    A comma-delimited list of properties. If specified, filters to these specific properties.

  Returns Promise<any>

getDefinitionResources

• getDefinitionResources(
      project: string,
      definitionId: number,
  ): Promise<DefinitionResourceReference[]>

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

  Returns Promise<DefinitionResourceReference[]>

getDefinitionRevisions

• getDefinitionRevisions(
      project: string,
      definitionId: number,
  ): Promise<BuildDefinitionRevision[]>

  Gets all revisions of a definition.

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    The ID of the definition.

  Returns Promise<BuildDefinitionRevision[]>

getDefinitions

• getDefinitions(
      project: string,
      name?: string,
      repositoryId?: string,
      repositoryType?: string,
      queryOrder?: DefinitionQueryOrder,
      top?: number,
      continuationToken?: string,
      minMetricsTime?: Date,
      definitionIds?: number[],
      path?: string,
      builtAfter?: Date,
      notBuiltAfter?: Date,
      includeAllProperties?: boolean,
      includeLatestBuilds?: boolean,
      taskIdFilter?: string,
      processType?: number,
      yamlFilename?: string,
  ): Promise<PagedList<BuildDefinitionReference>>

  Gets a list of definitions.

  Parameters

  • project: string

    Project ID or project name
  • Optionalname: string

    If specified, filters to definitions whose names match this pattern.
  • OptionalrepositoryId: string

    A repository ID. If specified, filters to definitions that use this repository.
  • OptionalrepositoryType: string

    If specified, filters to definitions that have a repository of this type.
  • OptionalqueryOrder: DefinitionQueryOrder

    Indicates the order in which definitions should be returned.
  • Optionaltop: number

    The maximum number of definitions to return.
  • OptionalcontinuationToken: string

    A continuation token, returned by a previous call to this method, that can be used to return the next set of definitions.
  • OptionalminMetricsTime: Date

    If specified, indicates the date from which metrics should be included.
  • OptionaldefinitionIds: number[]

    A comma-delimited list that specifies the IDs of definitions to retrieve.
  • Optionalpath: string

    If specified, filters to definitions under this folder.
  • OptionalbuiltAfter: Date

    If specified, filters to definitions that have builds after this date.
  • OptionalnotBuiltAfter: Date

    If specified, filters to definitions that do not have builds after this date.
  • OptionalincludeAllProperties: boolean

    Indicates whether the full definitions should be returned. By default, shallow representations of the definitions are returned.
  • OptionalincludeLatestBuilds: boolean

    Indicates whether to return the latest and latest completed builds for this definition.
  • OptionaltaskIdFilter: string

    If specified, filters to definitions that use the specified task.
  • OptionalprocessType: number

    If specified, filters to definitions with the given process type.
  • OptionalyamlFilename: string

    If specified, filters to YAML definitions that match the given filename. To use this filter includeAllProperties should be set to true

  Returns Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags

• getDefinitionTags(
      project: string,
      definitionId: number,
      revision?: number,
  ): Promise<string[]>

  Gets the tags for a definition.

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    The ID of the definition.
  • Optionalrevision: number

    The definition revision number. If not specified, uses the latest revision of the definition.

  Returns Promise<string[]>

getDefinitionYaml

• getDefinitionYaml(
      project: string,
      definitionId: number,
      revision?: number,
      minMetricsTime?: Date,
      propertyFilters?: string[],
      includeLatestBuilds?: boolean,
  ): Promise<YamlBuild>

  Converts a definition to YAML, optionally at a specific revision.

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    The ID of the definition.
  • Optionalrevision: number

    The revision number to retrieve. If this is not specified, the latest version will be returned.
  • OptionalminMetricsTime: Date

    If specified, indicates the date from which metrics should be included.
  • OptionalpropertyFilters: string[]

    A comma-delimited list of properties to include in the results.
  • OptionalincludeLatestBuilds: boolean

  Returns Promise<YamlBuild>

getFile

• getFile(
      project: string,
      buildId: number,
      artifactName: string,
      fileId: string,
      fileName: string,
  ): Promise<ReadableStream>

  Gets a file from the build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • artifactName: string

    The name of the artifact.
  • fileId: string

    The primary key for the file.
  • fileName: string

    The name that the file will be set to.

  Returns Promise<ReadableStream>

getFileContents

• getFileContents(
      project: string,
      providerName: string,
      serviceEndpointId?: string,
      repository?: string,
      commitOrBranch?: string,
      path?: string,
  ): Promise<ReadableStream>

  Gets the contents of a file in the given source code repository.

  Parameters

  • project: string

    Project ID or project name
  • providerName: string

    The name of the source provider.
  • OptionalserviceEndpointId: string

    If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
  • Optionalrepository: string

    If specified, the vendor-specific identifier or the name of the repository to get branches. Can only be omitted for providers that do not support multiple repositories.
  • OptionalcommitOrBranch: string

    The identifier of the commit or branch from which a file's contents are retrieved.
  • Optionalpath: string

    The path to the file to retrieve, relative to the root of the repository.

  Returns Promise<ReadableStream>

getFolders

• getFolders(
      project: string,
      path?: string,
      queryOrder?: FolderQueryOrder,
  ): Promise<Folder[]>

  Gets a list of build definition folders.

  Parameters

  • project: string

    Project ID or project name
  • Optionalpath: string

    The path to start with.
  • OptionalqueryOrder: FolderQueryOrder

    The order in which folders should be returned.

  Returns Promise<Folder[]>

getLatestBuild

• getLatestBuild(
      project: string,
      definition: string,
      branchName?: string,
  ): Promise<Build>

  Gets the latest build for a definition, optionally scoped to a specific branch.

  Parameters

  • project: string

    Project ID or project name
  • definition: string

    definition name with optional leading folder path, or the definition id
  • OptionalbranchName: string

    optional parameter that indicates the specific branch to use. If not specified, the default branch is used.

  Returns Promise<Build>

getPathContents

• getPathContents(
      project: string,
      providerName: string,
      serviceEndpointId?: string,
      repository?: string,
      commitOrBranch?: string,
      path?: string,
  ): Promise<SourceRepositoryItem[]>

  Gets the contents of a directory in the given source code repository.

  Parameters

  • project: string

    Project ID or project name
  • providerName: string

    The name of the source provider.
  • OptionalserviceEndpointId: string

    If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
  • Optionalrepository: string

    If specified, the vendor-specific identifier or the name of the repository to get branches. Can only be omitted for providers that do not support multiple repositories.
  • OptionalcommitOrBranch: string

    The identifier of the commit or branch from which a file's contents are retrieved.
  • Optionalpath: string

    The path contents to list, relative to the root of the repository.

  Returns Promise<SourceRepositoryItem[]>

getProjectMetrics

• getProjectMetrics(
      project: string,
      metricAggregationType?: string,
      minMetricsTime?: Date,
  ): Promise<BuildMetric[]>

  Gets build metrics for a project.

  Parameters

  • project: string

    Project ID or project name
  • OptionalmetricAggregationType: string

    The aggregation type to use (hourly, daily).
  • OptionalminMetricsTime: Date

    The date from which to calculate metrics.

  Returns Promise<BuildMetric[]>

getProjectResources

• getProjectResources(
      project: string,
      type?: string,
      id?: string,
  ): Promise<DefinitionResourceReference[]>

  Parameters

  • project: string

    Project ID or project name
  • Optionaltype: string
  • Optionalid: string

  Returns Promise<DefinitionResourceReference[]>

getPullRequest

• getPullRequest(
      project: string,
      providerName: string,
      pullRequestId: string,
      repositoryId?: string,
      serviceEndpointId?: string,
  ): Promise<PullRequest>

  Gets a pull request object from source provider.

  Parameters

  • project: string

    Project ID or project name
  • providerName: string

    The name of the source provider.
  • pullRequestId: string

    Vendor-specific id of the pull request.
  • OptionalrepositoryId: string

    Vendor-specific identifier or the name of the repository that contains the pull request.
  • OptionalserviceEndpointId: string

    If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.

  Returns Promise<PullRequest>

getResourceUsage

• getResourceUsage(): Promise<BuildResourceUsage>

  Gets information about build resources in the system.

  Returns Promise<BuildResourceUsage>

getRetentionHistory

• getRetentionHistory(daysToLookback?: number): Promise<BuildRetentionHistory>

  Returns the retention history for the project collection. This includes pipelines that have custom retention rules that may prevent the retention job from cleaning them up, runs per pipeline with retention type, files associated with pipelines owned by the collection with retention type, and the number of files per pipeline.

  Parameters

  • OptionaldaysToLookback: number

  Returns Promise<BuildRetentionHistory>

getRetentionLease

• getRetentionLease(project: string, leaseId: number): Promise<RetentionLease>

  Returns the details of the retention lease given a lease id.

  Parameters

  • project: string

    Project ID or project name
  • leaseId: number

  Returns Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases

• getRetentionLeasesByMinimalRetentionLeases(
      project: string,
      leasesToFetch: MinimalRetentionLease[],
  ): Promise<RetentionLease[]>

  Returns any leases matching the specified MinimalRetentionLeases

  Parameters

  • project: string

    Project ID or project name
  • leasesToFetch: MinimalRetentionLease[]

    List of JSON-serialized MinimalRetentionLeases separated by '|'

  Returns Promise<RetentionLease[]>

getRetentionLeasesByOwnerId

• getRetentionLeasesByOwnerId(
      project: string,
      ownerId?: string,
      definitionId?: number,
      runId?: number,
  ): Promise<RetentionLease[]>

  Returns any leases owned by the specified entity, optionally scoped to a single pipeline definition and run.

  Parameters

  • project: string

    Project ID or project name
  • OptionalownerId: string
  • OptionaldefinitionId: number

    An optional parameter to limit the search to a specific pipeline definition.
  • OptionalrunId: number

    An optional parameter to limit the search to a single pipeline run. Requires definitionId.

  Returns Promise<RetentionLease[]>

getRetentionLeasesByUserId

• getRetentionLeasesByUserId(
      project: string,
      userOwnerId: string,
      definitionId?: number,
      runId?: number,
  ): Promise<RetentionLease[]>

  Returns any leases owned by the specified user, optionally scoped to a single pipeline definition and run.

  Parameters

  • project: string

    Project ID or project name
  • userOwnerId: string

    The user id to search for.
  • OptionaldefinitionId: number

    An optional parameter to limit the search to a specific pipeline definition.
  • OptionalrunId: number

    An optional parameter to limit the search to a single pipeline run. Requires definitionId.

  Returns Promise<RetentionLease[]>

getRetentionLeasesForBuild

• getRetentionLeasesForBuild(
      project: string,
      buildId: number,
  ): Promise<RetentionLease[]>

  Gets all retention leases that apply to a specific build.

  Parameters

  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.

  Returns Promise<RetentionLease[]>

getRetentionSettings

• getRetentionSettings(project: string): Promise<ProjectRetentionSetting>

  Gets the project's retention settings.

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<ProjectRetentionSetting>

getStatusBadge

• getStatusBadge(
      project: string,
      definition: string,
      branchName?: string,
      stageName?: string,
      jobName?: string,
      configuration?: string,
      label?: string,
  ): Promise<string>

  Gets the build status for a definition, optionally scoped to a specific branch, stage, job, and configuration.

  If there are more than one, then it is required to pass in a stageName value when specifying a jobName, and the same rule then applies for both if passing a configuration parameter.

  Parameters

  • project: string

    Project ID or project name
  • definition: string

    Either the definition name with optional leading folder path, or the definition id.
  • OptionalbranchName: string

    Only consider the most recent build for this branch. If not specified, the default branch is used.
  • OptionalstageName: string

    Use this stage within the pipeline to render the status.
  • OptionaljobName: string

    Use this job within a stage of the pipeline to render the status.
  • Optionalconfiguration: string

    Use this job configuration to render the status
  • Optionallabel: string

    Replaces the default text on the left side of the badge.

  Returns Promise<string>

getTags

• getTags(project: string): Promise<string[]>

  Gets a list of all build tags in the project.

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<string[]>

getTemplate

• getTemplate(
      project: string,
      templateId: string,
  ): Promise<BuildDefinitionTemplate>

  Gets a specific build definition template.

  Parameters

  • project: string

    Project ID or project name
  • templateId: string

    The ID of the requested template.

  Returns Promise<BuildDefinitionTemplate>

getTemplates

• getTemplates(project: string): Promise<BuildDefinitionTemplate[]>

  Gets all definition templates.

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds

• getWorkItemsBetweenBuilds(
      project: string,
      fromBuildId: number,
      toBuildId: number,
      top?: number,
  ): Promise<ResourceRef[]>

  Gets all the work items between two builds.

  Parameters

  • project: string

    Project ID or project name
  • fromBuildId: number

    The ID of the first build.
  • toBuildId: number

    The ID of the last build.
  • Optionaltop: number

    The maximum number of work items to return.

  Returns Promise<ResourceRef[]>

listBranches

• listBranches(
      project: string,
      providerName: string,
      serviceEndpointId?: string,
      repository?: string,
      branchName?: string,
  ): Promise<string[]>

  Gets a list of branches for the given source code repository.

  Parameters

  • project: string

    Project ID or project name
  • providerName: string

    The name of the source provider.
  • OptionalserviceEndpointId: string

    If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
  • Optionalrepository: string

    The vendor-specific identifier or the name of the repository to get branches. Can only be omitted for providers that do not support multiple repositories.
  • OptionalbranchName: string

    If supplied, the name of the branch to check for specifically.

  Returns Promise<string[]>

listRepositories

• listRepositories(
      project: string,
      providerName: string,
      serviceEndpointId?: string,
      repository?: string,
      resultSet?: ResultSet,
      pageResults?: boolean,
      continuationToken?: string,
  ): Promise<SourceRepositories>

  Gets a list of source code repositories.

  Parameters

  • project: string

    Project ID or project name
  • providerName: string

    The name of the source provider.
  • OptionalserviceEndpointId: string

    If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
  • Optionalrepository: string

    If specified, the vendor-specific identifier or the name of a single repository to get.
  • OptionalresultSet: ResultSet

    'top' for the repositories most relevant for the endpoint. If not set, all repositories are returned. Ignored if 'repository' is set.
  • OptionalpageResults: boolean

    If set to true, this will limit the set of results and will return a continuation token to continue the query.
  • OptionalcontinuationToken: string

    When paging results, this is a continuation token, returned by a previous call to this method, that can be used to return the next set of repositories.

  Returns Promise<SourceRepositories>

listSourceProviders

• listSourceProviders(project: string): Promise<SourceProviderAttributes[]>

  Get a list of source providers and their capabilities.

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<SourceProviderAttributes[]>

listWebhooks

• listWebhooks(
      project: string,
      providerName: string,
      serviceEndpointId?: string,
      repository?: string,
  ): Promise<RepositoryWebhook[]>

  Gets a list of webhooks installed in the given source code repository.

  Parameters

  • project: string

    Project ID or project name
  • providerName: string

    The name of the source provider.
  • OptionalserviceEndpointId: string

    If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
  • Optionalrepository: string

    If specified, the vendor-specific identifier or the name of the repository to get webhooks. Can only be omitted for providers that do not support multiple repositories.

  Returns Promise<RepositoryWebhook[]>

queueBuild

• queueBuild(
      build: Build,
      project: string,
      ignoreWarnings?: boolean,
      checkInTicket?: string,
      sourceBuildId?: number,
      definitionId?: number,
  ): Promise<Build>

  Queues a build

  Parameters

  • build: Build
  • project: string

    Project ID or project name
  • OptionalignoreWarnings: boolean
  • OptionalcheckInTicket: string
  • OptionalsourceBuildId: number
  • OptionaldefinitionId: number

    Optional definition id to queue a build without a body. Ignored if there's a valid body

  Returns Promise<Build>

restoreDefinition

• restoreDefinition(
      project: string,
      definitionId: number,
      deleted: boolean,
  ): Promise<BuildDefinition>

  Restores a deleted definition

  Parameters

  • project: string

    Project ID or project name
  • definitionId: number

    The identifier of the definition to restore.
  • deleted: boolean

    When false, restores a deleted definition.

  Returns Promise<BuildDefinition>

restoreWebhooks

• restoreWebhooks(
      triggerTypes: DefinitionTriggerType[],
      project: string,
      providerName: string,
      serviceEndpointId?: string,
      repository?: string,
  ): Promise<void>

  Recreates the webhooks for the specified triggers in the given source code repository.

  Parameters

  • triggerTypes: DefinitionTriggerType[]

    The types of triggers to restore webhooks for.
  • project: string

    Project ID or project name
  • providerName: string

    The name of the source provider.
  • OptionalserviceEndpointId: string

    If specified, the ID of the service endpoint to query. Can only be omitted for providers that do not use service endpoints, e.g. TFVC or TFGit.
  • Optionalrepository: string

    If specified, the vendor-specific identifier or the name of the repository to get webhooks. Can only be omitted for providers that do not support multiple repositories.

  Returns Promise<void>

saveTemplate

• saveTemplate(
      template: BuildDefinitionTemplate,
      project: string,
      templateId: string,
  ): Promise<BuildDefinitionTemplate>

  Updates an existing build definition template.

  Parameters

  • template: BuildDefinitionTemplate

    The new version of the template.
  • project: string

    Project ID or project name
  • templateId: string

    The ID of the template.

  Returns Promise<BuildDefinitionTemplate>

updateBuild

• updateBuild(
      build: Build,
      project: string,
      buildId: number,
      retry?: boolean,
  ): Promise<Build>

  Updates a build.

  Parameters

  • build: Build

    The build.
  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.
  • Optionalretry: boolean

  Returns Promise<Build>

updateBuildGeneralSettings

• updateBuildGeneralSettings(
      newSettings: PipelineGeneralSettings,
      project: string,
  ): Promise<PipelineGeneralSettings>

  Updates pipeline general settings.

  Parameters

  • newSettings: PipelineGeneralSettings
  • project: string

    Project ID or project name

  Returns Promise<PipelineGeneralSettings>

updateBuildProperties

• updateBuildProperties(
      customHeaders: any,
      document: JsonPatchDocument,
      project: string,
      buildId: number,
  ): Promise<any>

  Updates properties for a build.

  Parameters

  • customHeaders: any
  • document: JsonPatchDocument

    A json-patch document describing the properties to update.
  • project: string

    Project ID or project name
  • buildId: number

    The ID of the build.

  Returns Promise<any>

updateBuilds

• updateBuilds(builds: Build[], project: string): Promise<Build[]>

  Updates multiple builds.

  Parameters

  • builds: Build[]

    The builds to update.
  • project: string

    Project ID or project name

  Returns Promise<Build[]>