BuildRestClient class

Referência

Pacote:: azure-devops-extension-api

Classe base que deve ser usada (derivada de) para fazer solicitações para apis REST do VSS

Extends: RestClientBase

Construtores

BuildRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addBuildTag(string, number, string)	Adiciona uma marca a um build.
addBuildTags(string[], string, number)	Adiciona marcas a um build.
addDefinitionTag(string, number, string)	Adiciona uma marca a uma definição
addDefinitionTags(string[], string, number)	Adiciona várias marcas a uma definição.
addRetentionLeases(NewRetentionLease[], string)	Adiciona novas concessões para execuções de pipeline.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Associa um artefato a um build.
createDefinition(BuildDefinition, string, number, number)	Cria uma nova definição.
createFolder(Folder, string, string)	Cria uma nova pasta.
deleteBuild(string, number)	Exclui uma compilação.
deleteBuildTag(string, number, string)	Remove uma marca de um build. OBSERVAÇÃO: essa API não funcionará para marcas com caracteres especiais. Para remover marcas com caracteres especiais, use o método PATCH (em 6.0+)
deleteDefinition(string, number)	Exclui uma definição e todos os builds associados.
deleteDefinitionTag(string, number, string)	Remove uma marca de uma definição. OBSERVAÇÃO: essa API não funcionará para marcas com caracteres especiais. Para remover marcas com caracteres especiais, use o método PATCH (em 6.0+)
deleteFolder(string, string)	Exclui uma pasta de definição. As definições e seus builds correspondentes também serão excluídos.
deleteRetentionLeasesById(string, number[])	Remove concessões de retenção específicas.
deleteTag(string, string)	Remove uma marca de builds, definições e do repositório de marcas
deleteTemplate(string, string)	Exclui um modelo de definição de build.
getArtifact(string, number, string)	Obtém um artefato específico para um build.
getArtifactContentZip(string, number, string)	Obtém um artefato específico para um build.
getArtifacts(string, number)	Obtém todos os artefatos de um build.
getAttachment(string, number, string, string, string, string)	Obtém um anexo específico.
getAttachments(string, number, string)	Obtém a lista de anexos de um tipo específico associado a um build.
getBadge(string, number, string)	Obtém um selo que indica o status do build mais recente para uma definição. Observe que essa API foi preterida. Prefira StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Obtém um build
getBuildBadge(string, string, string, string)	Obtém um selo que indica o status do build mais recente para o branch especificado.
getBuildBadgeData(string, string, string, string)	Obtém um selo que indica o status do build mais recente para o branch especificado.
getBuildChanges(string, number, string, number, boolean)	Obtém as alterações associadas a um build
getBuildController(number)	Obtém um controlador
getBuildControllers(string)	Obtém o controlador, opcionalmente filtrado pelo nome
getBuildGeneralSettings(string)	Obtém as configurações gerais do pipeline.
getBuildLog(string, number, number, number, number)	Obtém um arquivo de log individual para um build.
getBuildLogLines(string, number, number, number, number)	Obtém um arquivo de log individual para um build.
getBuildLogs(string, number)	Obtém os logs de um build.
getBuildLogsZip(string, number)	Obtém os logs de um build.
getBuildLogZip(string, number, number, number, number)	Obtém um arquivo de log individual para um build.
getBuildOptionDefinitions(string)	Obtém todas as opções de definição de build compatíveis com o sistema.
getBuildProperties(string, number, string[])	Obtém propriedades de um build.
getBuildReport(string, number, string)	Obtém um relatório de build.
getBuildReportHtmlContent(string, number, string)	Obtém um relatório de build.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Obtém uma lista de builds.
getBuildSettings(string)	Obtém as configurações de build.
getBuildTags(string, number)	Obtém as marcas de um build.
getBuildTimeline(string, number, string, number, string)	Obtém detalhes de um build
getBuildWorkItemsRefs(string, number, number)	Obtém os itens de trabalho associados a um build. Somente itens de trabalho no mesmo projeto são retornados.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Obtém os itens de trabalho associados a um build, filtrados para commits específicos.
getChangesBetweenBuilds(string, number, number, number)	Obtém as alterações feitas no repositório entre dois builds determinados.
getDefinition(string, number, number, Date, string[], boolean)	Obtém uma definição, opcionalmente em uma revisão específica.
getDefinitionMetrics(string, number, Date)	Obtém métricas de build para uma definição.
getDefinitionProperties(string, number, string[])	Obtém propriedades para uma definição.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Obtém todas as revisões de uma definição.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Obtém uma lista de definições.
getDefinitionTags(string, number, number)	Obtém as marcas de uma definição.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Converte uma definição em YAML, opcionalmente em uma revisão específica.
getFile(string, number, string, string, string)	Obtém um arquivo do build.
getFileContents(string, string, string, string, string, string)	Obtém o conteúdo de um arquivo no repositório de código-fonte especificado.
getFolders(string, string, FolderQueryOrder)	Obtém uma lista de pastas de definição de build.
getLatestBuild(string, string, string)	Obtém o build mais recente para uma definição, opcionalmente com escopo para um branch específico.
getPathContents(string, string, string, string, string, string)	Obtém o conteúdo de um diretório no repositório de código-fonte especificado.
getProjectMetrics(string, string, Date)	Obtém métricas de build para um projeto.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Obtém um objeto de solicitação de pull do provedor de origem.
getResourceUsage()	Obtém informações sobre recursos de build no sistema.
getRetentionHistory(number)	Retorna o histórico de retenção da coleção de projetos. Isso inclui pipelines que têm regras de retenção personalizadas que podem impedir que o trabalho de retenção os limpe, execuções por pipeline com tipo de retenção, arquivos associados a pipelines pertencentes à coleção com tipo de retenção e o número de arquivos por pipeline.
getRetentionLease(string, number)	Retorna os detalhes da concessão de retenção dada uma ID de concessão.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Retorna quaisquer concessões que correspondam ao MinimalRetentionLeases especificado
getRetentionLeasesByOwnerId(string, string, number, number)	Retorna quaisquer concessões pertencentes à entidade especificada, opcionalmente com escopo para uma única definição de pipeline e execução.
getRetentionLeasesByUserId(string, string, number, number)	Retorna quaisquer concessões pertencentes ao usuário especificado, opcionalmente com escopo para uma única definição de pipeline e execução.
getRetentionLeasesForBuild(string, number)	Obtém todas as concessões de retenção que se aplicam a um build específico.
getRetentionSettings(string)	Obtém as configurações de retenção do projeto.
getStatusBadge(string, string, string, string, string, string, string)	<p>Obtém o status de build para uma definição, opcionalmente com escopo para um branch, estágio, trabalho e configuração específicos.< /p><p>Se houver mais de um, será necessário passar um valor stageName ao especificar um jobName e a mesma regra se aplicará a ambos se passar um parâmetro de configuração.< /P>
getTags(string)	Obtém uma lista de todas as marcas de build no projeto.
getTemplate(string, string)	Obtém um modelo de definição de build específico.
getTemplates(string)	Obtém todos os modelos de definição.
getWorkItemsBetweenBuilds(string, number, number, number)	Obtém todos os itens de trabalho entre dois builds.
listBranches(string, string, string, string, string)	Obtém uma lista de branches para o repositório de código-fonte especificado.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Obtém uma lista de repositórios de código-fonte.
listSourceProviders(string)	Obtenha uma lista de provedores de origem e seus recursos.
listWebhooks(string, string, string, string)	Obtém uma lista de webhooks instalados no repositório de código-fonte especificado.
queueBuild(Build, string, boolean, string, number, number)	Enfileira um build
restoreDefinition(string, number, boolean)	Restaura uma definição excluída
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Recria os webhooks para os gatilhos especificados no repositório de código-fonte especificado.
saveTemplate(BuildDefinitionTemplate, string, string)	Atualizações um modelo de definição de build existente.
updateBuild(Build, string, number, boolean)	Atualizações um build.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Atualizações configurações gerais do pipeline.
updateBuildProperties(JsonPatchDocument, string, number)	Atualizações propriedades de um build.
updateBuilds(Build[], string)	Atualizações várias compilações.
updateBuildSettings(BuildSettings, string)	Atualizações as configurações de build.
updateBuildTags(UpdateTagParameters, string, number)	Adiciona/remove marcas de um build.
updateDefinition(BuildDefinition, string, number, number, number)	Atualizações uma definição de build existente. Para que essa operação seja bem-sucedida, o valor da propriedade "Revision" do corpo da solicitação deve corresponder ao da definição de build existente. É recomendável que você obtenha a definição de build existente usando GET, modifique a definição de build conforme necessário e envie a definição modificada com PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	Atualizações propriedades para uma definição.
updateDefinitionTags(UpdateTagParameters, string, number)	Adiciona/remove marcas de uma definição.
updateFolder(Folder, string, string)	Atualizações uma pasta existente em determinado caminho existente
updateRetentionLease(RetentionLeaseUpdate, string, number)	Atualizações a duração ou a proteção de pipeline status de uma concessão de retenção.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Atualizações as configurações de retenção do projeto.
updateStage(UpdateStageParameters, number, string, string)	Atualizar um estágio de build

