BuildRestClient class

Пакет:: azure-devops-extension-api

Базовый класс, который должен использоваться (производный) для выполнения запросов к VSS REST API

Extends: RestClientBase

Конструкторы

Свойства

Методы

addBuildTag(string, number, string)	Добавляет тег к сборке.
addBuildTags(string[], string, number)	Добавляет теги в сборку.
addDefinitionTag(string, number, string)	Добавляет тег к определению
addDefinitionTags(string[], string, number)	Добавляет несколько тегов к определению.
addRetentionLeases(NewRetentionLease[], string)	Добавляет новые договоры аренды для прогонов трубопроводов.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Связывает артефакт со сборкой.
createDefinition(BuildDefinition, string, number, number)	Создает новое определение.
createFolder(Folder, string, string)	Создает новую папку.
deleteBuild(string, number)	Удаляет сборку.
deleteBuildTag(string, number, string)	Удаляет тег из сборки. ПРИМЕЧАНИЕ: Этот API не будет работать для тегов со специальными символами. Чтобы удалить теги со специальными символами, используйте метод PATCH (в версии 6.0+)
deleteDefinition(string, number)	Удаляет определение и все связанные сборки.
deleteDefinitionTag(string, number, string)	Удаляет тег из определения. ПРИМЕЧАНИЕ: Этот API не будет работать для тегов со специальными символами. Чтобы удалить теги со специальными символами, используйте метод PATCH (в версии 6.0+)
deleteFolder(string, string)	Удаляет папку определения. Определения и соответствующие им сборки также будут удалены.
deleteRetentionLeasesById(string, number[])	Удаляет определенные договоры аренды для удержания.
deleteTag(string, string)	Удаляет тег из сборок, определений и из хранилища тегов
deleteTemplate(string, string)	Удаляет шаблон определения сборки.
getArtifact(string, number, string)	Получает определенный артефакт для сборки.
getArtifactContentZip(string, number, string)	Получает определенный артефакт для сборки.
getArtifacts(string, number)	Получает все артефакты для сборки.
getAttachment(string, number, string, string, string, string)	Получает конкретное вложение.
getAttachments(string, number, string)	Получает список вложений определенного типа, связанных со сборкой.
getBadge(string, number, string)	Получает значок, указывающий состояние самой последней сборки для определения. Обратите внимание, что этот API является устаревшим. Отдайте предпочтение StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Получает сборку
getBuildBadge(string, string, string, string)	Получает значок, указывающий на состояние самой последней сборки для указанной ветви.
getBuildBadgeData(string, string, string, string)	Получает значок, указывающий на состояние самой последней сборки для указанной ветви.
getBuildChanges(string, number, string, number, boolean)	Получает изменения, связанные со сборкой
getBuildController(number)	Получает контроллер
getBuildControllers(string)	Получает контроллер, опционально отфильтрованный по имени
getBuildGeneralSettings(string)	Получает общие настройки конвейера.
getBuildLog(string, number, number, number, number)	Получает отдельный файл журнала для сборки.
getBuildLogLines(string, number, number, number, number)	Получает отдельный файл журнала для сборки.
getBuildLogs(string, number)	Получает журналы для сборки.
getBuildLogsZip(string, number)	Получает журналы для сборки.
getBuildLogZip(string, number, number, number, number)	Получает отдельный файл журнала для сборки.
getBuildOptionDefinitions(string)	Получает все варианты определения сборки, поддерживаемые системой.
getBuildProperties(string, number, string[])	Получает свойства для сборки.
getBuildReport(string, number, string)	Получает отчет о сборке.
getBuildReportHtmlContent(string, number, string)	Получает отчет о сборке.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Получает список сборок.
getBuildSettings(string)	Получает настройки сборки.
getBuildTags(string, number)	Получает теги для сборки.
getBuildTimeline(string, number, string, number, string)	Получение сведений о сборке
getBuildWorkItemsRefs(string, number, number)	Получает рабочие элементы, связанные со сборкой. Возвращаются только рабочие элементы в одном проекте.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Получает рабочие элементы, связанные со сборкой, отфильтрованные по конкретным фиксациям.
getChangesBetweenBuilds(string, number, number, number)	Получает изменения, внесенные в репозиторий между двумя заданными сборками.
getDefinition(string, number, number, Date, string[], boolean)	Получает определение, опционально в конкретной ревизии.
getDefinitionMetrics(string, number, Date)	Получает метрики сборки для определения.
getDefinitionProperties(string, number, string[])	Получает свойства для определения.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Получает все редакции определения.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Получает список определений.
getDefinitionTags(string, number, number)	Получает теги для определения.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Преобразует определение в YAML, при необходимости в определенной редакции.
getFile(string, number, string, string, string)	Получает файл из сборки.
getFileContents(string, string, string, string, string, string)	Получает содержимое файла в заданном репозитории исходного кода.
getFolders(string, string, FolderQueryOrder)	Получает список папок с определениями сборки.
getLatestBuild(string, string, string)	Получает последнюю сборку для определения, при необходимости ограниченную определенной ветвью.
getPathContents(string, string, string, string, string, string)	Получает содержимое каталога в заданном репозитории исходного кода.
getProjectMetrics(string, string, Date)	Получает метрики сборки для проекта.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Получает объект запроса на вытягивание от исходного поставщика.
getResourceUsage()	Получает информацию о ресурсах сборки в системе.
getRetentionHistory(number)	Возвращает журнал хранения для коллекции проекта. К ним относятся конвейеры с настраиваемыми правилами хранения, которые могут помешать заданию хранения очистить их, запуски на конвейер с типом хранения, файлы, связанные с конвейерами, принадлежащими коллекции с типом хранения, и количество файлов на конвейер.
getRetentionLease(string, number)	Возвращает сведения об аренде удержания с присвоением идентификатора аренды.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Возвращает все аренды, соответствующие указанному MinimalRetentionLeases
getRetentionLeasesByOwnerId(string, string, number, number)	Возвращает все аренды, принадлежащие указанному объекту, при необходимости ограниченные одним определением конвейера и выполнением.
getRetentionLeasesByUserId(string, string, number, number)	Возвращает все аренды, принадлежащие указанному пользователю, при необходимости ограниченные одним определением конвейера и выполнением.
getRetentionLeasesForBuild(string, number)	Получает все договоры аренды удержания, которые применяются к конкретной сборке.
getRetentionSettings(string)	Получает настройки удержания проекта.
getStatusBadge(string, string, string, string, string, string, string)	<p>Получает статус сборки для определения, опционально ограниченный конкретной ветвью, стадией, заданием и конфигурацией.</p><p>Если их несколько, то необходимо передать значение stageName при указании jobName, и то же правило применяется для обоих при передаче параметра конфигурации.</p>
getTags(string)	Получает список всех тегов сборки в проекте.
getTemplate(string, string)	Получает определенный шаблон определения сборки.
getTemplates(string)	Получает все шаблоны определений.
getWorkItemsBetweenBuilds(string, number, number, number)	Получает все рабочие элементы между двумя сборками.
listBranches(string, string, string, string, string)	Получает список ветвей для заданного репозитория исходного кода.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Получает список репозиториев исходного кода.
listSourceProviders(string)	Получите список поставщиков источников и их возможности.
listWebhooks(string, string, string, string)	Получает список вебхуков, установленных в заданном репозитории исходного кода.
queueBuild(Build, string, boolean, string, number, number)	Ставит сборку в очередь
restoreDefinition(string, number, boolean)	Восстанавливает удаленное определение
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Повторно создает вебхуки для указанных триггеров в заданном репозитории исходного кода.
saveTemplate(BuildDefinitionTemplate, string, string)	Обновляет существующий шаблон определения сборки.
updateBuild(Build, string, number, boolean)	Обновляет сборку.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Обновляет общие настройки конвейера.
updateBuildProperties(JsonPatchDocument, string, number)	Обновляет свойства для сборки.
updateBuilds(Build[], string)	Обновляет несколько сборок.
updateBuildSettings(BuildSettings, string)	Обновляет параметры сборки.
updateBuildTags(UpdateTagParameters, string, number)	Добавляет/удаляет теги из сборки.
updateDefinition(BuildDefinition, string, number, number, number)	Обновляет существующее определение сборки. Чтобы эта операция была выполнена успешно, значение свойства "Revision" тела запроса должно совпадать с значением существующего определения сборки. Рекомендуется получить существующее определение сборки с помощью GET, при необходимости изменить определение сборки, а затем отправить измененное определение с помощью PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	Обновляет свойства определения.
updateDefinitionTags(UpdateTagParameters, string, number)	Добавляет/удаляет теги из определения.
updateFolder(Folder, string, string)	Обновляет существующую папку по заданному существующему пути
updateRetentionLease(RetentionLeaseUpdate, string, number)	Обновляет срок действия или состояние защиты конвейера аренды с удержанием.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Обновляет параметры хранения проекта.
updateStage(UpdateStageParameters, number, string, string)	Обновление этапа сборки

