BuildRestClient class

Referência

Pacote:: azure-devops-extension-api

Classe base que deve ser utilizada (derivada de) para fazer pedidos às apis REST do VSS

Extends: RestClientBase

Construtores

BuildRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

addBuildTag(string, number, string)	Adiciona uma etiqueta a uma compilação.
addBuildTags(string[], string, number)	Adiciona etiquetas a uma compilação.
addDefinitionTag(string, number, string)	Adiciona uma etiqueta a uma definição
addDefinitionTags(string[], string, number)	Adiciona várias etiquetas a uma definição.
addRetentionLeases(NewRetentionLease[], string)	Adiciona novas concessões para execuções de pipelines.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Associa um artefacto 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)	Elimina uma compilação.
deleteBuildTag(string, number, string)	Remove uma etiqueta de uma compilação. NOTA: esta API não funcionará para etiquetas com carateres especiais. Para remover etiquetas com carateres especiais, utilize o método PATCH (em 6.0+)
deleteDefinition(string, number)	Elimina uma definição e todas as compilações associadas.
deleteDefinitionTag(string, number, string)	Remove uma etiqueta de uma definição. NOTA: esta API não funcionará para etiquetas com carateres especiais. Para remover etiquetas com carateres especiais, utilize o método PATCH (em 6.0+)
deleteFolder(string, string)	Elimina uma pasta de definições. As definições e as respetivas compilações correspondentes também serão eliminadas.
deleteRetentionLeasesById(string, number[])	Remove concessões de retenção específicas.
deleteTag(string, string)	Remove uma etiqueta de compilações, definições e do arquivo de etiquetas
deleteTemplate(string, string)	Elimina um modelo de definição de compilação.
getArtifact(string, number, string)	Obtém um artefacto específico para uma compilação.
getArtifactContentZip(string, number, string)	Obtém um artefacto específico para uma compilação.
getArtifacts(string, number)	Obtém todos os artefactos de 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 distintivo que indica o estado da compilação mais recente para uma definição. Tenha em atenção que esta API foi preterida. Prefere StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Obtém uma compilação
getBuildBadge(string, string, string, string)	Obtém um distintivo que indica o estado da compilação mais recente para o ramo especificado.
getBuildBadgeData(string, string, string, string)	Obtém um distintivo que indica o estado da compilação mais recente para o ramo especificado.
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 definições gerais do pipeline.
getBuildLog(string, number, number, number, number)	Obtém um ficheiro de registo individual para uma compilação.
getBuildLogLines(string, number, number, number, number)	Obtém um ficheiro de registo individual para uma compilação.
getBuildLogs(string, number)	Obtém os registos de uma compilação.
getBuildLogsZip(string, number)	Obtém os registos de uma compilação.
getBuildLogZip(string, number, number, number, number)	Obtém um ficheiro de registo 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 definições de compilação.
getBuildTags(string, number)	Obtém as etiquetas de uma compilação.
getBuildTimeline(string, number, string, number, string)	Obtém detalhes de uma compilação
getBuildWorkItemsRefs(string, number, number)	Obtém os itens de trabalho associados a uma compilação. Só são devolvidos itens de trabalho no mesmo projeto.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Obtém os itens de trabalho associados a uma compilação, filtrados para consolidações específicas.
getChangesBetweenBuilds(string, number, number, number)	Obtém as alterações efetuadas ao repositório entre duas compilações especificadas.
getDefinition(string, number, number, Date, string[], boolean)	Obtém uma definição, opcionalmente numa 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 etiquetas de uma definição.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Converte uma definição em YAML, opcionalmente numa revisão específica.
getFile(string, number, string, string, string)	Obtém um ficheiro da compilação.
getFileContents(string, string, string, string, string, string)	Obtém o conteúdo de um ficheiro no repositório de código fonte especificado.
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 de uma definição, opcionalmente confinada a um ramo 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 compilação para um projeto.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Obtém um objeto de pedido Pull do fornecedor de origem.
getResourceUsage()	Obtém informações sobre recursos de compilação no sistema.
getRetentionHistory(number)	Devolve o histórico de retenção da coleção de projetos. Isto inclui pipelines que têm regras de retenção personalizadas que podem impedir a tarefa de retenção de os limpar, execuções por pipeline com tipo de retenção, ficheiros associados a pipelines pertencentes à coleção com tipo de retenção e o número de ficheiros por pipeline.
getRetentionLease(string, number)	Devolve os detalhes da concessão de retenção com um ID de concessão.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Devolve quaisquer concessões que correspondam às MinimalRetentionLeases especificadas
getRetentionLeasesByOwnerId(string, string, number, number)	Devolve quaisquer concessões pertencentes à entidade especificada, opcionalmente confinadas a uma única definição de pipeline e executadas.
getRetentionLeasesByUserId(string, string, number, number)	Devolve quaisquer concessões pertencentes ao utilizador especificado, opcionalmente no âmbito de uma única definição de pipeline e executada.
getRetentionLeasesForBuild(string, number)	Obtém todas as concessões de retenção aplicáveis a uma compilação específica.
getRetentionSettings(string)	Obtém as definições de retenção do projeto.
getStatusBadge(string, string, string, string, string, string, string)	<p>Obtém o estado de compilação de uma definição, opcionalmente no âmbito de um ramo, fase, tarefa e configuração específicos.< /p><p>Se existirem mais do que um, é necessário transmitir um valor stageName ao especificar um jobName e, em seguida, a mesma regra aplica-se a ambos se transmitir um parâmetro de configuração.< /p>
getTags(string)	Obtém uma lista de todas as etiquetas 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 ramos 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 fornecedores de origem e as respetivas capacidades.
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)	Coloca em fila uma compilação
restoreDefinition(string, number, boolean)	Restaura uma definição eliminada
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Recria os webhooks para os acionadores especificados no repositório de código fonte especificado.
saveTemplate(BuildDefinitionTemplate, string, string)	Atualizações um modelo de definição de compilação existente.
updateBuild(Build, string, number, boolean)	Atualizações uma compilação.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Atualizações definições gerais do pipeline.
updateBuildProperties(JsonPatchDocument, string, number)	Atualizações propriedades de uma compilação.
updateBuilds(Build[], string)	Atualizações várias compilações.
updateBuildSettings(BuildSettings, string)	Atualizações as definições de compilação.
updateBuildTags(UpdateTagParameters, string, number)	Adiciona/remove etiquetas de uma compilação.
updateDefinition(BuildDefinition, string, number, number, number)	Atualizações uma definição de compilação existente. Para que esta operação seja bem-sucedida, o valor da propriedade "Revisão" do corpo do pedido tem de corresponder ao da definição de compilação existente. Recomenda-se que obtenha a definição de compilação existente com GET, modifique a definição de compilação conforme necessário e, em seguida, submeta a definição modificada com PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	Atualizações propriedades de uma definição.
updateDefinitionTags(UpdateTagParameters, string, number)	Adiciona/remove etiquetas de uma definição.
updateFolder(Folder, string, string)	Atualizações uma pasta existente num determinado caminho existente
updateRetentionLease(RetentionLeaseUpdate, string, number)	Atualizações a duração ou o estado de proteção do pipeline de uma concessão de retenção.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Atualizações as definições de retenção do projeto.
updateStage(UpdateStageParameters, number, string, string)	Atualizar uma fase 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 etiqueta 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