Detalhes do construtor

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes da propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do método

addBuildTag(string, number, string)

Adiciona uma marca a um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

tag: string

A marca a ser adicionada.

Retornos

Promise<string[]>

addBuildTags(string[], string, number)

Adiciona marcas a um build.

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

Parâmetros

tags: string[]

As marcas a serem adicionadas. O corpo da solicitação é composto diretamente de marcas listadas.

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

Retornos

Promise<string[]>

addDefinitionTag(string, number, string)

Adiciona uma marca a uma definição

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

tag: string

A marca a ser adicionada.

Retornos

Promise<string[]>

addDefinitionTags(string[], string, number)

Adiciona várias marcas a uma definição.

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

Parâmetros

tags: string[]

As marcas a serem adicionadas.

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

Retornos

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Adiciona novas concessões para execuções de pipeline.

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

Parâmetros

newLeases: NewRetentionLease[]

project: string

ID do projeto ou nome do projeto

Retornos

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

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

Parâmetros

resources: DefinitionResourceReference[]

project: string

ID do projeto ou nome do projeto

definitionId: number

Retornos

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

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

Parâmetros

resources: DefinitionResourceReference[]

project: string

ID do projeto ou nome do projeto

Retornos

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Associa um artefato a um build.

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

Parâmetros