Сведения о конструкторе

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Параметры

options: IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

addBuildTag(string, number, string)

Добавляет тег к сборке.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

tag: string

Тег для добавления.

Возвращаемое значение

Promise<string[]>

addBuildTags(string[], string, number)

Добавляет теги в сборку.

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

Параметры

tags: string[]

Теги для добавления. Тело запроса составляется непосредственно из перечисленных тегов.

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

Возвращаемое значение

Promise<string[]>

addDefinitionTag(string, number, string)

Добавляет тег к определению

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

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

tag: string

Тег для добавления.

Возвращаемое значение

Promise<string[]>

addDefinitionTags(string[], string, number)

Добавляет несколько тегов к определению.

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

Параметры

tags: string[]

Теги для добавления.

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

Возвращаемое значение

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Добавляет новые договоры аренды для прогонов трубопроводов.

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

Параметры

newLeases: NewRetentionLease[]

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

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

Параметры

resources: DefinitionResourceReference[]

project: string

Идентификатор проекта или имя проекта

definitionId: number

Возвращаемое значение

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

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

Параметры

resources: DefinitionResourceReference[]

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Связывает артефакт со сборкой.

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

Параметры

artifact: BuildArtifact

Артефакт.

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

Возвращаемое значение

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Создает новое определение.

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