O ID da compilação.

tag: string

A etiqueta a adicionar.

Devoluções

Promise<string[]>

addBuildTags(string[], string, number)

Adiciona etiquetas a uma compilação.

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

Parâmetros

tags: string[]

As etiquetas a adicionar. O corpo do pedido é composto diretamente a partir de etiquetas listadas.

project: string

ID do Projeto ou nome do projeto

buildId: number

O ID da compilação.

Devoluções

Promise<string[]>

addDefinitionTag(string, number, string)

Adiciona uma etiqueta 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 etiqueta a adicionar.

Devoluções

Promise<string[]>

addDefinitionTags(string[], string, number)

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

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

Parâmetros

tags: string[]

As etiquetas a adicionar.

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

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 artefacto a uma compilação.

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

Parâmetros

artifact: BuildArtifact

O artefacto.

project: string

ID do Projeto ou nome do projeto

buildId: number

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

Elimina uma compilação.

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

buildId: number

O ID da compilação.

Devoluções

Promise<void>

deleteBuildTag(string, number, string)

Remove uma etiqueta de uma compilação. NOTA: esta API não funcionará para etiquetas com carateres especiais. Para remover etiquetas com carateres especiais, utilize 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

O ID da compilação.

tag: string

A etiqueta a remover.

Devoluções