artifact: BuildArtifact

O artefato.

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

Retornos

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Cria uma nova definição.

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

Parâmetros

definition: BuildDefinition

A definição.

project: string

ID do projeto ou nome do projeto

definitionToCloneId: number

definitionToCloneRevision: number

Retornos

Promise<BuildDefinition>

createFolder(Folder, string, string)

Cria uma nova pasta.

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

Parâmetros

folder: Folder

A pasta.

project: string

ID do projeto ou nome do projeto

path: string

O caminho completo da pasta.

Retornos

Promise<Folder>

deleteBuild(string, number)

Exclui uma compilação.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

Retornos

Promise<void>

deleteBuildTag(string, number, string)

Remove uma marca de um build. OBSERVAÇÃO: essa API não funcionará para marcas com caracteres especiais. Para remover marcas com caracteres especiais, use o método PATCH (em 6.0+)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

tag: string

A marca a ser removida.

Retornos

Promise<string[]>

deleteDefinition(string, number)

Exclui uma definição e todos os builds associados.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

Retornos

Promise<void>

deleteDefinitionTag(string, number, string)

Remove uma marca de uma definição. OBSERVAÇÃO: essa API não funcionará para marcas com caracteres especiais. Para remover marcas com caracteres especiais, use o método PATCH (em 6.0+)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

tag: string

A marca a ser removida.

Retornos

Promise<string[]>

deleteFolder(string, string)

Exclui uma pasta de definição. As definições e seus builds correspondentes também serão excluídos.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

path: string

O caminho completo para a pasta.

Retornos

Promise<void>

deleteRetentionLeasesById(string, number[])

Remove concessões de retenção específicas.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

ids: number[]

Retornos

Promise<void>

deleteTag(string, string)

Remove uma marca de builds, definições e do repositório de marcas

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

Parâmetros

project: string

ID do projeto ou nome do projeto

tag: string

A marca a ser removida.

Retornos

Promise<string[]>

deleteTemplate(string, string)

Exclui um modelo de definição de build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

templateId: string

A ID do modelo.

Retornos

Promise<void>

getArtifact(string, number, string)

Obtém um artefato específico para um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

artifactName: string

O nome do artefato.

Retornos

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Obtém um artefato específico para um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

artifactName: string

O nome do artefato.

Retornos

Promise<ArrayBuffer>

getArtifacts(string, number)

Obtém todos os artefatos de um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

Retornos

Promise<BuildArtifact[]>

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

Obtém um anexo específico.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

timelineId: string

A ID do linha do tempo.

recordId: string

A ID do registro linha do tempo.

type: string

O tipo do anexo.

name: string

O nome do anexo.

Retornos

Promise<ArrayBuffer>

getAttachments(string, number, string)

Obtém a lista de anexos de um tipo específico associado a um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

type: string

O tipo de anexo.

Retornos

Promise<Attachment[]>

getBadge(string, number, string)

Obtém um selo que indica o status do build mais recente para uma definição. Observe que essa API foi preterida. Prefira StatusBadgeController.GetStatusBadge.

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

Parâmetros

project: string

A ID ou o nome do projeto.

definitionId: number

A ID da definição.

branchName: string

O nome do branch.

Retornos

Promise<string>

getBuild(string, number, string)

Obtém um build

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

propertyFilters: string

Retornos

Promise<Build>

getBuildBadge(string, string, string, string)

Obtém um selo que indica o status do build mais recente para o branch especificado.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

repoType: string

O tipo de repositório.

repoId: string

A ID do repositório.

