BuildRestClient class

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

Propriedades

Métodos

addBuildTag(string, number, string)	Adiciona uma tag a uma compilação.
addBuildTags(string[], string, number)	Adiciona tags a uma compilação.
addDefinitionTag(string, number, string)	Adiciona uma tag a uma definição
addDefinitionTags(string[], string, number)	Adiciona várias tags 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 uma compilação.
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 tag de uma compilação. NOTA: Esta API não funcionará para etiquetas com carateres especiais. Para remover tags com caracteres especiais, use o método PATCH em vez disso (em 6.0+)
deleteDefinition(string, number)	Exclui uma definição e todas as compilações associadas.
deleteDefinitionTag(string, number, string)	Remove uma tag de uma definição. NOTA: Esta API não funcionará para etiquetas com carateres especiais. Para remover tags com caracteres especiais, use o método PATCH em vez disso (em 6.0+)
deleteFolder(string, string)	Exclui uma pasta de definição. As definições e suas compilações correspondentes também serão excluídas.
deleteRetentionLeasesById(string, number[])	Remove concessões de retenção específicas.
deleteTag(string, string)	Remove uma tag de compilações, definições e do repositório de tags
deleteTemplate(string, string)	Exclui um modelo de definição de compilação.
getArtifact(string, number, string)	Obtém um artefato específico para uma compilação.
getArtifactContentZip(string, number, string)	Obtém um artefato específico para uma compilação.
getArtifacts(string, number)	Obtém todos os artefatos para uma compilação.
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 que estão associados a uma compilação.
getBadge(string, number, string)	Obtém um selo que indica o status da compilação mais recente para uma definição. Observe que essa API foi preterida. Prefira StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Obtém uma compilação
getBuildBadge(string, string, string, string)	Obtém um selo que indica o status da compilação mais recente para a ramificação especificada.
getBuildBadgeData(string, string, string, string)	Obtém um selo que indica o status da compilação mais recente para a ramificação especificada.
getBuildChanges(string, number, string, number, boolean)	Obtém as alterações associadas a uma compilação
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 uma compilação.
getBuildLogLines(string, number, number, number, number)	Obtém um arquivo de log individual para uma compilação.
getBuildLogs(string, number)	Obtém os logs para uma compilação.
getBuildLogsZip(string, number)	Obtém os logs para uma compilação.
getBuildLogZip(string, number, number, number, number)	Obtém um arquivo de log individual para uma compilação.
getBuildOptionDefinitions(string)	Obtém todas as opções de definição de compilação suportadas pelo sistema.
getBuildProperties(string, number, string[])	Obtém propriedades para uma compilação.
getBuildReport(string, number, string)	Obtém um relatório de compilação.
getBuildReportHtmlContent(string, number, string)	Obtém um relatório de compilação.
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 compilações.
getBuildSettings(string)	Obtém as configurações de compilação.
getBuildTags(string, number)	Obtém as tags para uma compilação.
getBuildTimeline(string, number, string, number, string)	Obtém detalhes para uma compilação
getBuildWorkItemsRefs(string, number, number)	Obtém os itens de trabalho associados a uma compilação. Somente itens de trabalho no mesmo projeto são retornados.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Obtém os itens de trabalho associados a uma compilação, filtrados para confirmações específicas.
getChangesBetweenBuilds(string, number, number, number)	Obtém as alterações feitas no repositório entre duas compilações determinadas.
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 compilação 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 tags para 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 da compilação.
getFileContents(string, string, string, string, string, string)	Obtém o conteúdo de um arquivo no repositório de código-fonte fornecido.
getFolders(string, string, FolderQueryOrder)	Obtém uma lista de pastas de definição de compilação.
getLatestBuild(string, string, string)	Obtém a compilação mais recente para uma definição, opcionalmente com escopo para uma ramificação específica.
getPathContents(string, string, string, string, string, string)	Obtém o conteúdo de um diretório no repositório de código-fonte fornecido.
getProjectMetrics(string, string, Date)	Obtém métricas de compilação para um projeto.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Obtém um objeto pull request do provedor de origem.
getResourceUsage()	Obtém informações sobre recursos de compilação 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 locação.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Devolve quaisquer concessões correspondentes ao MinimalRetentionLeases especificado
getRetentionLeasesByOwnerId(string, string, number, number)	Retorna quaisquer concessões de propriedade da entidade especificada, opcionalmente com escopo para uma única definição de pipeline e execução.
getRetentionLeasesByUserId(string, string, number, number)	Retorna todas as concessões de propriedade do 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 uma compilação específica.
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 compilação para uma definição, opcionalmente com escopo para uma ramificação, estágio, trabalho e configuração específicos.</p><p>Se houver mais de um, é necessário passar um valor stageName ao especificar um jobName, e a mesma regra se aplica a ambos se passar um parâmetro de configuração.</p>
getTags(string)	Obtém uma lista de todas as marcas de compilação no projeto.
getTemplate(string, string)	Obtém um modelo de definição de compilação 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 duas compilações.
listBranches(string, string, string, string, string)	Obtém uma lista de ramificações para o repositório de código-fonte fornecido.
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 fornecido.
queueBuild(Build, string, boolean, string, number, number)	Enfileira uma compilação
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 fornecido.
saveTemplate(BuildDefinitionTemplate, string, string)	Atualiza um modelo de definição de compilação existente.
updateBuild(Build, string, number, boolean)	Atualiza uma compilação.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Atualiza as configurações gerais do pipeline.
updateBuildProperties(JsonPatchDocument, string, number)	Atualiza as propriedades de uma compilação.
updateBuilds(Build[], string)	Atualiza várias compilações.
updateBuildSettings(BuildSettings, string)	Atualiza as configurações de compilação.
updateBuildTags(UpdateTagParameters, string, number)	Adiciona/remove tags de uma compilação.
updateDefinition(BuildDefinition, string, number, number, number)	Atualiza uma definição de compilação existente. Para que essa operação seja bem-sucedida, o valor da propriedade "Revision" do corpo da solicitação deve corresponder à definição de compilação existente. É recomendável que você obtenha a definição de compilação existente usando GET, modifique a definição de compilação conforme necessário e, em seguida, envie a definição modificada com PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	Atualiza as propriedades de uma definição.
updateDefinitionTags(UpdateTagParameters, string, number)	Adiciona/Remove tags de uma definição.
updateFolder(Folder, string, string)	Atualiza uma pasta existente em determinado caminho existente
updateRetentionLease(RetentionLeaseUpdate, string, number)	Atualiza a duração ou o status de proteção de pipeline de uma concessão de retenção.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Atualiza as configurações de retenção do projeto.
updateStage(UpdateStageParameters, number, string, string)	Atualizar um estágio de compilação