Параметры

definition: BuildDefinition

Определение.

project: string

Идентификатор проекта или имя проекта

definitionToCloneId: number

definitionToCloneRevision: number

Возвращаемое значение

Promise<BuildDefinition>

createFolder(Folder, string, string)

Создает новую папку.

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

Параметры

folder: Folder

Папка.

project: string

Идентификатор проекта или имя проекта

path: string

Полный путь к папке.

Возвращаемое значение

Promise<Folder>

deleteBuild(string, number)

Удаляет сборку.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

Возвращаемое значение

Promise<void>

deleteBuildTag(string, number, string)

Удаляет тег из сборки. ПРИМЕЧАНИЕ: Этот API не будет работать для тегов со специальными символами. Чтобы удалить теги со специальными символами, используйте метод PATCH (в версии 6.0+)

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

tag: string

Тег, который нужно удалить.

Возвращаемое значение

Promise<string[]>

deleteDefinition(string, number)

Удаляет определение и все связанные сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

Возвращаемое значение

Promise<void>

deleteDefinitionTag(string, number, string)

Удаляет тег из определения. ПРИМЕЧАНИЕ: Этот API не будет работать для тегов со специальными символами. Чтобы удалить теги со специальными символами, используйте метод PATCH (в версии 6.0+)

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

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

tag: string

Тег, который нужно удалить.

Возвращаемое значение

Promise<string[]>

deleteFolder(string, string)

Удаляет папку определения. Определения и соответствующие им сборки также будут удалены.

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

Параметры

project: string

Идентификатор проекта или имя проекта

path: string

Полный путь к папке.

Возвращаемое значение

Promise<void>

deleteRetentionLeasesById(string, number[])

Удаляет определенные договоры аренды для удержания.

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

Параметры

project: string

Идентификатор проекта или имя проекта

ids: number[]

Возвращаемое значение

Promise<void>

deleteTag(string, string)

Удаляет тег из сборок, определений и из хранилища тегов

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

Параметры

project: string

Идентификатор проекта или имя проекта

tag: string

Тег, который нужно удалить.

Возвращаемое значение

Promise<string[]>

deleteTemplate(string, string)

Удаляет шаблон определения сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

templateId: string

Идентификатор шаблона.

Возвращаемое значение

Promise<void>

getArtifact(string, number, string)

Получает определенный артефакт для сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

artifactName: string

Название артефакта.

Возвращаемое значение

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Получает определенный артефакт для сборки.

function getArtifactContentZip(project: string, buildId: number, artifactName: string): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

artifactName: string

Название артефакта.

Возвращаемое значение

Promise<ArrayBuffer>

getArtifacts(string, number)

Получает все артефакты для сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

Возвращаемое значение

Promise<BuildArtifact[]>

getAttachment(string, number, string, string, string, string)

Получает конкретное вложение.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

timelineId: string

Идентификатор временной шкалы.

recordId: string

Идентификатор записи временной шкалы.

type: string

Тип вложения.

name: string

Название вложения.

Возвращаемое значение

Promise<ArrayBuffer>

getAttachments(string, number, string)

Получает список вложений определенного типа, связанных со сборкой.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

type: string

Тип крепления.

Возвращаемое значение

Promise<Attachment[]>

getBadge(string, number, string)

Получает значок, указывающий состояние самой последней сборки для определения. Обратите внимание, что этот API является устаревшим. Отдайте предпочтение StatusBadgeController.GetStatusBadge.

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

Параметры

project: string

Идентификатор или имя проекта.

definitionId: number

Идентификатор определения.

branchName: string

Название ветви.

Возвращаемое значение

Promise<string>

getBuild(string, number, string)