Promise<string[]>

deleteDefinition(string, number)

Elimina 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 etiqueta de uma definição. NOTA: esta API não funcionará para etiquetas com carateres especiais. Para remover etiquetas com carateres especiais, utilize 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

O ID da definição.

tag: string

A etiqueta a remover.

Devoluções

Promise<string[]>

deleteFolder(string, string)

Elimina uma pasta de definições. As definições e as respetivas compilações correspondentes também serão eliminadas.

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 etiqueta de compilações, definições e do arquivo de etiquetas

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

tag: string

A etiqueta a remover.

Devoluções

Promise<string[]>

deleteTemplate(string, string)

Elimina 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

O ID do modelo.

Devoluções

Promise<void>

getArtifact(string, number, string)

Obtém um artefacto 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

O ID da compilação.

artifactName: string

O nome do artefacto.

Devoluções

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Obtém um artefacto 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

O ID da compilação.

artifactName: string

O nome do artefacto.

Devoluções

Promise<ArrayBuffer>

getArtifacts(string, number)

Obtém todos os artefactos de uma compilação.

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

buildId: number

O 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

O ID da compilação.

timelineId: string

O ID da linha cronológica.

recordId: string

O ID do registo de linha cronológica.

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

O ID da compilação.

type: string

O tipo de anexo.

Devoluções

Promise<Attachment[]>

getBadge(string, number, string)

Obtém um distintivo que indica o estado da compilação mais recente para uma definição. Tenha em atenção que esta API foi preterida. Prefere 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 do ramo.

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 distintivo que indica o estado da compilação mais recente para o ramo 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

O ID do repositório.

branchName: string

O nome do ramo.

Devoluções

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Obtém um distintivo que indica o estado da compilação mais recente para o ramo 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

O ID do repositório.

branchName: string

O nome do ramo.

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 devolver

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 definiçõ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 ficheiro de registo 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

O ID da compilação.

logId: number

O ID do ficheiro de registo.

startLine: number

A linha de partida.

endLine: number

A linha final.

Devoluções

Promise<string>

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

Obtém um ficheiro de registo 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

O ID da compilação.

logId: number

O ID do ficheiro de registo.

startLine: number

A linha de partida.

endLine: number

A linha final.

Devoluções

Promise<string[]>

getBuildLogs(string, number)

Obtém os registos de uma compilação.

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

buildId: number

O ID da compilação.

Devoluções

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Obtém os registos de uma compilação.

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

buildId: number

O ID da compilação.

Devoluções

Promise<ArrayBuffer>

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

Obtém um ficheiro de registo 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

O ID da compilação.

logId: number

O ID do ficheiro de registo.

startLine: number

A linha de partida.

endLine: number

A linha final.

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

O ID da compilação.

filter: string[]

Uma lista delimitada por vírgulas de propriedades. Se especificado, filtra estas 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

O 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

O 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 estas definições.

queues: number[]

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

buildNumber: string

Se especificado, filtra por compilações que correspondem a este número de compilação. Acrescente * para efetuar uma pesquisa de prefixos.

minTime: Date

Se especificado, filtra por compilações que terminaram/iniciaram/colocaram em fila após esta data com base na consultaOuder especificada.

maxTime: Date

Se especificado, filtra por compilações que foram concluídas/iniciadas/em fila antes desta data com base na consultaOuder especificada.

requestedFor: string

Se especificado, filtra as compilações pedidas para o utilizador especificado.

reasonFilter: BuildReason

Se especificado, filtra por compilações que correspondem a este motivo.