Detalhes do Construtor

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

addBuildTag(string, number, string)

Adiciona uma tag a uma compilação.

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 da compilação.

tag: string

A tag a ser adicionada.

Devoluções

Promise<string[]>

addBuildTags(string[], string, number)

Adiciona tags a uma compilação.

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

Parâmetros

tags: string[]

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

project: string

ID do projeto ou nome do projeto

buildId: number

A ID da compilação.

Devoluções

Promise<string[]>

addDefinitionTag(string, number, string)

Adiciona uma tag 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

O ID da definição.

tag: string

A tag a ser adicionada.

Devoluções

Promise<string[]>

addDefinitionTags(string[], string, number)

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

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

Parâmetros

tags: string[]

As tags a serem adicionadas.

project: string

ID do projeto ou nome do projeto

definitionId: number

O ID da definição.

Devoluções

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

Devoluções

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

Devoluções

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

Devoluções

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Associa um artefato a uma compilação.

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 da compilação.

Devoluções

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

Devoluções

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.

Devoluções

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 da compilação.

Devoluções

Promise<void>

deleteBuildTag(string, number, string)

Remove uma tag de uma compilação. NOTA: Esta API não funcionará para etiquetas com carateres especiais. Para remover tags com caracteres especiais, use o método PATCH em vez disso (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 da compilação.

tag: string

A tag a ser removida.

Devoluções

Promise<string[]>

deleteDefinition(string, number)

Exclui uma definição e todas as compilações associadas.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

definitionId: number

O ID da definição.

Devoluções

Promise<void>

deleteDefinitionTag(string, number, string)

Remove uma tag de uma definição. NOTA: Esta API não funcionará para etiquetas com carateres especiais. Para remover tags com caracteres especiais, use o método PATCH em vez disso (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

O ID da definição.

tag: string

A tag a ser removida.

Devoluções

Promise<string[]>

deleteFolder(string, string)

Exclui uma pasta de definição. As definições e suas compilações correspondentes também serão excluídas.

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.

Devoluções

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

Devoluções

Promise<void>

deleteTag(string, string)

Remove uma tag de compilações, definições e do repositório de tags

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

Parâmetros

project: string

ID do projeto ou nome do projeto

tag: string

A tag a ser removida.

Devoluções

Promise<string[]>

deleteTemplate(string, string)

Exclui um modelo de definição de compilação.

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.

Devoluções

Promise<void>

getArtifact(string, number, string)

Obtém um artefato específico para uma compilação.

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 da compilação.

artifactName: string

O nome do artefato.

Devoluções

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Obtém um artefato específico para uma compilação.

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 da compilação.

artifactName: string

O nome do artefato.

Devoluções

Promise<ArrayBuffer>

getArtifacts(string, number)

Obtém todos os artefatos para uma compilação.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID da compilação.

Devoluções

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 da compilação.

timelineId: string

A ID da linha do tempo.

recordId: string

A ID do registro da linha do tempo.

type: string

O tipo de anexo.

name: string

O nome do anexo.

Devoluções

Promise<ArrayBuffer>

getAttachments(string, number, string)

Obtém a lista de anexos de um tipo específico que estão associados a uma compilação.

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 da compilação.

type: string

O tipo de anexo.

Devoluções

Promise<Attachment[]>

getBadge(string, number, string)

Obtém um selo que indica o status da compilação 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

O ID ou nome do projeto.

definitionId: number

O ID da definição.

branchName: string

O nome da filial.

Devoluções

Promise<string>

getBuild(string, number, string)

Obtém uma compilação

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

Devoluções

Promise<Build>

getBuildBadge(string, string, string, string)

Obtém um selo que indica o status da compilação mais recente para a ramificação especificada.

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

O ID do repositório.

branchName: string

O nome da filial.

Devoluções

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Obtém um selo que indica o status da compilação mais recente para a ramificação especificada.

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

O ID do repositório.

branchName: string

O nome da filial.

Devoluções

Promise<string>

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

Obtém as alterações associadas a uma compilação

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

Devoluções

Promise<PagedList<Change>>

getBuildController(number)

Obtém um controlador

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

Parâmetros

controllerId: number

Devoluções

Promise<BuildController>

getBuildControllers(string)

Obtém o controlador, opcionalmente filtrado pelo nome

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

Parâmetros

name: string

Devoluções

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

Devoluções

Promise<PipelineGeneralSettings>

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

Obtém um arquivo de log individual para uma compilação.

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 da compilação.

logId: number

A ID do arquivo de log.

startLine: number

A linha de partida.

endLine: number

A linha de chegada.

Devoluções

Promise<string>

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

Obtém um arquivo de log individual para uma compilação.

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 da compilação.

logId: number

A ID do arquivo de log.

startLine: number

A linha de partida.

endLine: number

A linha de chegada.

Devoluções

Promise<string[]>

getBuildLogs(string, number)

Obtém os logs para uma compilação.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID da compilação.

Devoluções

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Obtém os logs para uma compilação.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID da compilação.

Devoluções

Promise<ArrayBuffer>

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

Obtém um arquivo de log individual para uma compilação.

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 da compilação.

logId: number

A ID do arquivo de log.

startLine: number

A linha de partida.

endLine: number

A linha de chegada.

Devoluções

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Obtém todas as opções de definição de compilação suportadas pelo sistema.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Obtém propriedades para uma compilação.

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 da compilação.

filter: string[]

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

Devoluções

Promise<any>

getBuildReport(string, number, string)

Obtém um relatório de compilação.

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 da compilação.

type: string

Devoluções

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Obtém um relatório de compilação.

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 da compilação.

type: string

Devoluções

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 compilações.

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 as compilações para essas definições.

queues: number[]

Uma lista delimitada por vírgulas de IDs de fila. Se especificado, filtra as compilações executadas nessas filas.

buildNumber: string

Se especificado, filtra as compilações que correspondem a esse número de compilação. Anexar * para fazer uma pesquisa de prefixo.

minTime: Date

Se especificado, filtra as compilações concluídas/iniciadas/enfileiradas após essa data com base na queryOrder especificada.

maxTime: Date

Se especificado, filtra as compilações concluídas/iniciadas/enfileiradas antes dessa data com base na queryOrder especificada.

requestedFor: string

Se especificado, filtra as compilações solicitadas para o usuário especificado.

reasonFilter: BuildReason

Se especificado, filtra as compilações que correspondem a esse motivo.

statusFilter: BuildStatus

Se especificado, filtra as compilações que correspondem a esse status.

resultFilter: BuildResult

Se especificado, filtra as compilações que correspondem a esse resultado.

tagFilters: string[]

Uma lista delimitada por vírgulas de tags. Se especificado, filtra as compilações que têm as tags especificadas.

properties: string[]

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

top: number

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

continuationToken: string

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

maxBuildsPerDefinition: number

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

deletedFilter: QueryDeletedOption

Indica se as compilações excluídas devem ser excluídas, incluídas ou retornadas.

queryOrder: BuildQueryOrder

A ordem na qual as compilações devem ser retornadas.

branchName: string

Se especificado, filtra as compilações que criaram ramificações que criaram essa ramificação.

buildIds: number[]

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

repositoryId: string

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

repositoryType: string

Se especificado, filtra as compilações criadas a partir de repositórios desse tipo.

Devoluções

Promise<PagedList<Build>>

getBuildSettings(string)

Obtém as configurações de compilação.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<BuildSettings>

getBuildTags(string, number)

Obtém as tags para uma compilação.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID da compilação.

Devoluções

Promise<string[]>

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

Obtém detalhes para uma compilação

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

Devoluções

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Obtém os itens de trabalho associados a uma compilação. 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 da compilação.

top: number

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

Devoluções

Promise<ResourceRef[]>

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

Obtém os itens de trabalho associados a uma compilação, filtrados para confirmações específicas.

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 confirmação.

project: string

ID do projeto ou nome do projeto

buildId: number

A ID da compilação.

top: number

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

Devoluções

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Obtém as alterações feitas no repositório entre duas compilações determinadas.

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 da primeira compilação.

toBuildId: number

A ID da última compilação.

top: number

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

Devoluções

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

O 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 a partir 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

Devoluções

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Obtém métricas de compilação 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

O ID da definição.

minMetricsTime: Date

A data a partir da qual calcular as métricas.

Devoluções

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

O ID da definição.

filter: string[]

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

Devoluções

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

Devoluções

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

O ID da definição.

Devoluções

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

Um ID de repositório. Se especificado, filtra as 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 em que 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 para esse método, que pode ser usado para retornar o próximo conjunto de definições.

minMetricsTime: Date

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

definitionIds: number[]

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

path: string

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

builtAfter: Date

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

notBuiltAfter: Date

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

includeAllProperties: boolean

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

includeLatestBuilds: boolean

Indica se as compilações concluídas mais recentes e mais recentes devem ser retornadas 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 dado.

yamlFilename: string

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

Devoluções

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Obtém as tags para 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

O ID da definição.

revision: number

O número de revisão da definição. Se não for especificado, utiliza a última revisão da definição.

Devoluções

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

O 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 a partir 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

Devoluções

Promise<YamlBuild>

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

Obtém um arquivo da compilação.

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 da compilação.

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.

Devoluções

Promise<ArrayBuffer>

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

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

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 do 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 ramificações. Só pode ser omitido para provedores que não suportam vários repositórios.

commitOrBranch: string

O identificador da confirmação ou ramificação da qual o conteúdo de um arquivo é recuperado.

path: string

O caminho para o arquivo a ser recuperado, relativo à raiz do repositório.

Devoluções

Promise<string>

getFolders(string, string, FolderQueryOrder)

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

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 para começar.

queryOrder: FolderQueryOrder

A ordem em que as pastas devem ser retornadas.

Devoluções

Promise<Folder[]>

getLatestBuild(string, string, string)

Obtém a compilação mais recente para uma definição, opcionalmente com escopo para uma ramificação específica.

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 da definição

branchName: string

parâmetro opcional que indica a ramificação específica a ser usada. Se não for especificado, a ramificação padrão será usada.

Devoluções

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

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 do 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 ramificações. Só pode ser omitido para provedores que não suportam vários repositórios.

commitOrBranch: string

O identificador da confirmação ou ramificação da qual o conteúdo de um arquivo é recuperado.

path: string

O conteúdo do caminho a ser listado, relativo à raiz do repositório.

Devoluções

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Obtém métricas de compilação 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 a partir da qual calcular as métricas.

Devoluções

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

Devoluções

Promise<DefinitionResourceReference[]>

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

Obtém um objeto pull request 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ífico do fornecedor da solicitação pull.

repositoryId: string

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

serviceEndpointId: string

Se especificado, a ID do ponto de extremidade do 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.

Devoluções

Promise<PullRequest>

getResourceUsage()

Obtém informações sobre recursos de compilação no sistema.

function getResourceUsage(): Promise<BuildResourceUsage>

Devoluções

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

Devoluções

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

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

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

Parâmetros

project: string

ID do projeto ou nome do projeto

leaseId: number

Devoluções

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Devolve quaisquer concessões correspondentes 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 '|'

Devoluções

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Retorna quaisquer concessões de propriedade da 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.

Devoluções

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Retorna todas as concessões de propriedade do 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

O ID de usuário a ser pesquisado.

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.

Devoluções

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Obtém todas as concessões de retenção que se aplicam a uma compilação específica.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

buildId: number

A ID da compilação.

Devoluções

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

Devoluções

Promise<ProjectRetentionSetting>

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

<p>Obtém o status de compilação para uma definição, opcionalmente com escopo para uma ramificação, estágio, trabalho e configuração específicos.</p><p>Se houver mais de um, é necessário passar um valor stageName ao especificar um jobName, e a mesma regra se aplica 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 da definição.

branchName: string

Considere apenas a construção mais recente para este ramo. Se não for especificado, a ramificação padrão será usada.

stageName: string

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

jobName: string

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

configuration: string

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

label: string

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

Devoluções

Promise<string>

getTags(string)

Obtém uma lista de todas as marcas de compilação no projeto.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<string[]>

getTemplate(string, string)

Obtém um modelo de definição de compilação 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.

Devoluções

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

Devoluções

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Obtém todos os itens de trabalho entre duas compilações.

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 da primeira compilação.

toBuildId: number

A ID da última compilação.

top: number

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

Devoluções

Promise<ResourceRef[]>

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

Obtém uma lista de ramificações para o repositório de código-fonte fornecido.

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 do 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 ramificações. Só pode ser omitido para provedores que não suportam vários repositórios.

branchName: string

Se fornecido, o nome da ramificação a ser verificada especificamente.

Devoluções

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 do 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 final. Se não estiver definido, todos os repositórios serão retornados. Ignorado se 'repository' 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

Quando a paginação resulta, este é um token de continuação, retornado por uma chamada anterior para esse método, que pode ser usado para retornar o próximo conjunto de repositórios.

Devoluções

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

Devoluções

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

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

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 do 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 suportam vários repositórios.

Devoluções

Promise<RepositoryWebhook[]>

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

Enfileira uma compilação

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 uma compilação sem um corpo. Ignorado se houver um corpo válido

Devoluções

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

deleted: boolean

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

Devoluções

Promise<BuildDefinition>

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

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

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

Parâmetros

triggerTypes: DefinitionTriggerType[]

Os tipos de gatilhos para 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 do 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 suportam vários repositórios.

Devoluções

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Atualiza um modelo de definição de compilação 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.

Devoluções

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Atualiza uma compilação.

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

Parâmetros

build: Build

A construção.

project: string

ID do projeto ou nome do projeto

buildId: number

A ID da compilação.

retry: boolean

Devoluções

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

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

Devoluções

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Atualiza as propriedades de uma compilação.

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 da compilação.

Devoluções

Promise<any>

updateBuilds(Build[], string)

Atualiza várias compilações.

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

Parâmetros

builds: Build[]

As compilações a serem atualizadas.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Atualiza as configurações de compilação.

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

Devoluções

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Adiciona/remove tags de uma compilação.

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

Parâmetros

updateParameters: UpdateTagParameters

As tags a serem adicionadas/removidas.

project: string

ID do projeto ou nome do projeto

buildId: number

A ID da compilação.

Devoluções

Promise<string[]>

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

Atualiza uma definição de compilação existente. Para que essa operação seja bem-sucedida, o valor da propriedade "Revision" do corpo da solicitação deve corresponder à definição de compilação existente. É recomendável que você obtenha a definição de compilação existente usando GET, modifique a definição de compilação conforme necessário e, em seguida, 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

O ID da definição.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Devoluções

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Atualiza as propriedades de 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

O ID da definição.

Devoluções

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Adiciona/Remove tags de uma definição.

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

Parâmetros

updateParameters: UpdateTagParameters

As tags a serem adicionadas/removidas.

project: string

ID do projeto ou nome do projeto

definitionId: number

O ID da definição.

Devoluções

Promise<string[]>

updateFolder(Folder, string, string)

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

Devoluções

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Atualiza a duração ou o status de proteção de pipeline 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

O ID da concessão a ser atualizada.

Devoluções

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Atualiza 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

Devoluções

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Atualizar um estágio de compilação

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

Devoluções

Promise<void>

Comentários

Esta página foi útil?

Partilhar via

BuildRestClient class

Construtores

Propriedades

Métodos

Detalhes do Construtor

BuildRestClient(IVssRestClientOptions)

Parâmetros

Detalhes de Propriedade

RESOURCE_AREA_ID

Valor de Propriedade

Detalhes de Método

addBuildTag(string, number, string)

Parâmetros

Devoluções

addBuildTags(string[], string, number)

Parâmetros

Devoluções

addDefinitionTag(string, number, string)

Parâmetros

Devoluções

addDefinitionTags(string[], string, number)

Parâmetros

Devoluções

addRetentionLeases(NewRetentionLease[], string)

Parâmetros

Devoluções

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parâmetros

Devoluções

authorizeProjectResources(DefinitionResourceReference[], string)

Parâmetros

Devoluções

createArtifact(BuildArtifact, string, number)

Parâmetros

Devoluções

createDefinition(BuildDefinition, string, number, number)

Parâmetros

Devoluções

createFolder(Folder, string, string)

Parâmetros

Devoluções

deleteBuild(string, number)

Parâmetros

Devoluções

deleteBuildTag(string, number, string)

Parâmetros

Devoluções

deleteDefinition(string, number)

Parâmetros

Devoluções

deleteDefinitionTag(string, number, string)

Parâmetros

Devoluções

deleteFolder(string, string)

Parâmetros

Devoluções

deleteRetentionLeasesById(string, number[])

Parâmetros

Devoluções

deleteTag(string, string)

Parâmetros

Devoluções

deleteTemplate(string, string)

Parâmetros

Devoluções

getArtifact(string, number, string)

Parâmetros

Devoluções

getArtifactContentZip(string, number, string)

Parâmetros

Devoluções

getArtifacts(string, number)

Parâmetros

Devoluções

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

Parâmetros

Devoluções

getAttachments(string, number, string)

Parâmetros