BuildRestClient class

Ссылка

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

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

Extends: RestClientBase

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

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)	Удаляет тег из сборки. Примечание. Этот 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)	Обновления существующее определение сборки. Чтобы эта операция завершилась успешно, значение свойства "Редакция" текста запроса должно соответствовать существующему определению сборки. Рекомендуется получить существующее определение сборки с помощью 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" для репозиториев, наиболее релевантных для конечной точки. Если значение не задано, возвращаются все репозитории. Игнорируется, если задан параметр "репозиторий".

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)

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

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

Параметры

definition: BuildDefinition

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

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)

Параметры