statusFilter: BuildStatus

Se especificado, filtra por compilações que correspondem a este estado.

resultFilter: BuildResult

Se especificado, filtra por compilações que correspondem a este resultado.

tagFilters: string[]

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

properties: string[]

Uma lista delimitada por vírgulas de propriedades a obter.

top: number

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

continuationToken: string

Um token de continuação, devolvido por uma chamada anterior para este método, que pode ser utilizado para devolver o próximo conjunto de compilações.

maxBuildsPerDefinition: number

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

deletedFilter: QueryDeletedOption

Indica se pretende excluir, incluir ou devolver apenas compilações eliminadas.

queryOrder: BuildQueryOrder

A ordem pela qual as compilações devem ser devolvidas.

branchName: string

Se especificado, filtra por compilações que criaram ramos que criaram este ramo.

buildIds: number[]

Uma lista delimitada por vírgulas que especifica os IDs das compilações a obter.

repositoryId: string

Se especificado, filtra por compilações criadas a partir deste repositório.

repositoryType: string

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

Devoluções

Promise<PagedList<Build>>

getBuildSettings(string)

Obtém as definiçõ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 etiquetas de uma compilação.

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

buildId: number

O ID da compilação.

Devoluções

Promise<string[]>

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

Obtém detalhes de 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. Só são devolvidos itens de trabalho no mesmo projeto.

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

Parâmetros

project: string

ID do Projeto ou nome do projeto

buildId: number

O ID da compilação.

top: number

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

Devoluções

Promise<ResourceRef[]>

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

Obtém os itens de trabalho associados a uma compilação, filtrados para consolidaçõ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 consolidação.

project: string

ID do Projeto ou nome do projeto

buildId: number

O ID da compilação.

top: number

O número máximo de itens de trabalho a devolver ou o número de consolidações a considerar se não são especificados IDs de consolidação.

Devoluções

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Obtém as alterações efetuadas ao repositório entre duas compilações especificadas.

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

O ID da primeira compilação.

toBuildId: number

O ID da última compilação.

top: number

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

Devoluções

Promise<Change[]>

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

Obtém uma definição, opcionalmente numa 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 obter. Se não for especificado, será devolvida a versão mais recente.

minMetricsTime: Date

Se for 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 incluir 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 delimitada por vírgulas de propriedades. Se especificado, filtra estas 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 por definições cujos nomes correspondem a este padrão.

repositoryId: string

Um ID de repositório. Se especificado, filtra as definições que utilizam este repositório.

repositoryType: string

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

queryOrder: DefinitionQueryOrder

Indica a ordem pela qual as definições devem ser devolvidas.

top: number

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

continuationToken: string

Um token de continuação, devolvido por uma chamada anterior para este método, que pode ser utilizado para devolver o próximo conjunto de definições.

minMetricsTime: Date

Se for 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 os IDs das definições a obter.

path: string

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

builtAfter: Date

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

notBuiltAfter: Date

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

includeAllProperties: boolean

Indica se as definições completas devem ser devolvidas. Por predefinição, são devolvidas representações pouco profundas das definições.

includeLatestBuilds: boolean

Indica se pretende devolver as compilações concluídas mais recentes e mais recentes para esta definição.

taskIdFilter: string

Se especificado, filtra as definições que utilizam a tarefa especificada.

processType: number

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

yamlFilename: string

Se especificado, filtra para definições YAML que correspondem ao nome de ficheiro especificado. Para utilizar este filtro, includeAllProperties deve ser definido como verdadeiro

Devoluções

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

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

O ID da definição.

revision: number

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

Devoluções

Promise<string[]>

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

Converte uma definição em YAML, opcionalmente numa 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 obter. Se não for especificado, será devolvida a versão mais recente.

minMetricsTime: Date

Se for 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 incluir nos resultados.

includeLatestBuilds: boolean

Devoluções

Promise<YamlBuild>

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

Obtém um ficheiro 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

O ID da compilação.

artifactName: string

O nome do artefacto.

fileId: string

A chave primária do ficheiro.

fileName: string

O nome para o qual o ficheiro será definido.