branchName: string

O nome do branch.

Retornos

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Obtém um selo que indica o status do build mais recente para o branch especificado.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

repoType: string

O tipo de repositório.

repoId: string

A ID do repositório.

branchName: string

O nome do branch.

Retornos

Promise<string>

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

Obtém as alterações associadas a um build

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

continuationToken: string

top: number

O número máximo de alterações a serem retornadas

includeSourceChange: boolean

Retornos

Promise<PagedList<Change>>

getBuildController(number)

Obtém um controlador

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

Parâmetros

controllerId: number

Retornos

Promise<BuildController>

getBuildControllers(string)

Obtém o controlador, opcionalmente filtrado pelo nome

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

Parâmetros

name: string

Retornos

Promise<BuildController[]>

getBuildGeneralSettings(string)

Obtém as configurações gerais do pipeline.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<PipelineGeneralSettings>

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

Obtém um arquivo de log individual para um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

logId: number

A ID do arquivo de log.

startLine: number

A linha inicial.

endLine: number

A linha final.

Retornos

Promise<string>

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

Obtém um arquivo de log individual para um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

logId: number

A ID do arquivo de log.

startLine: number

A linha inicial.

endLine: number

A linha final.

Retornos

Promise<string[]>

getBuildLogs(string, number)

Obtém os logs de um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

Retornos

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Obtém os logs de um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

Retornos

Promise<ArrayBuffer>

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

Obtém um arquivo de log individual para um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

logId: number

A ID do arquivo de log.

startLine: number

A linha inicial.

endLine: number

A linha final.

Retornos

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Obtém todas as opções de definição de build compatíveis com o sistema.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Obtém propriedades de um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

filter: string[]

Uma lista delimitada por vírgulas de propriedades. Se especificado, filtra para essas propriedades específicas.

Retornos

Promise<any>

getBuildReport(string, number, string)

Obtém um relatório de build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

type: string

Retornos

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Obtém um relatório de build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

type: string

Retornos

Promise<any>

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

Obtém uma lista de builds.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitions: number[]

Uma lista delimitada por vírgulas de IDs de definição. Se especificado, filtra para compilações para essas definições.

queues: number[]

Uma lista delimitada por vírgulas de IDs de fila. Se especificado, filtra para builds executados nessas filas.

buildNumber: string

Se especificado, filtra para builds que correspondem a esse número de build. Acrescentar * para fazer uma pesquisa de prefixo.

minTime: Date

Se especificado, filtra para builds concluídos/iniciados/enfileirados após essa data com base na consultaOrder especificada.

maxTime: Date

Se especificado, filtra para builds concluídos/iniciados/enfileirados antes dessa data com base na consultaOrder especificada.

requestedFor: string

Se especificado, filtra os builds solicitados para o usuário especificado.

reasonFilter: BuildReason

Se especificado, filtra para builds que correspondem a esse motivo.

statusFilter: BuildStatus

Se especificado, filtra para builds que correspondem a esse status.

resultFilter: BuildResult

Se especificado, filtra para builds que correspondem a esse resultado.

tagFilters: string[]

Uma lista delimitada por vírgulas de marcas. Se especificado, filtra para builds que têm as marcas especificadas.

properties: string[]

Uma lista delimitada por vírgulas de propriedades a serem recuperadas.

top: number

O número máximo de builds a serem retornados.

continuationToken: string

Um token de continuação, retornado por uma chamada anterior a esse método, que pode ser usado para retornar o próximo conjunto de builds.

maxBuildsPerDefinition: number

O número máximo de builds a serem retornados por definição.

deletedFilter: QueryDeletedOption

Indica se deve excluir, incluir ou retornar apenas builds excluídos.

queryOrder: BuildQueryOrder

A ordem na qual os builds devem ser retornados.

branchName: string

Se especificado, filtra para compilações que criaram branches que criaram esse branch.

buildIds: number[]

Uma lista delimitada por vírgulas que especifica as IDs de builds a serem recuperadas.

repositoryId: string

Se especificado, filtra para compilações criadas a partir desse repositório.

repositoryType: string

Se especificado, filtra para builds criados a partir de repositórios desse tipo.

Retornos

Promise<PagedList<Build>>

getBuildSettings(string)

Obtém as configurações de build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<BuildSettings>

getBuildTags(string, number)

Obtém as marcas de um build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

Retornos

Promise<string[]>

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

Obtém detalhes de um build

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

timelineId: string

changeId: number

planId: string

Retornos

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Obtém os itens de trabalho associados a um build. Somente itens de trabalho no mesmo projeto são retornados.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

top: number

O número máximo de itens de trabalho a serem retornados.

Retornos

Promise<ResourceRef[]>

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