Получает сборку

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

propertyFilters: string

Возвращаемое значение

Promise<Build>

getBuildBadge(string, string, string, string)

Получает значок, указывающий на состояние самой последней сборки для указанной ветви.

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

Параметры

project: string

Идентификатор проекта или имя проекта

repoType: string

Тип репозитория.

repoId: string

Идентификатор репозитория.

branchName: string

Имя ветви.

Возвращаемое значение

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Получает значок, указывающий на состояние самой последней сборки для указанной ветви.

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

Параметры

project: string

Идентификатор проекта или имя проекта

repoType: string

Тип репозитория.

repoId: string

Идентификатор репозитория.

branchName: string

Имя ветви.

Возвращаемое значение

Promise<string>

getBuildChanges(string, number, string, number, boolean)

Получает изменения, связанные со сборкой

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

continuationToken: string

top: number

Максимальное количество возвращаемых изменений

includeSourceChange: boolean

Возвращаемое значение

Promise<PagedList<Change>>

getBuildController(number)

Получает контроллер

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

Параметры

controllerId: number

Возвращаемое значение

Promise<BuildController>

getBuildControllers(string)

Получает контроллер, опционально отфильтрованный по имени

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

Параметры

name: string

Возвращаемое значение

Promise<BuildController[]>

getBuildGeneralSettings(string)

Получает общие настройки конвейера.

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

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<PipelineGeneralSettings>

getBuildLog(string, number, number, number, number)

Получает отдельный файл журнала для сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

logId: number

Идентификатор файла журнала.

startLine: number

Стартовая линия.

endLine: number

Конечная линия.

Возвращаемое значение

Promise<string>

getBuildLogLines(string, number, number, number, number)

Получает отдельный файл журнала для сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

logId: number

Идентификатор файла журнала.

startLine: number

Стартовая линия.

endLine: number

Конечная линия.

Возвращаемое значение

Promise<string[]>

getBuildLogs(string, number)

Получает журналы для сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

Возвращаемое значение

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Получает журналы для сборки.

function getBuildLogsZip(project: string, buildId: number): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

Возвращаемое значение

Promise<ArrayBuffer>

getBuildLogZip(string, number, number, number, number)

Получает отдельный файл журнала для сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

logId: number

Идентификатор файла журнала.

startLine: number

Стартовая линия.

endLine: number

Конечная линия.

Возвращаемое значение

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Получает все варианты определения сборки, поддерживаемые системой.

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

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Получает свойства для сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

filter: string[]

Список свойств, разделенных запятыми. Если указано, фильтруется по этим конкретным свойствам.

Возвращаемое значение

Promise<any>

getBuildReport(string, number, string)

Получает отчет о сборке.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

type: string

Возвращаемое значение

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Получает отчет о сборке.

function getBuildReportHtmlContent(project: string, buildId: number, type?: string): Promise<any>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

type: string

Возвращаемое значение

Promise<any>

getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)

Получает список сборок.

function 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>>

Параметры

project: string

Идентификатор проекта или имя проекта

definitions: number[]

Список идентификаторов определений, разделенных запятыми. Если указано, фильтрует сборки для этих определений.

queues: number[]

Список идентификаторов очередей, разделенных запятыми. Если указано, фильтруются сборки, которые выполнялись в этих очередях.

buildNumber: string

Если указано, фильтруются сборки, соответствующие этому номеру сборки. Добавьте * для поиска префикса.

minTime: Date

Если указано, фильтрует сборки, которые завершились/начались/поставлены в очередь после этой даты на основе указанного queryOrder.

maxTime: Date

Если указано, фильтрует сборки, которые были завершены/запущены/поставлены в очередь до этой даты на основе указанного queryOrder.

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>>

getBuildSettings(string)

Получает настройки сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<BuildSettings>

getBuildTags(string, number)

Получает теги для сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

Возвращаемое значение

Promise<string[]>

getBuildTimeline(string, number, string, number, string)

Получение сведений о сборке

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

timelineId: string

changeId: number

planId: string

Возвращаемое значение

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Получает рабочие элементы, связанные со сборкой. Возвращаются только рабочие элементы в одном проекте.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

top: number

Максимальное количество возвращаемых рабочих элементов.

Возвращаемое значение

Promise<ResourceRef[]>

getBuildWorkItemsRefsFromCommits(string[], string, number, number)

Получает рабочие элементы, связанные со сборкой, отфильтрованные по конкретным фиксациям.

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

Параметры

commitIds: string[]

Список идентификаторов коммитов, разделенных запятыми.

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

top: number

Максимальное количество возвращаемых рабочих элементов или количество коммитов, которые следует учитывать, если идентификаторы коммитов не указаны.