Devoluções

Promise<ArrayBuffer>

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

Obtém o conteúdo de um ficheiro 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 fornecedor de origem.

serviceEndpointId: string

Se especificado, o ID do ponto final de serviço a consultar. Só pode ser omitido para fornecedores que não utilizem pontos finais 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 ramos. Só pode ser omitido para fornecedores que não suportam vários repositórios.

commitOrBranch: string

O identificador da consolidação ou ramo a partir do qual os conteúdos de um ficheiro são obtidos.

path: string

O caminho para o ficheiro a obter, em relação à 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 pela qual as pastas devem ser devolvidas.

Devoluções

Promise<Folder[]>

getLatestBuild(string, string, string)

Obtém a compilação mais recente de uma definição, opcionalmente confinada a um ramo 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 o caminho opcional da pasta à esquerda ou o ID da definição

branchName: string

parâmetro opcional que indica o ramo específico a utilizar. Se não for especificado, é utilizado o ramo predefinido.

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 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 fornecedor de origem.

serviceEndpointId: string

Se especificado, o ID do ponto final de serviço a consultar. Só pode ser omitido para fornecedores que não utilizem pontos finais 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 ramos. Só pode ser omitido para fornecedores que não suportam vários repositórios.

commitOrBranch: string

O identificador da consolidação ou ramo a partir do qual os conteúdos de um ficheiro são obtidos.

path: string

O caminho do conteúdo a listar, em relação à 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 utilizar (hora a 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 de pedido Pull do fornecedor 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 fornecedor de origem.

pullRequestId: string

ID específico do fornecedor do pedido Pull.

repositoryId: string

Identificador específico do fornecedor ou o nome do repositório que contém o pedido Pull.

serviceEndpointId: string

Se especificado, o ID do ponto final de serviço a consultar. Só pode ser omitido para fornecedores que não utilizem pontos finais 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)

Devolve o histórico de retenção da coleção de projetos. Isto inclui pipelines que têm regras de retenção personalizadas que podem impedir a tarefa de retenção de os limpar, execuções por pipeline com tipo de retenção, ficheiros associados a pipelines pertencentes à coleção com tipo de retenção e o número de ficheiros por pipeline.

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

Parâmetros

daysToLookback: number

Devoluções

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Devolve os detalhes da concessão de retenção com um 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

Devoluções

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Devolve quaisquer concessões que correspondam às MinimalRetentionLeases especificadas

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)

Devolve quaisquer concessões pertencentes à entidade especificada, opcionalmente confinadas a uma única definição de pipeline e executadas.

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)

Devolve quaisquer concessões pertencentes ao utilizador especificado, opcionalmente no âmbito de uma única definição de pipeline e executada.

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 utilizador a procurar.

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 aplicáveis 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

O ID da compilação.

Devoluções

Promise<RetentionLease[]>

getRetentionSettings(string)

Obtém as definiçõ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 estado de compilação de uma definição, opcionalmente no âmbito de um ramo, fase, tarefa e configuração específicos.< /p><p>Se existirem mais do que um, é necessário transmitir um valor stageName ao especificar um jobName e, em seguida, a mesma regra aplica-se a ambos se transmitir 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 opcional da pasta à esquerda ou o ID de definição.

branchName: string

Considere apenas a compilação mais recente para este ramo. Se não for especificado, é utilizado o ramo predefinido.

stageName: string

Utilize esta fase no pipeline para compor o estado.

jobName: string

Utilize esta tarefa numa fase do pipeline para compor o estado.

configuration: string

Utilizar esta configuração de tarefa para compor o estado

label: string

Substitui o texto predefinido no lado esquerdo do distintivo.

Devoluções

Promise<string>

getTags(string)

Obtém uma lista de todas as etiquetas 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

O ID do modelo pedido.

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

O ID da primeira compilação.

toBuildId: number

O ID da última compilação.

top: number

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

Devoluções

Promise<ResourceRef[]>

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

Obtém uma lista de ramos 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 fornecedor de origem.

serviceEndpointId: string