Obtém os itens de trabalho associados a um build, filtrados para commits específicos.

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

Parâmetros

commitIds: string[]

Uma lista delimitada por vírgulas de IDs de commit.

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

top: number

O número máximo de itens de trabalho a serem retornados ou o número de commits a serem considerados se nenhuma ID de confirmação for especificada.

Retornos

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Obtém as alterações feitas no repositório entre dois builds determinados.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

fromBuildId: number

A ID do primeiro build.

toBuildId: number

A ID do último build.

top: number

O número máximo de alterações a serem retornadas.

Retornos

Promise<Change[]>

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

Obtém uma definição, opcionalmente em uma revisão específica.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

revision: number

O número de revisão a ser recuperado. Se isso não for especificado, a versão mais recente será retornada.

minMetricsTime: Date

Se especificado, indica a data da qual as métricas devem ser incluídas.

propertyFilters: string[]

Uma lista delimitada por vírgulas de propriedades a serem incluídas nos resultados.

includeLatestBuilds: boolean

Retornos

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Obtém métricas de build para uma definição.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

minMetricsTime: Date

A data da qual calcular as métricas.

Retornos

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Obtém propriedades para uma definição.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

filter: string[]

Uma lista delimitada por vírgulas de propriedades. Se especificado, filtra para essas propriedades específicas.

Retornos

Promise<any>

getDefinitionResources(string, number)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

Retornos

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Obtém todas as revisões de uma definição.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

Retornos

Promise<BuildDefinitionRevision[]>

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

Obtém uma lista de definições.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

name: string

Se especificado, filtra para definições cujos nomes correspondem a esse padrão.

repositoryId: string

Uma ID do repositório. Se especificado, filtra para definições que usam esse repositório.

repositoryType: string

Se especificado, filtra para definições que têm um repositório desse tipo.

queryOrder: DefinitionQueryOrder

Indica a ordem na qual as definições devem ser retornadas.

top: number

O número máximo de definições a serem retornadas.

continuationToken: string

Um token de continuação, retornado por uma chamada anterior a esse método, que pode ser usado para retornar o próximo conjunto de definições.

minMetricsTime: Date

Se especificado, indica a data da qual as métricas devem ser incluídas.

definitionIds: number[]

Uma lista delimitada por vírgulas que especifica as IDs de definições a serem recuperadas.

path: string

Se especificado, filtra para definições nessa pasta.

builtAfter: Date

Se especificado, filtra para definições que têm builds após essa data.

notBuiltAfter: Date

Se especificado, filtra para definições que não têm builds após essa data.

includeAllProperties: boolean

Indica se as definições completas devem ser retornadas. Por padrão, as representações superficial das definições são retornadas.

includeLatestBuilds: boolean

Indica se os builds concluídos mais recentes e mais recentes devem ser retornados para essa definição.

taskIdFilter: string

Se especificado, filtra para definições que usam a tarefa especificada.

processType: number

Se especificado, filtra para definições com o tipo de processo fornecido.

yamlFilename: string

Se especificado, filtra para definições YAML que correspondem ao nome de arquivo especificado. Para usar esse filtro, includeAllProperties deve ser definido como true

Retornos

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Obtém as marcas de uma definição.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

revision: number

O número de revisão de definição. Se não for especificado, usará a revisão mais recente da definição.

Retornos

Promise<string[]>

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

Converte uma definição em YAML, opcionalmente em uma revisão específica.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

revision: number

O número de revisão a ser recuperado. Se isso não for especificado, a versão mais recente será retornada.

minMetricsTime: Date

Se especificado, indica a data da qual as métricas devem ser incluídas.

propertyFilters: string[]

Uma lista delimitada por vírgulas de propriedades a serem incluídas nos resultados.

includeLatestBuilds: boolean

Retornos

Promise<YamlBuild>

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

Obtém um arquivo do build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

artifactName: string

O nome do artefato.

fileId: string

A chave primária para o arquivo.

fileName: string

O nome para o qual o arquivo será definido.

Retornos

Promise<ArrayBuffer>

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

Obtém o conteúdo de um arquivo no repositório de código-fonte especificado.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

providerName: string

O nome do provedor de origem.

serviceEndpointId: string

Se especificado, a ID do ponto de extremidade de serviço a ser consultado. Só pode ser omitido para provedores que não usam pontos de extremidade de serviço, por exemplo, TFVC ou TFGit.

repository: string

Se especificado, o identificador específico do fornecedor ou o nome do repositório para obter branches. Só pode ser omitido para provedores que não dão suporte a vários repositórios.

commitOrBranch: string

O identificador do commit ou branch do qual o conteúdo de um arquivo é recuperado.

path: string

O caminho para o arquivo a ser recuperado, em relação à raiz do repositório.