Возвращаемое значение

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Получает изменения, внесенные в репозиторий между двумя заданными сборками.

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

Параметры

project: string

Идентификатор проекта или имя проекта

fromBuildId: number

Идентификатор первой сборки.

toBuildId: number

Идентификатор последней сборки.

top: number

Максимальное количество изменений для возврата.

Возвращаемое значение

Promise<Change[]>

getDefinition(string, number, number, Date, string[], boolean)

Получает определение, опционально в конкретной ревизии.

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

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

revision: number

Номер ревизии для извлечения. Если это не указано, будет возвращена последняя версия.

minMetricsTime: Date

Если указано, указывает дату, с которой должны быть включены метрики.

propertyFilters: string[]

Разделенный запятыми список свойств, которые должны быть включены в результаты.

includeLatestBuilds: boolean

Возвращаемое значение

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Получает метрики сборки для определения.

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

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

minMetricsTime: Date

Дата, с которой рассчитываются метрики.

Возвращаемое значение

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Получает свойства для определения.

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

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

filter: string[]

Список свойств, разделенных запятыми. Если указано, фильтруется по этим конкретным свойствам.

Возвращаемое значение

Promise<any>

getDefinitionResources(string, number)

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

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Возвращаемое значение

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Получает все редакции определения.

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

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

Возвращаемое значение

Promise<BuildDefinitionRevision[]>

getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)

Получает список определений.

function 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>>

Параметры

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

Если указано, фильтруется по определениям YAML, которые соответствуют заданному имени файла. Для использования этого фильтра includeAllProperties должно быть установлено значение true

Возвращаемое значение

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Получает теги для определения.

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

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

revision: number

Номер редакции определения. Если не указано, используется последняя редакция определения.

Возвращаемое значение

Promise<string[]>

getDefinitionYaml(string, number, number, Date, string[], boolean)

Преобразует определение в YAML, при необходимости в определенной редакции.

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

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

revision: number

Номер ревизии для извлечения. Если это не указано, будет возвращена последняя версия.

minMetricsTime: Date

Если указано, указывает дату, с которой должны быть включены метрики.

propertyFilters: string[]

Разделенный запятыми список свойств, которые должны быть включены в результаты.

includeLatestBuilds: boolean

Возвращаемое значение

Promise<YamlBuild>

getFile(string, number, string, string, string)

Получает файл из сборки.

function getFile(project: string, buildId: number, artifactName: string, fileId: string, fileName: string): Promise<ArrayBuffer>

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

artifactName: string

Название артефакта.

fileId: string

Первичный ключ для файла.

fileName: string

Имя, которое будет присвоено файлу.

Возвращаемое значение

Promise<ArrayBuffer>

getFileContents(string, string, string, string, string, string)

Получает содержимое файла в заданном репозитории исходного кода.

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

Параметры

project: string

Идентификатор проекта или имя проекта

providerName: string

Имя поставщика исходного кода.

serviceEndpointId: string

Если указано, идентификатор запрашиваемой конечной точки службы. Может быть опущено только для поставщиков, которые не используют конечные точки службы, например TFVC или TFGit.

repository: string

Если указано, идентификатор, специфичный для поставщика, или имя репозитория для получения ветвей. Может быть опущено только для поставщиков, которые не поддерживают несколько репозиториев.

commitOrBranch: string

Идентификатор коммита или ветви, из которой извлекается содержимое файла.

path: string

Путь к извлекаемому файлу относительно корня репозитория.

Возвращаемое значение

Promise<string>

getFolders(string, string, FolderQueryOrder)

Получает список папок с определениями сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

path: string

Путь, с которого стоит начать.

queryOrder: FolderQueryOrder

Порядок, в котором папки должны быть возвращены.

Возвращаемое значение

Promise<Folder[]>

getLatestBuild(string, string, string)

Получает последнюю сборку для определения, при необходимости ограниченную определенной ветвью.

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

Параметры

project: string

Идентификатор проекта или имя проекта

definition: string

Имя определения с необязательным начальным путем к папке или идентификатор определения

branchName: string

Необязательный параметр, указывающий конкретную ветвь, которую следует использовать. Если не указано, используется ветвь по умолчанию.

Возвращаемое значение

Promise<Build>

getPathContents(string, string, string, string, string, string)

Получает содержимое каталога в заданном репозитории исходного кода.

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

Параметры

project: string

Идентификатор проекта или имя проекта

providerName: string

Имя поставщика исходного кода.

serviceEndpointId: string

repository: string

commitOrBranch: string

Идентификатор коммита или ветви, из которой извлекается содержимое файла.

path: string

Путь к содержимому списка относительно корня репозитория.