Se especificado, o ID do ponto final de serviço a consultar. Só pode ser omitido para fornecedores que não utilizem pontos finais de serviço, por exemplo TFVC ou TFGit.

repository: string

O identificador específico do fornecedor ou o nome do repositório para obter ramos. Só pode ser omitido para fornecedores que não suportam múltiplos repositórios.

branchName: string

Se for fornecido, o nome do ramo a verificar 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 fornecedor de origem.

serviceEndpointId: string

Se especificado, o ID do ponto final de serviço a consultar. Só pode ser omitido para fornecedores que não utilizem pontos finais 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 obter.

resultSet: ResultSet

"top" para os repositórios mais relevantes para o ponto final. Se não estiver definido, todos os repositórios serão devolvidos. Ignorado se "repositório" estiver definido.

pageResults: boolean

Se definido como verdadeiro, isto limitará o conjunto de resultados e devolverá um token de continuação para continuar a consulta.

continuationToken: string

Ao paginar resultados, este é um token de continuação, devolvido por uma chamada anterior para este método, que pode ser utilizado para devolver o próximo conjunto de repositórios.

Devoluções

Promise<SourceRepositories>

listSourceProviders(string)

Obtenha uma lista de fornecedores de origem e as respetivas capacidades.

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 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 fornecedor de origem.

serviceEndpointId: string

Se especificado, o ID do ponto final de serviço a consultar. Só pode ser omitido para fornecedores que não utilizem pontos finais 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 fornecedores que não suportam múltiplos repositórios.

Devoluções

Promise<RepositoryWebhook[]>

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

Coloca em fila 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 colocar uma compilação em fila sem corpo. Ignorado se existir um corpo válido

Devoluções

Promise<Build>

restoreDefinition(string, number, boolean)

Restaura uma definição eliminada

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 falso, restaura uma definição eliminada.

Devoluções

Promise<BuildDefinition>

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

Recria os webhooks para os acionadores 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 acionadores para o qual restaurar webhooks.

project: string

ID do Projeto ou nome do projeto

providerName: string

O nome do fornecedor de origem.

serviceEndpointId: string

Se especificado, o ID do ponto final de serviço a consultar. Só pode ser omitido para fornecedores que não utilizem pontos finais 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 fornecedores que não suportam múltiplos repositórios.

Devoluções

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Atualizações 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

O ID do modelo.

Devoluções

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Atualizações uma compilação.

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

Parâmetros

build: Build

A compilação.

project: string

ID do Projeto ou nome do projeto

buildId: number

O ID da compilação.

retry: boolean

Devoluções

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Atualizações definiçõ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ções 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 atualizar.

project: string

ID do Projeto ou nome do projeto

buildId: number

O ID da compilação.

Devoluções

Promise<any>

updateBuilds(Build[], string)

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

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

Parâmetros

builds: Build[]

As compilações a atualizar.

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

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

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

Parâmetros

settings: BuildSettings

As novas definições.

project: string

ID do Projeto ou nome do projeto

Devoluções

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Adiciona/remove etiquetas de uma compilação.

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

Parâmetros

updateParameters: UpdateTagParameters

As etiquetas a adicionar/remover.

project: string

ID do Projeto ou nome do projeto

buildId: number

O ID da compilação.

Devoluções

Promise<string[]>

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

Atualizações uma definição de compilação existente. Para que esta operação seja bem-sucedida, o valor da propriedade "Revisão" do corpo do pedido tem de corresponder ao da definição de compilação existente. Recomenda-se que obtenha a definição de compilação existente com GET, modifique a definição de compilação conforme necessário e, em seguida, submeta 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. A propriedade "Revisão" tem de corresponder à definição existente para que a atualização seja aceite.

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

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 etiquetas de uma definição.

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

Parâmetros

updateParameters: UpdateTagParameters

As etiquetas a adicionar/remover.

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ções uma pasta existente num 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ções a duração ou o estado de proteção do 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 da concessão de retenção.

project: string

ID do Projeto ou nome do projeto

leaseId: number

O ID da concessão a atualizar.

Devoluções

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Atualizações as definiçõ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 uma fase 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>

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