Retornos

Promise<string>

getFolders(string, string, FolderQueryOrder)

Obtém uma lista de pastas de definição de build.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

path: string

O caminho com o qual começar.

queryOrder: FolderQueryOrder

A ordem na qual as pastas devem ser retornadas.

Retornos

Promise<Folder[]>

getLatestBuild(string, string, string)

Obtém o build mais recente para uma definição, opcionalmente com escopo para um branch específico.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definition: string

nome da definição com caminho de pasta à esquerda opcional ou a ID de definição

branchName: string

parâmetro opcional que indica o branch específico a ser usado. Se não for especificado, o branch padrão será usado.

Retornos

Promise<Build>

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

Obtém o conteúdo de um diretório no repositório de código-fonte especificado.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

providerName: string

O nome do provedor de origem.

serviceEndpointId: string

Se especificado, a ID do ponto de extremidade de serviço a ser consultado. Só pode ser omitido para provedores que não usam pontos de extremidade de serviço, por exemplo, TFVC ou TFGit.

repository: string

Se especificado, o identificador específico do fornecedor ou o nome do repositório para obter branches. Só pode ser omitido para provedores que não dão suporte a vários repositórios.

commitOrBranch: string

O identificador do commit ou branch do qual o conteúdo de um arquivo é recuperado.

path: string

O conteúdo do caminho a ser listado, em relação à raiz do repositório.

Retornos

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Obtém métricas de build para um projeto.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

metricAggregationType: string

O tipo de agregação a ser usado (por hora, diariamente).

minMetricsTime: Date

A data da qual calcular as métricas.

Retornos

Promise<BuildMetric[]>

getProjectResources(string, string, string)

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

Parâmetros

project: string

ID do projeto ou nome do projeto

type: string

id: string

Retornos

Promise<DefinitionResourceReference[]>

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

Obtém um objeto de solicitação de pull do provedor de origem.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

providerName: string

O nome do provedor de origem.

pullRequestId: string

ID específica do fornecedor da solicitação de pull.

repositoryId: string

Identificador específico do fornecedor ou o nome do repositório que contém a solicitação de pull.

serviceEndpointId: string

Se especificado, a ID do ponto de extremidade de serviço a ser consultado. Só pode ser omitido para provedores que não usam pontos de extremidade de serviço, por exemplo, TFVC ou TFGit.

Retornos

Promise<PullRequest>

getResourceUsage()

Obtém informações sobre recursos de build no sistema.

function getResourceUsage(): Promise<BuildResourceUsage>

Retornos

Promise<BuildResourceUsage>

getRetentionHistory(number)

Retorna o histórico de retenção da coleção de projetos. Isso inclui pipelines que têm regras de retenção personalizadas que podem impedir que o trabalho de retenção os limpe, execuções por pipeline com tipo de retenção, arquivos associados a pipelines pertencentes à coleção com tipo de retenção e o número de arquivos por pipeline.

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

Parâmetros

daysToLookback: number

Retornos

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Retorna os detalhes da concessão de retenção dada uma ID de concessão.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

leaseId: number

Retornos

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Retorna quaisquer concessões que correspondam ao MinimalRetentionLeases especificado

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

Parâmetros

project: string

ID do projeto ou nome do projeto

leasesToFetch: MinimalRetentionLease[]

Lista de MinimalRetentionLeases serializados por JSON separados por '|'

Retornos

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Retorna quaisquer concessões pertencentes à entidade especificada, opcionalmente com escopo para uma única definição de pipeline e execução.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

ownerId: string

definitionId: number

Um parâmetro opcional para limitar a pesquisa a uma definição de pipeline específica.

runId: number

Um parâmetro opcional para limitar a pesquisa a uma única execução de pipeline. Requer definitionId.

Retornos

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Retorna quaisquer concessões pertencentes ao usuário especificado, opcionalmente com escopo para uma única definição de pipeline e execução.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

userOwnerId: string

A ID de usuário a ser pesquisada.

definitionId: number

Um parâmetro opcional para limitar a pesquisa a uma definição de pipeline específica.

runId: number

Um parâmetro opcional para limitar a pesquisa a uma única execução de pipeline. Requer definitionId.

Retornos

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Obtém todas as concessões de retenção que se aplicam a um build específico.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

Retornos

Promise<RetentionLease[]>

getRetentionSettings(string)

Obtém as configurações de retenção do projeto.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<ProjectRetentionSetting>

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

<p>Obtém o status de build para uma definição, opcionalmente com escopo para um branch, estágio, trabalho e configuração específicos.< /p><p>Se houver mais de um, será necessário passar um valor stageName ao especificar um jobName e a mesma regra se aplicará a ambos se passar um parâmetro de configuração.< /P>

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definition: string