Возвращаемое значение

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Получает метрики сборки для проекта.

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

Параметры

project: string

Идентификатор проекта или имя проекта

metricAggregationType: string

Используемый тип агрегирования (ежечасно, ежедневно).

minMetricsTime: Date

Дата, с которой рассчитываются метрики.

Возвращаемое значение

Promise<BuildMetric[]>

getProjectResources(string, string, string)

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

Параметры

project: string

Идентификатор проекта или имя проекта

type: string

id: string

Возвращаемое значение

Promise<DefinitionResourceReference[]>

getPullRequest(string, string, string, string, string)

Получает объект запроса на вытягивание от исходного поставщика.

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

Параметры

project: string

Идентификатор проекта или имя проекта

providerName: string

Имя поставщика исходного кода.

pullRequestId: string

Идентификатор запроса на вытягивание, зависящий от поставщика.

repositoryId: string

Идентификатор поставщика или имя репозитория, содержащего запрос на вытягивание.

serviceEndpointId: string

Возвращаемое значение

Promise<PullRequest>

getResourceUsage()

Получает информацию о ресурсах сборки в системе.

function getResourceUsage(): Promise<BuildResourceUsage>

Возвращаемое значение

Promise<BuildResourceUsage>

getRetentionHistory(number)

Возвращает журнал хранения для коллекции проекта. К ним относятся конвейеры с настраиваемыми правилами хранения, которые могут помешать заданию хранения очистить их, запуски на конвейер с типом хранения, файлы, связанные с конвейерами, принадлежащими коллекции с типом хранения, и количество файлов на конвейер.

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

Параметры

daysToLookback: number

Возвращаемое значение

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Возвращает сведения об аренде удержания с присвоением идентификатора аренды.

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

Параметры

project: string

Идентификатор проекта или имя проекта

leaseId: number

Возвращаемое значение

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Возвращает все аренды, соответствующие указанному MinimalRetentionLeases

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

Параметры

project: string

Идентификатор проекта или имя проекта

leasesToFetch: MinimalRetentionLease[]

Список сериализованных в формате JSON MinimalRetentionLeases с разделом '|'

Возвращаемое значение

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Возвращает все аренды, принадлежащие указанному объекту, при необходимости ограниченные одним определением конвейера и выполнением.

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

Параметры

project: string

Идентификатор проекта или имя проекта

ownerId: string

definitionId: number

Необязательный параметр, ограничивающий поиск определенным определением конвейера.

runId: number

Необязательный параметр, ограничивающий поиск одним прогоном конвейера. Требуется definitionId.

Возвращаемое значение

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Возвращает все аренды, принадлежащие указанному пользователю, при необходимости ограниченные одним определением конвейера и выполнением.

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

Параметры

project: string

Идентификатор проекта или имя проекта

userOwnerId: string

Идентификатор пользователя для поиска.

definitionId: number

Необязательный параметр, ограничивающий поиск определенным определением конвейера.

runId: number

Необязательный параметр, ограничивающий поиск одним прогоном конвейера. Требуется definitionId.

Возвращаемое значение

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Получает все договоры аренды удержания, которые применяются к конкретной сборке.

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

Параметры

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

Возвращаемое значение

Promise<RetentionLease[]>

getRetentionSettings(string)

Получает настройки удержания проекта.

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

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ProjectRetentionSetting>

getStatusBadge(string, string, string, string, string, string, string)

<p>Получает статус сборки для определения, опционально ограниченный конкретной ветвью, стадией, заданием и конфигурацией.</p><p>Если их несколько, то необходимо передать значение stageName при указании jobName, и то же правило применяется для обоих при передаче параметра конфигурации.</p>

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

Параметры

project: string

Идентификатор проекта или имя проекта

definition: string

Либо имя определения с необязательным начальным путем к папке, либо идентификатор определения.

branchName: string

Рассматривайте только самую последнюю сборку для этой ветви. Если не указано, используется ветвь по умолчанию.

stageName: string

Используйте этот этап в конвейере для отображения состояния.

jobName: string

Используйте это задание на этапе конвейера для отрисовки состояния.

configuration: string

Используйте эту конфигурацию задания для отображения состояния

label: string

Заменяет текст по умолчанию в левой части эмблемы.

Возвращаемое значение

Promise<string>

getTags(string)

Получает список всех тегов сборки в проекте.

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

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<string[]>

getTemplate(string, string)

Получает определенный шаблон определения сборки.

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

Параметры

project: string

Идентификатор проекта или имя проекта

templateId: string

Идентификатор запрашиваемого шаблона.

Возвращаемое значение

Promise<BuildDefinitionTemplate>

getTemplates(string)