O nome da definição com o caminho da pasta à esquerda opcional ou a ID de definição.

branchName: string

Considere apenas o build mais recente para esse branch. Se não for especificado, o branch padrão será usado.

stageName: string

Use esse estágio dentro do pipeline para renderizar o status.

jobName: string

Use esse trabalho em um estágio do pipeline para renderizar o status.

configuration: string

Use essa configuração de trabalho para renderizar o status

label: string

Substitui o texto padrão no lado esquerdo do selo.

Retornos

Promise<string>

getTags(string)

Obtém uma lista de todas as marcas de build no projeto.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<string[]>

getTemplate(string, string)

Obtém um modelo de definição de build específico.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

templateId: string

A ID do modelo solicitado.

Retornos

Promise<BuildDefinitionTemplate>

getTemplates(string)

Obtém todos os modelos de definição.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Obtém todos os itens de trabalho entre dois builds.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

fromBuildId: number

A ID do primeiro build.

toBuildId: number

A ID do último build.

top: number

O número máximo de itens de trabalho a serem retornados.

Retornos

Promise<ResourceRef[]>

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

Obtém uma lista de branches para o repositório de código-fonte especificado.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

providerName: string

O nome do provedor de origem.

serviceEndpointId: string

Se especificado, a ID do ponto de extremidade de serviço a ser consultado. Só pode ser omitido para provedores que não usam pontos de extremidade de serviço, por exemplo, TFVC ou TFGit.

repository: string

O identificador específico do fornecedor ou o nome do repositório para obter branches. Só pode ser omitido para provedores que não dão suporte a vários repositórios.

branchName: string

Se fornecido, o nome do branch para marcar especificamente.

Retornos

Promise<string[]>

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

Obtém uma lista de repositórios de código-fonte.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

providerName: string

O nome do provedor de origem.

serviceEndpointId: string

Se especificado, a ID do ponto de extremidade de serviço a ser consultado. Só pode ser omitido para provedores que não usam pontos de extremidade de serviço, por exemplo, TFVC ou TFGit.

repository: string

Se especificado, o identificador específico do fornecedor ou o nome de um único repositório a ser obtido.

resultSet: ResultSet

'top' para os repositórios mais relevantes para o ponto de extremidade. Se não estiver definido, todos os repositórios serão retornados. Ignorado se 'repositório' estiver definido.

pageResults: boolean

Se definido como true, isso limitará o conjunto de resultados e retornará um token de continuação para continuar a consulta.

continuationToken: string

Ao paginar os resultados, esse é um token de continuação, retornado por uma chamada anterior a esse método, que pode ser usado para retornar o próximo conjunto de repositórios.

Retornos

Promise<SourceRepositories>

listSourceProviders(string)

Obtenha uma lista de provedores de origem e seus recursos.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Obtém uma lista de webhooks instalados no repositório de código-fonte especificado.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

providerName: string

O nome do provedor de origem.

serviceEndpointId: string

Se especificado, a ID do ponto de extremidade de serviço a ser consultado. Só pode ser omitido para provedores que não usam pontos de extremidade de serviço, por exemplo, TFVC ou TFGit.

repository: string

Se especificado, o identificador específico do fornecedor ou o nome do repositório para obter webhooks. Só pode ser omitido para provedores que não dão suporte a vários repositórios.

Retornos

Promise<RepositoryWebhook[]>

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

Enfileira um build

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

Parâmetros

build: Build

project: string

ID do projeto ou nome do projeto

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

ID de definição opcional para enfileirar um build sem um corpo. Ignorado se houver um corpo válido

Retornos

Promise<Build>

restoreDefinition(string, number, boolean)

Restaura uma definição excluída

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

O identificador da definição a ser restaurada.

deleted: boolean

Quando false, restaura uma definição excluída.

Retornos

Promise<BuildDefinition>

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

Recria os webhooks para os gatilhos especificados no repositório de código-fonte especificado.

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

Parâmetros

triggerTypes: DefinitionTriggerType[]

Os tipos de gatilhos para os quais restaurar webhooks.

project: string

ID do projeto ou nome do projeto

providerName: string

O nome do provedor de origem.

serviceEndpointId: string

Se especificado, a ID do ponto de extremidade de serviço a ser consultado. Só pode ser omitido para provedores que não usam pontos de extremidade de serviço, por exemplo, TFVC ou TFGit.

repository: string

Se especificado, o identificador específico do fornecedor ou o nome do repositório para obter webhooks. Só pode ser omitido para provedores que não dão suporte a vários repositórios.

Retornos

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Atualizações um modelo de definição de build existente.

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

Parâmetros

template: BuildDefinitionTemplate