Получает все шаблоны определений.

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

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Получает все рабочие элементы между двумя сборками.

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

Параметры

project: string

Идентификатор проекта или имя проекта

fromBuildId: number

Идентификатор первой сборки.

toBuildId: number

Идентификатор последней сборки.

top: number

Максимальное количество возвращаемых рабочих элементов.

Возвращаемое значение

Promise<ResourceRef[]>

listBranches(string, string, string, string, string)

Получает список ветвей для заданного репозитория исходного кода.

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

Параметры

project: string

Идентификатор проекта или имя проекта

providerName: string

Имя поставщика исходного кода.

serviceEndpointId: string

repository: string

Идентификатор поставщика или имя репозитория для получения ветвей. Может быть опущено только для поставщиков, которые не поддерживают несколько репозиториев.

branchName: string

Если указано, то имя ветки, которую нужно проверить.

Возвращаемое значение

Promise<string[]>

listRepositories(string, string, string, string, ResultSet, boolean, string)

Получает список репозиториев исходного кода.

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

Параметры

project: string

Идентификатор проекта или имя проекта

providerName: string

Имя поставщика исходного кода.

serviceEndpointId: string

repository: string

Если указано, идентификатор, специфичный для поставщика, или имя отдельного репозитория, который необходимо получить.

resultSet: ResultSet

'top' для репозиториев, наиболее релевантных для конечной точки. Если этот репозиторий не задан, возвращаются все репозитории. Игнорируется, если установлен 'repository'.

pageResults: boolean

Если задано значение true, это ограничит набор результатов и вернет маркер продолжения для продолжения запроса.

continuationToken: string

При разбиении на страницы результатов это маркер продолжения, возвращаемый предыдущим вызовом этого метода, который можно использовать для возврата следующего набора репозиториев.

Возвращаемое значение

Promise<SourceRepositories>

listSourceProviders(string)

Получите список поставщиков источников и их возможности.

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

Параметры

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Получает список вебхуков, установленных в заданном репозитории исходного кода.

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

Параметры

project: string

Идентификатор проекта или имя проекта

providerName: string

Имя поставщика исходного кода.

serviceEndpointId: string

repository: string

Если указано, идентификатор, специфичный для поставщика, или имя репозитория для получения вебхуков. Может быть опущено только для поставщиков, которые не поддерживают несколько репозиториев.

Возвращаемое значение

Promise<RepositoryWebhook[]>

queueBuild(Build, string, boolean, string, number, number)

Ставит сборку в очередь

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

Параметры

build: Build

project: string

Идентификатор проекта или имя проекта

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

Необязательный идентификатор определения для постановки сборки в очередь без тела. Игнорируется, если есть допустимое тело

Возвращаемое значение

Promise<Build>

restoreDefinition(string, number, boolean)

Восстанавливает удаленное определение

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

Параметры

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор восстанавливаемого определения.

deleted: boolean

Если значение равно false, восстанавливается удаленное определение.

Возвращаемое значение

Promise<BuildDefinition>

restoreWebhooks(DefinitionTriggerType[], string, string, string, string)

Повторно создает вебхуки для указанных триггеров в заданном репозитории исходного кода.

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

Параметры

triggerTypes: DefinitionTriggerType[]

Типы триггеров для восстановления вебхуков.

project: string

Идентификатор проекта или имя проекта

providerName: string

Имя поставщика исходного кода.

serviceEndpointId: string

repository: string

Возвращаемое значение

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Обновляет существующий шаблон определения сборки.

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

Параметры

template: BuildDefinitionTemplate

Новая версия шаблона.

project: string

Идентификатор проекта или имя проекта

templateId: string

Идентификатор шаблона.

Возвращаемое значение

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Обновляет сборку.

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

Параметры

build: Build

Сборка.

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

retry: boolean

Возвращаемое значение

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Обновляет общие настройки конвейера.

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

Параметры

newSettings: PipelineGeneralSettings

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Обновляет свойства для сборки.

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

Параметры

document: JsonPatchDocument

Документ json-patch с описанием свойств для обновления.

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

Возвращаемое значение

Promise<any>

updateBuilds(Build[], string)

Обновляет несколько сборок.

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

Параметры

builds: Build[]

Сборки для обновления.

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Обновляет параметры сборки.

function updateBuildSettings(settings: BuildSettings, project?: string): Promise<BuildSettings>

Параметры

settings: BuildSettings

Новые настройки.

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Добавляет/удаляет теги из сборки.

function updateBuildTags(updateParameters: UpdateTagParameters, project: string, buildId: number): Promise<string[]>

Параметры

updateParameters: UpdateTagParameters

Теги для добавления/удаления.

project: string

Идентификатор проекта или имя проекта