A nova versão do modelo.

project: string

ID do projeto ou nome do projeto

templateId: string

A ID do modelo.

Retornos

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Atualizações um build.

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

Parâmetros

build: Build

O build.

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

retry: boolean

Retornos

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Atualizações configurações gerais do pipeline.

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

Parâmetros

newSettings: PipelineGeneralSettings

project: string

ID do projeto ou nome do projeto

Retornos

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Atualizações propriedades de um build.

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

Parâmetros

document: JsonPatchDocument

Um documento json-patch que descreve as propriedades a serem atualizadas.

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

Retornos

Promise<any>

updateBuilds(Build[], string)

Atualizações várias compilações.

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

Parâmetros

builds: Build[]

Os builds a serem atualizados.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Atualizações as configurações de build.

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

Parâmetros

settings: BuildSettings

As novas configurações.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Adiciona/remove marcas de um build.

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

Parâmetros

updateParameters: UpdateTagParameters

As marcas a serem adicionadas/removidas.

project: string

ID do projeto ou nome do projeto

buildId: number

A ID do build.

Retornos

Promise<string[]>

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

Atualizações uma definição de build existente. Para que essa operação seja bem-sucedida, o valor da propriedade "Revision" do corpo da solicitação deve corresponder ao da definição de build existente. É recomendável que você obtenha a definição de build existente usando GET, modifique a definição de build conforme necessário e envie a definição modificada com PUT.

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

Parâmetros

definition: BuildDefinition

A nova versão da definição. Sua propriedade "Revision" deve corresponder à definição existente para que a atualização seja aceita.

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Retornos

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Atualizações propriedades para uma definição.

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

Parâmetros

document: JsonPatchDocument

Um documento json-patch que descreve as propriedades a serem atualizadas.

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

Retornos

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Adiciona/remove marcas de uma definição.

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

Parâmetros

updateParameters: UpdateTagParameters

As marcas a serem adicionadas/removidas.

project: string

ID do projeto ou nome do projeto

definitionId: number

A ID da definição.

Retornos

Promise<string[]>

updateFolder(Folder, string, string)

Atualizações uma pasta existente em determinado caminho existente

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

Parâmetros

folder: Folder

A nova versão da pasta.

project: string

ID do projeto ou nome do projeto

path: string

O caminho completo para a pasta.

Retornos

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Atualizações a duração ou a proteção de pipeline status de uma concessão de retenção.

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

Parâmetros

leaseUpdate: RetentionLeaseUpdate

Os novos dados para a concessão de retenção.

project: string

ID do projeto ou nome do projeto

leaseId: number

A ID da concessão a ser atualizada.

Retornos

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Atualizações as configurações de retenção do projeto.

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

Parâmetros

updateModel: UpdateProjectRetentionSettingModel

project: string

ID do projeto ou nome do projeto

Retornos

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Atualizar um estágio de build

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

Parâmetros

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

Compartilhar via

BuildRestClient class

Construtores

Propriedades

Métodos

Detalhes do construtor

BuildRestClient(IVssRestClientOptions)

Parâmetros

Detalhes da propriedade

RESOURCE_AREA_ID

Valor da propriedade

Detalhes do método

addBuildTag(string, number, string)

Parâmetros

Retornos

addBuildTags(string[], string, number)

Parâmetros

Retornos

addDefinitionTag(string, number, string)

Parâmetros

Retornos

addDefinitionTags(string[], string, number)

Parâmetros

Retornos

addRetentionLeases(NewRetentionLease[], string)

Parâmetros

Retornos

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parâmetros

Retornos

authorizeProjectResources(DefinitionResourceReference[], string)

Parâmetros

Retornos

createArtifact(BuildArtifact, string, number)

Parâmetros

Retornos

createDefinition(BuildDefinition, string, number, number)

Parâmetros

Retornos

createFolder(Folder, string, string)

Parâmetros

Retornos

deleteBuild(string, number)

Parâmetros

Retornos

deleteBuildTag(string, number, string)

Parâmetros

Retornos

deleteDefinition(string, number)

Parâmetros

Retornos

deleteDefinitionTag(string, number, string)

Parâmetros

Retornos

deleteFolder(string, string)

Parâmetros

Retornos

deleteRetentionLeasesById(string, number[])

Parâmetros

Retornos

deleteTag(string, string)

Parâmetros

Retornos

deleteTemplate(string, string)

Parâmetros

Retornos

getArtifact(string, number, string)

Parâmetros

Retornos

getArtifactContentZip(string, number, string)

Parâmetros

Retornos

getArtifacts(string, number)

Parâmetros

Retornos

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

Parâmetros

Retornos

getAttachments(string, number, string)

Parâmetros