buildId: number

Идентификатор сборки.

Возвращаемое значение

Promise<string[]>

updateDefinition(BuildDefinition, string, number, number, number)

Обновляет существующее определение сборки. Чтобы эта операция была выполнена успешно, значение свойства "Revision" тела запроса должно совпадать с значением существующего определения сборки. Рекомендуется получить существующее определение сборки с помощью GET, при необходимости изменить определение сборки, а затем отправить измененное определение с помощью PUT.

function updateDefinition(definition: BuildDefinition, project: string, definitionId: number, secretsSourceDefinitionId?: number, secretsSourceDefinitionRevision?: number): Promise<BuildDefinition>

Параметры

definition: BuildDefinition

Новая редакция определения. Его свойство "Revision" должно соответствовать существующему определению, чтобы обновление было принято.

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Возвращаемое значение

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Обновляет свойства определения.

function updateDefinitionProperties(document: JsonPatchDocument, project: string, definitionId: number): Promise<any>

Параметры

document: JsonPatchDocument

Документ json-patch с описанием свойств для обновления.

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

Возвращаемое значение

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Добавляет/удаляет теги из определения.

function updateDefinitionTags(updateParameters: UpdateTagParameters, project: string, definitionId: number): Promise<string[]>

Параметры

updateParameters: UpdateTagParameters

Теги для добавления/удаления.

project: string

Идентификатор проекта или имя проекта

definitionId: number

Идентификатор определения.

Возвращаемое значение

Promise<string[]>

updateFolder(Folder, string, string)

Обновляет существующую папку по заданному существующему пути

function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>

Параметры

folder: Folder

Новая версия папки.

project: string

Идентификатор проекта или имя проекта

path: string

Полный путь к папке.

Возвращаемое значение

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Обновляет срок действия или состояние защиты конвейера аренды с удержанием.

function updateRetentionLease(leaseUpdate: RetentionLeaseUpdate, project: string, leaseId: number): Promise<RetentionLease>

Параметры

leaseUpdate: RetentionLeaseUpdate

Новые данные для аренды удержания.

project: string

Идентификатор проекта или имя проекта

leaseId: number

Идентификатор аренды для обновления.

Возвращаемое значение

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Обновляет параметры хранения проекта.

function updateRetentionSettings(updateModel: UpdateProjectRetentionSettingModel, project: string): Promise<ProjectRetentionSetting>

Параметры

updateModel: UpdateProjectRetentionSettingModel

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Обновление этапа сборки

function updateStage(updateParameters: UpdateStageParameters, buildId: number, stageRefName: string, project?: string): Promise<void>

Параметры

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<void>

Обратная связь

Была ли эта страница полезна?

Поделиться через

BuildRestClient class

Конструкторы

Свойства

Методы

Сведения о конструкторе

BuildRestClient(IVssRestClientOptions)

Параметры

Сведения о свойстве

RESOURCE_AREA_ID

Значение свойства

Сведения о методе

addBuildTag(string, number, string)

Параметры

Возвращаемое значение

addBuildTags(string[], string, number)

Параметры

Возвращаемое значение

addDefinitionTag(string, number, string)

Параметры

Возвращаемое значение

addDefinitionTags(string[], string, number)

Параметры

Возвращаемое значение

addRetentionLeases(NewRetentionLease[], string)

Параметры

Возвращаемое значение

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Параметры

Возвращаемое значение

authorizeProjectResources(DefinitionResourceReference[], string)

Параметры

Возвращаемое значение

createArtifact(BuildArtifact, string, number)

Параметры

Возвращаемое значение

createDefinition(BuildDefinition, string, number, number)

Параметры

Возвращаемое значение

createFolder(Folder, string, string)

Параметры

Возвращаемое значение

deleteBuild(string, number)

Параметры

Возвращаемое значение

deleteBuildTag(string, number, string)

Параметры

Возвращаемое значение

deleteDefinition(string, number)

Параметры

Возвращаемое значение

deleteDefinitionTag(string, number, string)

Параметры

Возвращаемое значение

deleteFolder(string, string)

Параметры

Возвращаемое значение

deleteRetentionLeasesById(string, number[])

Параметры

Возвращаемое значение

deleteTag(string, string)

Параметры

Возвращаемое значение

deleteTemplate(string, string)

Параметры

Возвращаемое значение

getArtifact(string, number, string)

Параметры

Возвращаемое значение

getArtifactContentZip(string, number, string)

Параметры

Возвращаемое значение

getArtifacts(string, number)

Параметры

Возвращаемое значение

getAttachment(string, number, string, string, string, string)

Параметры

Возвращаемое значение

getAttachments(string, number, string)

Параметры