GitRestClient class

Referência

Pacote:: azure-devops-extension-api

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

Extends: RestClientBase

Construtores

GitRestClient(IVssRestClientOptions)

Propriedades

RESOURCE_AREA_ID

Métodos

createAnnotatedTag(GitAnnotatedTag, string, string)	Crie uma marca anotada.
createAttachment(any, string, string, number, string)	Anexe um novo arquivo a uma solicitação de pull.
createCherryPick(GitAsyncRefOperationParameters, string, string)	Escolha uma confirmação ou confirmações específicas associadas a uma solicitação de pull em um novo branch.
createComment(Comment, string, number, number, string)	Crie um comentário em um thread específico em uma solicitação de pull (até 500 comentários podem ser criados por thread).
createCommitStatus(GitStatus, string, string, string)	Criar status de confirmação do Git.
createFavorite(GitRefFavorite, string)	Cria um ref favorito
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Solicite que os refs de outro repositório sejam buscados neste. Ele sincroniza dois bifurcações existentes. Para criar uma bifurcação, consulte ahttps://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"<a href=" ;><de ponto de extremidade de repositórios /a>
createImportRequest(GitImportRequest, string, string)	Crie uma solicitação de importação.
createLike(string, number, number, number, string)	Adicione um like em um comentário.
createMergeRequest(GitMergeParameters, string, string, boolean)	Solicite uma operação de mesclagem do Git. Atualmente, oferecemos suporte à mesclagem de apenas 2 confirmações.
createPullRequest(GitPullRequest, string, string, boolean)	Crie uma solicitação de pull.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Crie um status de solicitação de pull na iteração. Essa operação terá o mesmo resultado que Criar status na solicitação de pull com a ID de iteração especificada no corpo da solicitação.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Crie uma marca (se isso ainda não existir) e adicione-a como um rótulo (marca) para uma solicitação de pull especificada. O único campo necessário é o nome do novo rótulo (marca).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Adicione um revisor a uma solicitação de pull ou vote.
createPullRequestReviewers(IdentityRef[], string, number, string)	Adicione revisores a uma solicitação de pull.
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Crie um status de solicitação de pull.
createPush(GitPush, string, string)	Envie alterações por push para o repositório.
createRepository(GitRepositoryCreateOptions, string, string)	Crie um repositório git em um projeto de equipe.
createRevert(GitAsyncRefOperationParameters, string, string)	Inicia a operação para criar um novo branch que reverte as alterações introduzidas por uma confirmação específica ou confirmações associadas a uma solicitação de pull.
createThread(GitPullRequestCommentThread, string, number, string)	Crie um thread em uma solicitação de pull.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Adicione uma identidade não automatizada aos revisores de uma solicitação de pull.
deleteAttachment(string, string, number, string)	Exclua um anexo de solicitação de pull.
deleteComment(string, number, number, number, string)	Exclua um comentário associado a um thread específico em uma solicitação de pull.
deleteEnablementStatus(boolean, boolean, string[])	DELETE exclui o status de habilitação e os dados billableCommitters do BD. Excluir os dados de habilitação efetivamente os desabilitará para os repositórios afetados.
deleteLike(string, number, number, number, string)	Exclua um like em um comentário.
deletePullRequestIterationStatus(string, number, number, number, string)	Exclua o status da iteração da solicitação de pull.
deletePullRequestLabels(string, number, string, string, string)	Remove um rótulo (marca) do conjunto daqueles atribuídos à solicitação de pull. A marca em si não será excluída.
deletePullRequestReviewer(string, number, string, string)	Remova um revisor de uma solicitação de pull.
deletePullRequestStatus(string, number, number, string)	Exclua o status da solicitação de pull.
deleteRefFavorite(string, number)	Exclui o favorito de refs especificado
deleteRepository(string, string)	Excluir um repositório git
deleteRepositoryFromRecycleBin(string, string)	Destrua (exclusão dura) um repositório Git com exclusão reversível.
getAnnotatedTag(string, string, string)	Obter uma marca anotada.
getAttachmentContent(string, string, number, string)	Obtenha o conteúdo do arquivo de um anexo de solicitação de pull.
getAttachments(string, number, string)	Obtenha uma lista de arquivos anexados a uma determinada solicitação de pull.
getAttachmentZip(string, string, number, string)	Obtenha o conteúdo do arquivo de um anexo de solicitação de pull.
getBillableCommitters(string, Date, number, number)	Recupere os committers faturáveis reais para o serviço de Segurança Avançada para uma determinada data.
getBillableCommittersDetail(string, string, Date)	Recupere confirmadores faturáveis reais detalhados para o serviço de Segurança Avançada para uma determinada data. Os resultados detalhados intencionalmente não filtram projetos e repositórios excluídos suavemente para ajudar a diagnosticar problemas de cobrança.
getBlob(string, string, string, boolean, string, boolean)	Obtenha um único blob.
getBlobContent(string, string, string, boolean, string, boolean)	Obtenha um único blob.
getBlobsZip(string[], string, string, string)	Obtém um ou mais blobs em um download de arquivo zip.
getBlobZip(string, string, string, boolean, string, boolean)	Obtenha um único blob.
getBranch(string, string, string, GitVersionDescriptor)	Recupere estatísticas sobre um único branch.
getBranches(string, string, GitVersionDescriptor)	Recupere estatísticas sobre todos os branches em um repositório.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Recuperar estatísticas para várias confirmações
getChanges(string, string, string, number, number)	Recuperar alterações para uma confirmação específica.
getCherryPick(string, number, string)	Recupere informações sobre uma operação de seleção de cereja por ID de seleção de cereja.
getCherryPickConflict(string, number, number, string)	Recuperar um conflito para uma escolha de cereja por ID
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Recuperar todos os conflitos para uma escolha de cereja
getCherryPickForRefName(string, string, string)	Recupere informações sobre uma operação de seleção de cereja para um branch específico. Essa operação é cara devido à estrutura de objetos subjacente, portanto, essa API examina apenas as 1000 operações de seleção de cereja mais recentes.
getCherryPickRelationships(string, string, string, boolean)	Dada uma commitId, retorna uma lista de confirmações que estão na mesma família de cherry-pick.
getComment(string, number, number, number, string)	Recupere um comentário associado a um thread específico em uma solicitação de pull.
getComments(string, number, number, string)	Recupere todos os comentários associados a um thread específico em uma solicitação de pull.
getCommit(string, string, string, number)	Recupere uma confirmação específica.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	Localize a confirmação comum mais próxima (a base de mesclagem) entre confirmações de base e de destino e obtenha a diferença entre as confirmações de base e de destino ou confirmações comuns e de destino.
getCommits(string, GitQueryCommitsCriteria, string)	Recuperar confirmações do git para um projeto
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	Recuperar confirmações do git para um projeto que corresponda aos critérios de pesquisa
getDeletedRepositories(string)	Recuperar repositórios git excluídos.
getEnablementStatus(string[], Date, number, number)	Status de habilitação GET para repositórios do projeto.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Obtenha confirmadores faturáveis estimados para um repositório nos últimos 90 dias.
getEstimatedBillablePushersOrg()	Obtenha pushers faturáveis estimados para uma organização nos últimos 90 dias.
getEstimatedBillablePushersProject(string)	Obtenha pushers faturáveis estimados para um projeto nos últimos 90 dias.
getFileDiffs(FileDiffsCriteria, string, string)	Obter as diferenças de arquivo para cada um dos arquivos especificados
getForks(string, string, string, boolean)	Recupere todas as bifurcações de um repositório na coleção.
getForkSyncRequest(string, number, string, boolean)	Obtenha detalhes específicos da operação de sincronização de bifurcação.
getForkSyncRequests(string, string, boolean, boolean)	Recupere todas as operações de sincronização de bifurcação solicitadas neste repositório.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter metadados de item e/ou conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado, que sempre é retornado como um download.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter metadados de item e/ou conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado, que sempre é retornado como um download.
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Obter metadados de item e/ou conteúdo para uma coleção de itens. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter metadados de item e/ou conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado, que sempre é retornado como um download.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter metadados de item e/ou conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado, que sempre é retornado como um download.
getImportRequest(string, string, number)	Recupere uma solicitação de importação específica.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter metadados de item e/ou conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado, que sempre é retornado como um download.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter metadados de item e/ou conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado, que sempre é retornado como um download.
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Obter metadados de item e/ou conteúdo para uma coleção de itens. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download.
getItemsBatch(GitItemRequestData, string, string)	Postar para recuperar uma criação de um lote de um conjunto de itens em um repositório/projeto, considerando uma lista de caminhos ou um caminho longo
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter metadados de item e/ou conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado, que sempre é retornado como um download.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter metadados de item e/ou conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado, que sempre é retornado como um download.
getLikes(string, number, number, number, string)	Obtenha curtidas para um comentário.
getMergeBases(string, string, string, string, string, string)	Localize as bases de mesclagem de duas confirmações, opcionalmente entre bifurcações. Se otherRepositoryId não for especificado, as bases de mesclagem serão calculadas apenas no contexto do repositório localNameOrId.
getMergeRequest(string, string, number, boolean)	Obtenha detalhes de uma operação de mesclagem específica.
getPermission(string, string, string)	Status da Permissão de Segurança Avançada GET.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Recuperar uma solicitação de pull.
getPullRequestById(number, string)	Recuperar uma solicitação de pull.
getPullRequestCommits(string, number, string)	Obtenha as confirmações para a solicitação de pull especificada.
getPullRequestConflict(string, number, number, string)	Recuperar um conflito para uma solicitação de pull por ID
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Recuperar todos os conflitos para uma solicitação de pull
getPullRequestIteration(string, number, number, string)	Obtenha a iteração especificada para uma solicitação de pull.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Recupere as alterações feitas em uma solicitação de pull entre duas iterações.
getPullRequestIterationCommits(string, number, number, string, number, number)	Obtenha as confirmações para a iteração especificada de uma solicitação de pull.
getPullRequestIterations(string, number, string, boolean)	Obtenha a lista de iterações para a solicitação de pull especificada.
getPullRequestIterationStatus(string, number, number, number, string)	Obtenha o status de iteração de solicitação de pull específico por ID. A ID de status é exclusiva dentro da solicitação de pull em todas as iterações.
getPullRequestIterationStatuses(string, number, number, string)	Obtenha todos os status associados a uma iteração de solicitação de pull.
getPullRequestLabel(string, number, string, string, string)	Recupera um único rótulo (marca) que foi atribuído a uma solicitação de pull.
getPullRequestLabels(string, number, string, string)	Obtenha todos os rótulos (marcas) atribuídos a uma solicitação de pull.
getPullRequestProperties(string, number, string)	Obtenha propriedades externas da solicitação de pull.
getPullRequestQuery(GitPullRequestQuery, string, string)	Essa API é usada para localizar quais solicitações de pull estão relacionadas a uma determinada confirmação. Ele pode ser usado para localizar a solicitação de pull que criou uma confirmação de mesclagem específica ou pode ser usada para localizar todas as solicitações de pull que já mesclaram uma confirmação específica. A entrada é uma lista de consultas que contêm uma lista de confirmações. Para cada confirmação que você pesquisa, você receberá de volta um dicionário de confirmação –> solicitações de pull.
getPullRequestReviewer(string, number, string, string)	Recuperar informações sobre um revisor específico em uma solicitação de pull
getPullRequestReviewers(string, number, string)	Recuperar os revisores para uma solicitação de pull
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	Recupere todas as solicitações de pull que correspondam a um critério especificado.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	Recupere todas as solicitações de pull que correspondam a um critério especificado.
getPullRequestStatus(string, number, number, string)	Obtenha o status de solicitação de pull específico por ID. A ID de status é exclusiva dentro da solicitação de pull em todas as iterações.
getPullRequestStatuses(string, number, string)	Obtenha todos os status associados a uma solicitação de pull.
getPullRequestThread(string, number, number, string, number, number)	Recupere um thread em uma solicitação de pull.
getPullRequestWorkItemRefs(string, number, string)	Recupere uma lista de itens de trabalho associados a uma solicitação de pull.
getPush(string, number, string, number, boolean)	Recupera um push específico.
getPushCommits(string, number, string, number, number, boolean)	Recupere uma lista de confirmações associadas a um push específico.
getPushes(string, string, number, number, GitPushSearchCriteria)	Recupera pushes associados ao repositório especificado.
getRecycleBinRepositories(string)	Recupere repositórios git excluídos suavemente da lixeira.
getRefFavorite(string, number)	Obtém o favorito dos árbitros para uma ID favorita.
getRefFavorites(string, string, string)	Obtém os favoritos de refs para um repositório e uma identidade.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	Consulta o repositório fornecido para seus refs e os retorna.
getRepositories(string, boolean, boolean, boolean)	Recuperar repositórios git.
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	Recupere repositórios git com filtro por nome e paginação.
getRepository(string, string)	Recupere um repositório git.
getRepositoryWithParent(string, boolean, string)	Recupere um repositório git.
getRevert(string, number, string)	Recupere informações sobre uma operação de reversão por ID de reversão.
getRevertConflict(string, number, number, string)	Recuperar um conflito para reverter por ID
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	Recuperar todos os conflitos para reverter
getRevertForRefName(string, string, string)	Recupere informações sobre uma operação de reversão para um branch específico.
getStatuses(string, string, string, number, number, boolean)	Obter status associados à confirmação do Git.
getSuggestions(string, string, boolean)	Recupere uma sugestão de solicitação de pull para um repositório ou projeto de equipe específico.
getThreads(string, number, string, number, number)	Recupere todos os threads em uma solicitação de pull.
getTree(string, string, string, string, boolean, string)	O ponto de extremidade árvore retorna a coleção de objetos abaixo da árvore especificada. Árvores são pastas em um repositório Git.
getTreeZip(string, string, string, string, boolean, string)	O ponto de extremidade árvore retorna a coleção de objetos abaixo da árvore especificada. Árvores são pastas em um repositório Git.
queryImportRequests(string, string, boolean)	Recupere solicitações de importação para um repositório.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Recupere um repositório Git com exclusão reversível. Os repositórios excluídos recentemente entram em um estado de exclusão reversível por um período antes de serem excluídos e se tornarem irrecuperáveis.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	Envia uma notificação por email sobre uma solicitação de pull específica para um conjunto de destinatários
updateCherryPickConflict(GitConflict, string, number, number, string)	Atualizar a resolução de conflitos de mesclagem
updateCherryPickConflicts(GitConflict[], string, number, string)	Atualizar várias resoluções de conflitos de mesclagem
updateComment(Comment, string, number, number, number, string)	Atualize um comentário associado a um thread específico em uma solicitação de pull.
updateEnablementStatus(AdvSecEnablementUpdate[])	Status de habilitação POST para repositórios.
updateImportRequest(GitImportRequest, string, string, number)	Tente novamente ou abandone uma solicitação de importação com falha.
updatePullRequest(GitPullRequest, string, number, string)	Atualizar uma solicitação de pull
updatePullRequestConflict(GitConflict, string, number, number, string)	Atualizar a resolução de conflitos de mesclagem
updatePullRequestConflicts(GitConflict[], string, number, string)	Atualizar várias resoluções de conflitos de mesclagem
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	Atualizar a coleção de status de iteração de solicitação de pull de atualização. O único tipo de operação com suporte é `remove`.
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Criar ou atualizar propriedades externas da solicitação de pull. A operação de patch pode ser `add`, `replace` ou `remove`. Para `add` operação, o caminho pode estar vazio. Se o caminho estiver vazio, o valor deverá ser uma lista de pares de valores de chave. Para `replace` operação, o caminho não pode estar vazio. Se o caminho não existir, a propriedade será adicionada à coleção. Para `remove` operação, o caminho não pode estar vazio. Se o caminho não existir, nenhuma ação será executada.
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Editar uma entrada de revisor. Esses campos podem ser corrigidos: isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Redefina os votos de vários revisores em uma solicitação de pull. OBSERVAÇÃO: esse ponto de extremidade só dá suporte à atualização de votos, mas não dá suporte à atualização de revisores necessários (política de uso) ou nomes de exibição.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	Atualizar a coleção de status de solicitação de pull. O único tipo de operação com suporte é `remove`.
updateRef(GitRefUpdate, string, string, string, string)	Bloquear ou desbloquear um branch.
updateRefs(GitRefUpdate[], string, string, string)	Criando, atualizando ou excluindo refs(branches).
updateRepository(GitRepository, string, string)	Atualiza o repositório Git com um novo nome de repositório ou um novo branch padrão.
updateRevertConflict(GitConflict, string, number, number, string)	Atualizar a resolução de conflitos de mesclagem
updateRevertConflicts(GitConflict[], string, number, string)	Atualizar várias resoluções de conflitos de mesclagem
updateThread(GitPullRequestCommentThread, string, number, number, string)	Atualize um thread em uma solicitação de pull.

Detalhes do construtor

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes da propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor da propriedade

string

Detalhes do método

createAnnotatedTag(GitAnnotatedTag, string, string)

Crie uma marca anotada.

function createAnnotatedTag(tagObject: GitAnnotatedTag, project: string, repositoryId: string): Promise<GitAnnotatedTag>

Parâmetros

tagObject: GitAnnotatedTag

Objeto que contém detalhes da marca a ser criada.

project: string

ID do projeto ou nome do projeto

repositoryId: string

ID ou nome do repositório.

Retornos

Promise<GitAnnotatedTag>

createAttachment(any, string, string, number, string)

Anexe um novo arquivo a uma solicitação de pull.

function createAttachment(content: any, fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment>

Parâmetros

content: any

Conteúdo a ser carregado

fileName: string

O nome do arquivo.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

Escolha uma confirmação ou confirmações específicas associadas a uma solicitação de pull em um novo branch.

function createCherryPick(cherryPickToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitCherryPick>

Parâmetros

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

ID do projeto ou nome do projeto

repositoryId: string

ID do repositório.

Retornos

Promise<GitCherryPick>

createComment(Comment, string, number, number, string)

Crie um comentário em um thread específico em uma solicitação de pull (até 500 comentários podem ser criados por thread).

function createComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment>

Parâmetros

comment: Comment

O comentário a ser criado. Os comentários podem ter até 150.000 caracteres.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

threadId: number

ID do thread em que o comentário desejado está.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Criar status de confirmação do Git.

function createCommitStatus(gitCommitStatusToCreate: GitStatus, commitId: string, repositoryId: string, project?: string): Promise<GitStatus>

Parâmetros

gitCommitStatusToCreate: GitStatus

Objeto de status de confirmação do Git a ser criado.

commitId: string

ID da confirmação do Git.

repositoryId: string

ID do repositório.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

Cria um ref favorito

function createFavorite(favorite: GitRefFavorite, project: string): Promise<GitRefFavorite>

Parâmetros

favorite: GitRefFavorite

O ref favorito a ser criado.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Solicite que os refs de outro repositório sejam buscados neste. Ele sincroniza dois bifurcações existentes. Para criar uma bifurcação, consulte ahttps://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"<a href=" ;><de ponto de extremidade de repositórios /a>

function createForkSyncRequest(syncParams: GitForkSyncRequestParameters, repositoryNameOrId: string, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

Parâmetros

syncParams: GitForkSyncRequestParameters

Repositório de origem e mapeamento de ref.

repositoryNameOrId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

includeLinks: boolean

True para incluir links

Retornos

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

Crie uma solicitação de importação.

function createImportRequest(importRequest: GitImportRequest, project: string, repositoryId: string): Promise<GitImportRequest>

Parâmetros

importRequest: GitImportRequest

A solicitação de importação a ser criada.

project: string

ID do projeto ou nome do projeto

repositoryId: string

O nome ou a ID do repositório.

Retornos

Promise<GitImportRequest>

createLike(string, number, number, number, string)

Adicione um like em um comentário.

function createLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

threadId: number

A ID do thread que contém o comentário.

commentId: number

A ID do comentário.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Solicite uma operação de mesclagem do Git. Atualmente, oferecemos suporte à mesclagem de apenas 2 confirmações.

function createMergeRequest(mergeParameters: GitMergeParameters, project: string, repositoryNameOrId: string, includeLinks?: boolean): Promise<GitMerge>

Parâmetros

mergeParameters: GitMergeParameters

CommitIds dos pais e mala direta.

project: string

ID do projeto ou nome do projeto

repositoryNameOrId: string

O nome ou a ID do repositório.

includeLinks: boolean

True para incluir links

Retornos

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

Crie uma solicitação de pull.

function createPullRequest(gitPullRequestToCreate: GitPullRequest, repositoryId: string, project?: string, supportsIterations?: boolean): Promise<GitPullRequest>

Parâmetros

gitPullRequestToCreate: GitPullRequest

A solicitação de pull a ser criada.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

project: string

ID do projeto ou nome do projeto

supportsIterations: boolean

Se for true, os envios subsequentes para a solicitação de pull serão individualmente revisáveis. Defina isso como false para solicitações de pull grandes por motivos de desempenho se essa funcionalidade não for necessária.

Retornos

Promise<GitPullRequest>

createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)

Crie um status de solicitação de pull na iteração. Essa operação terá o mesmo resultado que Criar status na solicitação de pull com a ID de iteração especificada no corpo da solicitação.

function createPullRequestIterationStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus>

Parâmetros

status: GitPullRequestStatus

Efetuar pull do status da solicitação para criar.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

iterationId: number

ID da iteração de solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequestStatus>

createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)

Crie uma marca (se isso ainda não existir) e adicione-a como um rótulo (marca) para uma solicitação de pull especificada. O único campo necessário é o nome do novo rótulo (marca).

function createPullRequestLabel(label: WebApiCreateTagRequestData, repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition>

Parâmetros

label: WebApiCreateTagRequestData

Rótulo a ser atribuído à solicitação de pull.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

projectId: string

ID do projeto ou nome do projeto.

Retornos

Promise<WebApiTagDefinition>

createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)

Adicione um revisor a uma solicitação de pull ou vote.

function createPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

Parâmetros

reviewer: IdentityRefWithVote

O voto do revisor.<br/>Se a ID do revisor estiver incluída aqui, ela deverá corresponder ao parâmetro reviewerID.<br/>Revisores podem definir seu próprio voto com esse método. Ao adicionar outros revisores, a votação deve ser definida como zero.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

reviewerId: string

ID do revisor.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<IdentityRefWithVote>

createPullRequestReviewers(IdentityRef[], string, number, string)

Adicione revisores a uma solicitação de pull.

function createPullRequestReviewers(reviewers: IdentityRef[], repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

Parâmetros

reviewers: IdentityRef[]

Revisores a serem adicionados à solicitação de pull.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Crie um status de solicitação de pull.

function createPullRequestStatus(status: GitPullRequestStatus, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus>

Parâmetros

status: GitPullRequestStatus

Efetuar pull do status da solicitação para criar.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

Envie alterações por push para o repositório.

function createPush(push: GitPush, repositoryId: string, project?: string): Promise<GitPush>

Parâmetros

push: GitPush

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

Crie um repositório git em um projeto de equipe.

function createRepository(gitRepositoryToCreate: GitRepositoryCreateOptions, project?: string, sourceRef?: string): Promise<GitRepository>

Parâmetros

gitRepositoryToCreate: GitRepositoryCreateOptions

Especifique o nome do repositório, o projeto de equipe e/ou o repositório pai. As informações do projeto de equipe podem ser omitidas do gitRepositoryToCreate se a solicitação tiver escopo de projeto (ou seja, inclui a ID do projeto).

project: string

ID do projeto ou nome do projeto

sourceRef: string

[opcional] Especifique os refs de origem a serem usados durante a criação de um repositório de bifurcação

Retornos

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

Inicia a operação para criar um novo branch que reverte as alterações introduzidas por uma confirmação específica ou confirmações associadas a uma solicitação de pull.

function createRevert(revertToCreate: GitAsyncRefOperationParameters, project: string, repositoryId: string): Promise<GitRevert>

Parâmetros

revertToCreate: GitAsyncRefOperationParameters

project: string

ID do projeto ou nome do projeto

repositoryId: string

ID do repositório.

Retornos

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

Crie um thread em uma solicitação de pull.

function createThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestCommentThread>

Parâmetros

commentThread: GitPullRequestCommentThread

O thread a ser criado. O thread deve conter pelo menos um comentário.

repositoryId: string

ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Adicione uma identidade não automatizada aos revisores de uma solicitação de pull.

function createUnmaterializedPullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote>

Parâmetros

reviewer: IdentityRefWithVote

Revisor a ser adicionado à solicitação de pull.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Exclua um anexo de solicitação de pull.

function deleteAttachment(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Parâmetros

fileName: string

O nome do anexo a ser excluído.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

deleteComment(string, number, number, number, string)

Exclua um comentário associado a um thread específico em uma solicitação de pull.

function deleteComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

threadId: number

ID do thread em que o comentário desejado está.

commentId: number

ID do comentário.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE exclui o status de habilitação e os dados billableCommitters do BD. Excluir os dados de habilitação efetivamente os desabilitará para os repositórios afetados.

function deleteEnablementStatus(allProjects: boolean, includeBillableCommitters?: boolean, projectIds?: string[]): Promise<void>

Parâmetros

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

Retornos

Promise<void>

deleteLike(string, number, number, number, string)

Exclua um like em um comentário.

function deleteLike(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<void>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

threadId: number

A ID do thread que contém o comentário.

commentId: number

A ID do comentário.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

deletePullRequestIterationStatus(string, number, number, number, string)

Exclua o status da iteração da solicitação de pull.

function deletePullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<void>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

iterationId: number

ID da iteração de solicitação de pull.

statusId: number

ID do status da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

deletePullRequestLabels(string, number, string, string, string)

Remove um rótulo (marca) do conjunto daqueles atribuídos à solicitação de pull. A marca em si não será excluída.

function deletePullRequestLabels(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<void>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

labelIdOrName: string

O nome ou a ID do rótulo solicitado.

project: string

ID do projeto ou nome do projeto

projectId: string

ID do projeto ou nome do projeto.

Retornos

Promise<void>

deletePullRequestReviewer(string, number, string, string)

Remova um revisor de uma solicitação de pull.

function deletePullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<void>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

reviewerId: string

ID do revisor a ser removido.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

deletePullRequestStatus(string, number, number, string)

Exclua o status da solicitação de pull.

function deletePullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<void>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

statusId: number

ID do status da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

deleteRefFavorite(string, number)

Exclui o favorito de refs especificado

function deleteRefFavorite(project: string, favoriteId: number): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

favoriteId: number

A ID do ref favorito a ser excluído.

Retornos

Promise<void>

deleteRepository(string, string)

Excluir um repositório git

function deleteRepository(repositoryId: string, project?: string): Promise<void>

Parâmetros

repositoryId: string

A ID do repositório.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

Destrua (exclusão dura) um repositório Git com exclusão reversível.

function deleteRepositoryFromRecycleBin(project: string, repositoryId: string): Promise<void>

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryId: string

A ID do repositório.

Retornos

Promise<void>

getAnnotatedTag(string, string, string)

Obter uma marca anotada.

function getAnnotatedTag(project: string, repositoryId: string, objectId: string): Promise<GitAnnotatedTag>

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryId: string

ID ou nome do repositório.

objectId: string

ObjectId (Sha1Id) da marca a ser obtido.

Retornos

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

Obtenha o conteúdo do arquivo de um anexo de solicitação de pull.

function getAttachmentContent(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

Parâmetros

fileName: string

O nome do anexo.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<ArrayBuffer>

getAttachments(string, number, string)

Obtenha uma lista de arquivos anexados a uma determinada solicitação de pull.

function getAttachments(repositoryId: string, pullRequestId: number, project?: string): Promise<Attachment[]>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

Obtenha o conteúdo do arquivo de um anexo de solicitação de pull.

function getAttachmentZip(fileName: string, repositoryId: string, pullRequestId: number, project?: string): Promise<ArrayBuffer>

Parâmetros

fileName: string

O nome do anexo.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

Recupere os committers faturáveis reais para o serviço de Segurança Avançada para uma determinada data.

function getBillableCommitters(project: string, billingDate?: Date, skip?: number, take?: number): Promise<BillableCommitter[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

billingDate: Date

UTC esperado. Se não for especificado o padrão para o dia de cobrança anterior.

skip: number

Ignore as linhas X do conjunto de resultados para simular a paginação.

take: number

Retornar linhas Y do conjunto de resultados para simular a paginação.

Retornos

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

Recupere confirmadores faturáveis reais detalhados para o serviço de Segurança Avançada para uma determinada data. Os resultados detalhados intencionalmente não filtram projetos e repositórios excluídos suavemente para ajudar a diagnosticar problemas de cobrança.

function getBillableCommittersDetail(project: string, includeDetails: string, billingDate?: Date): Promise<BillableCommitterDetail[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

includeDetails: string

Retorne todos os detalhes sobre os committers faturáveis.

billingDate: Date

UTC esperado. Se não for especificado o padrão para o dia de cobrança anterior.

Retornos

Promise<BillableCommitterDetail[]>

getBlob(string, string, string, boolean, string, boolean)

Obtenha um único blob.

function getBlob(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<GitBlobRef>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

sha1: string

Hash SHA1 do arquivo. Você pode obter o SHA1 de um arquivo usando o ponto de extremidade "Git/Items/Get Item".

project: string

ID do projeto ou nome do projeto

download: boolean

Se for true, solicite um download em vez de renderizar em um navegador. Observação: esse valor usa como padrão true se $format for zip

fileName: string

Forneça um fileName a ser usado para um download.

resolveLfs: boolean

Se for true, tente resolver um blob para seu conteúdo LFS, se for um arquivo de ponteiro LFS. Compatível apenas com cabeçalhos de aceitação de fluxo de octeto ou tipos de $format

Retornos

Promise<GitBlobRef>

getBlobContent(string, string, string, boolean, string, boolean)

Obtenha um único blob.

function getBlobContent(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

sha1: string

Hash SHA1 do arquivo. Você pode obter o SHA1 de um arquivo usando o ponto de extremidade "Git/Items/Get Item".

project: string

ID do projeto ou nome do projeto

download: boolean

Se for true, solicite um download em vez de renderizar em um navegador. Observação: esse valor usa como padrão true se $format for zip

fileName: string

Forneça um fileName a ser usado para um download.

resolveLfs: boolean

Se for true, tente resolver um blob para seu conteúdo LFS, se for um arquivo de ponteiro LFS. Compatível apenas com cabeçalhos de aceitação de fluxo de octeto ou tipos de $format

Retornos

Promise<ArrayBuffer>

getBlobsZip(string[], string, string, string)

Obtém um ou mais blobs em um download de arquivo zip.

function getBlobsZip(blobIds: string[], repositoryId: string, project?: string, filename?: string): Promise<ArrayBuffer>

Parâmetros

blobIds: string[]

IDs de blob (hashes SHA1) a serem retornadas no arquivo zip.

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

filename: string

Retornos

Promise<ArrayBuffer>

getBlobZip(string, string, string, boolean, string, boolean)

Obtenha um único blob.

function getBlobZip(repositoryId: string, sha1: string, project?: string, download?: boolean, fileName?: string, resolveLfs?: boolean): Promise<ArrayBuffer>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

sha1: string

Hash SHA1 do arquivo. Você pode obter o SHA1 de um arquivo usando o ponto de extremidade "Git/Items/Get Item".

project: string

ID do projeto ou nome do projeto

download: boolean

Se for true, solicite um download em vez de renderizar em um navegador. Observação: esse valor usa como padrão true se $format for zip

fileName: string

Forneça um fileName a ser usado para um download.

resolveLfs: boolean

Se for true, tente resolver um blob para seu conteúdo LFS, se for um arquivo de ponteiro LFS. Compatível apenas com cabeçalhos de aceitação de fluxo de octeto ou tipos de $format

Retornos

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Recupere estatísticas sobre um único branch.

function getBranch(repositoryId: string, name: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

name: string

Nome do branch.

project: string

ID do projeto ou nome do projeto

baseVersionDescriptor: GitVersionDescriptor

Identifica a confirmação ou o branch a ser usado como base.

Retornos

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

Recupere estatísticas sobre todos os branches em um repositório.

function getBranches(repositoryId: string, project?: string, baseVersionDescriptor?: GitVersionDescriptor): Promise<GitBranchStats[]>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

baseVersionDescriptor: GitVersionDescriptor

Identifica a confirmação ou o branch a ser usado como base.

Retornos

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

Recuperar estatísticas para várias confirmações

function getBranchStatsBatch(searchCriteria: GitQueryBranchStatsCriteria, repositoryId: string, project?: string): Promise<GitBranchStats[]>

Parâmetros

searchCriteria: GitQueryBranchStatsCriteria

Confirmação base e lista de confirmações de destino a serem comparadas.

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitBranchStats[]>

getChanges(string, string, string, number, number)

Recuperar alterações para uma confirmação específica.

function getChanges(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number): Promise<GitCommitChanges>

Parâmetros

commitId: string

A ID da confirmação.

repositoryId: string

A ID ou o nome amigável do repositório. Para usar o nome amigável, projectId também deve ser especificado.

project: string

ID do projeto ou nome do projeto

top: number

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

skip: number

O número de alterações a serem ignoradas.

Retornos

Promise<GitCommitChanges>

getCherryPick(string, number, string)

Recupere informações sobre uma operação de seleção de cereja por ID de seleção de cereja.

function getCherryPick(project: string, cherryPickId: number, repositoryId: string): Promise<GitCherryPick>

Parâmetros

project: string

ID do projeto ou nome do projeto

cherryPickId: number

ID da escolha da cereja.

repositoryId: string

ID do repositório.

Retornos

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Recuperar um conflito para uma escolha de cereja por ID

function getCherryPickConflict(repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

Parâmetros

repositoryId: string

cherryPickId: number

conflictId: number

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitConflict>

getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)

Recuperar todos os conflitos para uma escolha de cereja

function getCherryPickConflicts(repositoryId: string, cherryPickId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

Parâmetros

repositoryId: string

cherryPickId: number

project: string

ID do projeto ou nome do projeto

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Retornos

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

Recupere informações sobre uma operação de seleção de cereja para um branch específico. Essa operação é cara devido à estrutura de objetos subjacente, portanto, essa API examina apenas as 1000 operações de seleção de cereja mais recentes.

function getCherryPickForRefName(project: string, repositoryId: string, refName: string): Promise<GitCherryPick>

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryId: string

ID do repositório.

refName: string

O GitAsyncRefOperationParameters generatedRefName usado para a operação de seleção de cereja.

Retornos

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

Dada uma commitId, retorna uma lista de confirmações que estão na mesma família de cherry-pick.

function getCherryPickRelationships(repositoryNameOrId: string, commitId: string, project?: string, includeLinks?: boolean): Promise<GitCommitRef[]>

Parâmetros

repositoryNameOrId: string

commitId: string

project: string

ID do projeto ou nome do projeto

includeLinks: boolean

Retornos

Promise<GitCommitRef[]>

getComment(string, number, number, number, string)

Recupere um comentário associado a um thread específico em uma solicitação de pull.

function getComment(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

threadId: number

ID do thread em que o comentário desejado está.

commentId: number

ID do comentário.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<Comment>

getComments(string, number, number, string)

Recupere todos os comentários associados a um thread específico em uma solicitação de pull.

function getComments(repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<Comment[]>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

threadId: number

ID do thread.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<Comment[]>

getCommit(string, string, string, number)

Recupere uma confirmação específica.

function getCommit(commitId: string, repositoryId: string, project?: string, changeCount?: number): Promise<GitCommit>

Parâmetros

commitId: string

A ID da confirmação.

repositoryId: string

A ID ou o nome amigável do repositório. Para usar o nome amigável, projectId também deve ser especificado.

project: string

ID do projeto ou nome do projeto

changeCount: number

O número de alterações a serem incluídas no resultado.

Retornos

Promise<GitCommit>

getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)

Localize a confirmação comum mais próxima (a base de mesclagem) entre confirmações de base e de destino e obtenha a diferença entre as confirmações de base e de destino ou confirmações comuns e de destino.

function getCommitDiffs(repositoryId: string, project?: string, diffCommonCommit?: boolean, top?: number, skip?: number, baseVersionDescriptor?: GitBaseVersionDescriptor, targetVersionDescriptor?: GitTargetVersionDescriptor): Promise<GitCommitDiffs>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

diffCommonCommit: boolean

Se for true, difame entre confirmações comuns e de destino. Se false, difame entre confirmações de base e de destino.

top: number

Número máximo de alterações a serem retornadas. O padrão é 100.

skip: number

Número de alterações a serem ignoradas

baseVersionDescriptor: GitBaseVersionDescriptor

Descritor para confirmação base.

targetVersionDescriptor: GitTargetVersionDescriptor

Descritor para confirmação de destino.

Retornos

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

Recuperar confirmações do git para um projeto

function getCommits(repositoryId: string, searchCriteria: GitQueryCommitsCriteria, project?: string): Promise<GitCommitRef[]>

Parâmetros

repositoryId: string

A ID ou o nome amigável do repositório. Para usar o nome amigável, projectId também deve ser especificado.

searchCriteria: GitQueryCommitsCriteria

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitCommitRef[]>

getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)

Recuperar confirmações do git para um projeto que corresponda aos critérios de pesquisa

function getCommitsBatch(searchCriteria: GitQueryCommitsCriteria, repositoryId: string, project?: string, skip?: number, top?: number, includeStatuses?: boolean): Promise<GitCommitRef[]>

Parâmetros

searchCriteria: GitQueryCommitsCriteria

Opções de pesquisa

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

skip: number

Número de confirmações a serem ignoradas. O valor não pode exceder 3.000.000.

top: number

Número máximo de confirmações a serem retornadas. O valor não pode exceder 50.000.

includeStatuses: boolean

True para incluir informações de status de confirmação adicionais.

Retornos

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Recuperar repositórios git excluídos.

function getDeletedRepositories(project: string): Promise<GitDeletedRepository[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitDeletedRepository[]>

getEnablementStatus(string[], Date, number, number)

Status de habilitação GET para repositórios do projeto.

function getEnablementStatus(projectIds?: string[], billingDate?: Date, skip?: number, take?: number): Promise<AdvSecEnablementStatus[]>

Parâmetros

projectIds: string[]

Padrão nulo para todos os projetos no host, lista do status de repositório do projeto a ser retornado

billingDate: Date

UTC esperado, padrões nulos para UtcNow(), podem ser fornecidos para um status pontual

skip: number

Ignore as linhas X do conjunto de resultados para simular a paginação.

take: number

Retornar linhas Y do conjunto de resultados para simular a paginação.

Retornos

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

function getEnableOnCreateHost(enableOnCreateHost: boolean): Promise<boolean>

Parâmetros

enableOnCreateHost: boolean

Retornos

Promise<boolean>

getEnableOnCreateProject(string)

function getEnableOnCreateProject(enableOnCreateProjectId: string): Promise<boolean>

Parâmetros

enableOnCreateProjectId: string

Retornos

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

Obtenha confirmadores faturáveis estimados para um repositório nos últimos 90 dias.

function getEstimatedBillableCommittersRepo(project: string, repositoryId: string): Promise<BillableCommitter[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryId: string

Retornos

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

Obtenha pushers faturáveis estimados para uma organização nos últimos 90 dias.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Retornos

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

Obtenha pushers faturáveis estimados para um projeto nos últimos 90 dias.

function getEstimatedBillablePushersProject(project: string): Promise<BillablePusher[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

Obter as diferenças de arquivo para cada um dos arquivos especificados

function getFileDiffs(fileDiffsCriteria: FileDiffsCriteria, project: string, repositoryId: string): Promise<FileDiff[]>

Parâmetros

fileDiffsCriteria: FileDiffsCriteria

Lista de objetos de parâmetros de arquivo

project: string

ID do projeto ou nome do projeto

repositoryId: string

O nome ou a ID do repositório

Retornos

Promise<FileDiff[]>

getForks(string, string, string, boolean)

Recupere todas as bifurcações de um repositório na coleção.

function getForks(repositoryNameOrId: string, collectionId: string, project?: string, includeLinks?: boolean): Promise<GitRepositoryRef[]>

Parâmetros

repositoryNameOrId: string

O nome ou a ID do repositório.

collectionId: string

ID da coleção de projetos de equipe.

project: string

ID do projeto ou nome do projeto

includeLinks: boolean

True para incluir links.

Retornos

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

Obtenha detalhes específicos da operação de sincronização de bifurcação.

function getForkSyncRequest(repositoryNameOrId: string, forkSyncOperationId: number, project?: string, includeLinks?: boolean): Promise<GitForkSyncRequest>

Parâmetros

repositoryNameOrId: string

O nome ou a ID do repositório.

forkSyncOperationId: number

OperationId da solicitação de sincronização.

project: string

ID do projeto ou nome do projeto

includeLinks: boolean

True para incluir links.

Retornos

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

Recupere todas as operações de sincronização de bifurcação solicitadas neste repositório.

function getForkSyncRequests(repositoryNameOrId: string, project?: string, includeAbandoned?: boolean, includeLinks?: boolean): Promise<GitForkSyncRequest[]>

Parâmetros

repositoryNameOrId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

includeAbandoned: boolean

True para incluir solicitações abandonadas.

includeLinks: boolean

True para incluir links.

Retornos

Promise<GitForkSyncRequest[]>

getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

Obter metadados de item e/ou conteúdo para um único item. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado, que sempre é retornado como um download.

function getHfsItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<GitItem>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

path: string

O caminho do item.

project: string

ID do projeto ou nome do projeto

scopePath: string

O escopo do caminho. O padrão é nulo.

recursionLevel: VersionControlRecursionType

O nível de recursão dessa solicitação. O padrão é 'none', sem recursão.

includeContentMetadata: boolean

Defina como true para incluir metadados de conteúdo. O padrão é false.

latestProcessedChange: boolean

Defina como true para incluir as alterações mais recentes. O padrão é false.

download: boolean

Defina como true para baixar a resposta como um arquivo. O padrão é false.

versionDescriptor: GitVersionDescriptor

Descritor de versão. O padrão é o branch padrão para o repositório.

includeContent: boolean

Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.

resolveHfs: boolean

Defina como true para resolver arquivos de ponteiro do Git HFS para retornar o conteúdo real do Git HFS. O padrão é verdadeiro.

sanitize: boolean

Defina como true para limpar um arquivo svg e devolvê-lo como imagem. Útil somente se solicitado para o arquivo svg. O padrão é false.

Retornos

Promise<GitItem>

getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

path: string

O caminho do item.

project: string

ID do projeto ou nome do projeto

scopePath: string

O escopo do caminho. O padrão é nulo.

recursionLevel: VersionControlRecursionType

O nível de recursão dessa solicitação. O padrão é 'none', sem recursão.

includeContentMetadata: boolean

Defina como true para incluir metadados de conteúdo. O padrão é false.

latestProcessedChange: boolean

Defina como true para incluir as alterações mais recentes. O padrão é false.

download: boolean

Defina como true para baixar a resposta como um arquivo. O padrão é false.

versionDescriptor: GitVersionDescriptor

Descritor de versão. O padrão é o branch padrão para o repositório.

includeContent: boolean

Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.

resolveHfs: boolean

Defina como true para resolver arquivos de ponteiro do Git HFS para retornar o conteúdo real do Git HFS. O padrão é verdadeiro.

sanitize: boolean

Defina como true para limpar um arquivo svg e devolvê-lo como imagem. Útil somente se solicitado para o arquivo svg. O padrão é false.

Retornos

Promise<ArrayBuffer>

getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

Obter metadados de item e/ou conteúdo para uma coleção de itens. O parâmetro de download é indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica ao conteúdo compactado que sempre é retornado como um download.

function getHfsItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

scopePath: string

O escopo do caminho. O padrão é nulo.

recursionLevel: VersionControlRecursionType

O nível de recursão dessa solicitação. O padrão é 'none', sem recursão.

includeContentMetadata: boolean

Defina como true para incluir metadados de conteúdo. O padrão é false.

latestProcessedChange: boolean

Defina como true para incluir as alterações mais recentes. O padrão é false.

download: boolean

Defina como true para baixar a resposta como um arquivo. O padrão é false.

includeLinks: boolean

Defina como true para incluir links para itens. O padrão é false.

versionDescriptor: GitVersionDescriptor

Descritor de versão. O padrão é o branch padrão para o repositório.

zipForUnix: boolean

Defina como true para manter as permissões de arquivo para sistemas unix (e POSIX), como executáveis e symlinks

Retornos

Promise<GitItem[]>

getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<string>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

path: string

O caminho do item.

project: string

ID do projeto ou nome do projeto

scopePath: string

O escopo do caminho. O padrão é nulo.

recursionLevel: VersionControlRecursionType

O nível de recursão dessa solicitação. O padrão é 'none', sem recursão.

includeContentMetadata: boolean

Defina como true para incluir metadados de conteúdo. O padrão é false.

latestProcessedChange: boolean

Defina como true para incluir as alterações mais recentes. O padrão é false.

download: boolean

Defina como true para baixar a resposta como um arquivo. O padrão é false.

versionDescriptor: GitVersionDescriptor

Descritor de versão. O padrão é o branch padrão para o repositório.

includeContent: boolean

Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.

resolveHfs: boolean

Defina como true para resolver arquivos de ponteiro do Git HFS para retornar o conteúdo real do Git HFS. O padrão é verdadeiro.

sanitize: boolean

Defina como true para limpar um arquivo svg e devolvê-lo como imagem. Útil somente se solicitado para o arquivo svg. O padrão é false.

Retornos

Promise<string>

getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getHfsItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveHfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

path: string

O caminho do item.

project: string

ID do projeto ou nome do projeto

scopePath: string

O escopo do caminho. O padrão é nulo.

recursionLevel: VersionControlRecursionType

O nível de recursão dessa solicitação. O padrão é 'none', sem recursão.

includeContentMetadata: boolean

Defina como true para incluir metadados de conteúdo. O padrão é false.

latestProcessedChange: boolean

Defina como true para incluir as alterações mais recentes. O padrão é false.

download: boolean

Defina como true para baixar a resposta como um arquivo. O padrão é false.

versionDescriptor: GitVersionDescriptor

Descritor de versão. O padrão é o branch padrão para o repositório.

includeContent: boolean

Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.

resolveHfs: boolean

Defina como true para resolver arquivos de ponteiro do Git HFS para retornar o conteúdo real do Git HFS. O padrão é verdadeiro.

sanitize: boolean

Defina como true para limpar um arquivo svg e devolvê-lo como imagem. Útil somente se solicitado para o arquivo svg. O padrão é false.

Retornos

Promise<ArrayBuffer>

getImportRequest(string, string, number)

Recupere uma solicitação de importação específica.

function getImportRequest(project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryId: string

O nome ou a ID do repositório.

importRequestId: number

O identificador exclusivo da solicitação de importação.

Retornos

Promise<GitImportRequest>

getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItem(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<GitItem>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

path: string

O caminho do item.

project: string

ID do projeto ou nome do projeto

scopePath: string

O escopo do caminho. O padrão é nulo.

recursionLevel: VersionControlRecursionType

O nível de recursão dessa solicitação. O padrão é 'none', sem recursão.

includeContentMetadata: boolean

Defina como true para incluir metadados de conteúdo. O padrão é false.

latestProcessedChange: boolean

Defina como true para incluir as alterações mais recentes. O padrão é false.

download: boolean

Defina como true para baixar a resposta como um arquivo. O padrão é false.

versionDescriptor: GitVersionDescriptor

Descritor de versão. O padrão é o branch padrão para o repositório.

includeContent: boolean

Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.

resolveLfs: boolean

Defina como true para resolver arquivos de ponteiro git LFS para retornar conteúdo real do Git LFS. O padrão é false.

sanitize: boolean

Defina como true para limpar um arquivo svg e devolvê-lo como imagem. Útil somente se solicitado para o arquivo svg. O padrão é false.

Retornos

Promise<GitItem>

getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemContent(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

path: string

O caminho do item.

project: string

ID do projeto ou nome do projeto

scopePath: string

O escopo do caminho. O padrão é nulo.

recursionLevel: VersionControlRecursionType

O nível de recursão dessa solicitação. O padrão é 'none', sem recursão.

includeContentMetadata: boolean

Defina como true para incluir metadados de conteúdo. O padrão é false.

latestProcessedChange: boolean

Defina como true para incluir as alterações mais recentes. O padrão é false.

download: boolean

Defina como true para baixar a resposta como um arquivo. O padrão é false.

versionDescriptor: GitVersionDescriptor

Descritor de versão. O padrão é o branch padrão para o repositório.

includeContent: boolean

Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.

resolveLfs: boolean

Defina como true para resolver arquivos de ponteiro git LFS para retornar conteúdo real do Git LFS. O padrão é false.

sanitize: boolean

Defina como true para limpar um arquivo svg e devolvê-lo como imagem. Útil somente se solicitado para o arquivo svg. O padrão é false.

Retornos

Promise<ArrayBuffer>

getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)

function getItems(repositoryId: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, includeLinks?: boolean, versionDescriptor?: GitVersionDescriptor, zipForUnix?: boolean): Promise<GitItem[]>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

scopePath: string

O escopo do caminho. O padrão é nulo.

recursionLevel: VersionControlRecursionType

O nível de recursão dessa solicitação. O padrão é 'none', sem recursão.

includeContentMetadata: boolean

Defina como true para incluir metadados de conteúdo. O padrão é false.

latestProcessedChange: boolean

Defina como true para incluir as alterações mais recentes. O padrão é false.

download: boolean

Defina como true para baixar a resposta como um arquivo. O padrão é false.

includeLinks: boolean

Defina como true para incluir links para itens. O padrão é false.

versionDescriptor: GitVersionDescriptor

Descritor de versão. O padrão é o branch padrão para o repositório.

zipForUnix: boolean

Defina como true para manter as permissões de arquivo para sistemas unix (e POSIX), como executáveis e symlinks

Retornos

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Postar para recuperar uma criação de um lote de um conjunto de itens em um repositório/projeto, considerando uma lista de caminhos ou um caminho longo

function getItemsBatch(requestData: GitItemRequestData, repositoryId: string, project?: string): Promise<GitItem[][]>

Parâmetros

requestData: GitItemRequestData

Solicitar atributos de dados: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: coleção de itens a serem buscados, incluindo caminho, versão e nível de recursão. IncludeContentMetadata: se deve incluir metadados para todos os itens LatestProcessedChange: se deve incluir ref superficial para confirmar a última alteração de cada item. IncludeLinks: se deve incluir o campo _links nas referências rasas.

repositoryId: string

O nome ou a ID do repositório

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitItem[][]>

getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemText(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<string>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

path: string

O caminho do item.

project: string

ID do projeto ou nome do projeto

scopePath: string

O escopo do caminho. O padrão é nulo.

recursionLevel: VersionControlRecursionType

O nível de recursão dessa solicitação. O padrão é 'none', sem recursão.

includeContentMetadata: boolean

Defina como true para incluir metadados de conteúdo. O padrão é false.

latestProcessedChange: boolean

Defina como true para incluir as alterações mais recentes. O padrão é false.

download: boolean

Defina como true para baixar a resposta como um arquivo. O padrão é false.

versionDescriptor: GitVersionDescriptor

Descritor de versão. O padrão é o branch padrão para o repositório.

includeContent: boolean

Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.

resolveLfs: boolean

Defina como true para resolver arquivos de ponteiro git LFS para retornar conteúdo real do Git LFS. O padrão é false.

sanitize: boolean

Defina como true para limpar um arquivo svg e devolvê-lo como imagem. Útil somente se solicitado para o arquivo svg. O padrão é false.

Retornos

Promise<string>

getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)

function getItemZip(repositoryId: string, path: string, project?: string, scopePath?: string, recursionLevel?: VersionControlRecursionType, includeContentMetadata?: boolean, latestProcessedChange?: boolean, download?: boolean, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean, resolveLfs?: boolean, sanitize?: boolean): Promise<ArrayBuffer>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

path: string

O caminho do item.

project: string

ID do projeto ou nome do projeto

scopePath: string

O escopo do caminho. O padrão é nulo.

recursionLevel: VersionControlRecursionType

O nível de recursão dessa solicitação. O padrão é 'none', sem recursão.

includeContentMetadata: boolean

Defina como true para incluir metadados de conteúdo. O padrão é false.

latestProcessedChange: boolean

Defina como true para incluir as alterações mais recentes. O padrão é false.

download: boolean

Defina como true para baixar a resposta como um arquivo. O padrão é false.

versionDescriptor: GitVersionDescriptor

Descritor de versão. O padrão é o branch padrão para o repositório.

includeContent: boolean

Defina como true para incluir o conteúdo do item ao solicitar json. O padrão é false.

resolveLfs: boolean

Defina como true para resolver arquivos de ponteiro git LFS para retornar conteúdo real do Git LFS. O padrão é false.

sanitize: boolean

Defina como true para limpar um arquivo svg e devolvê-lo como imagem. Útil somente se solicitado para o arquivo svg. O padrão é false.

Retornos

Promise<ArrayBuffer>

getLikes(string, number, number, number, string)

Obtenha curtidas para um comentário.

function getLikes(repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<IdentityRef[]>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

threadId: number

A ID do thread que contém o comentário.

commentId: number

A ID do comentário.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<IdentityRef[]>

getMergeBases(string, string, string, string, string, string)

Localize as bases de mesclagem de duas confirmações, opcionalmente entre bifurcações. Se otherRepositoryId não for especificado, as bases de mesclagem serão calculadas apenas no contexto do repositório localNameOrId.

function getMergeBases(repositoryNameOrId: string, commitId: string, otherCommitId: string, project?: string, otherCollectionId?: string, otherRepositoryId?: string): Promise<GitCommitRef[]>

Parâmetros

repositoryNameOrId: string

ID ou nome do repositório local.

commitId: string

Primeira confirmação, geralmente a ponta do branch de destino da possível mesclagem.

otherCommitId: string

Outra confirmação, geralmente a ponta do branch de origem da possível mesclagem.

project: string

ID do projeto ou nome do projeto

otherCollectionId: string

A ID da coleção em que outrosCommitId residem.

otherRepositoryId: string

A ID do repositório em que outroCommitId reside.

Retornos

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

Obtenha detalhes de uma operação de mesclagem específica.

function getMergeRequest(project: string, repositoryNameOrId: string, mergeOperationId: number, includeLinks?: boolean): Promise<GitMerge>

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryNameOrId: string

O nome ou a ID do repositório.

mergeOperationId: number

OperationId da solicitação de mesclagem.

includeLinks: boolean

True para incluir links

Retornos

Promise<GitMerge>

getPermission(string, string, string)

Status da Permissão de Segurança Avançada GET.

function getPermission(projectName?: string, repositoryId?: string, permission?: string): Promise<boolean>

Parâmetros

projectName: string

repositoryId: string

O usuário do repositório está tentando acessar

permission: string

A permissão que está sendo solicitada deve ser "viewAlert" "dismissAlert" "manage" "viewEnablement" ou "repoRead"

Retornos

Promise<boolean>

getPullRequest(string, number, string, number, number, number, boolean, boolean)

Recuperar uma solicitação de pull.

function getPullRequest(repositoryId: string, pullRequestId: number, project?: string, maxCommentLength?: number, skip?: number, top?: number, includeCommits?: boolean, includeWorkItemRefs?: boolean): Promise<GitPullRequest>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

A ID da solicitação de pull a ser recuperada.

project: string

ID do projeto ou nome do projeto

maxCommentLength: number

Não usado.

skip: number

Não usado.

top: number

Não usado.

includeCommits: boolean

Se for true, a solicitação de pull será retornada com as confirmações associadas.

includeWorkItemRefs: boolean

Se for true, a solicitação de pull será retornada com as referências de item de trabalho associadas.

Retornos

Promise<GitPullRequest>

getPullRequestById(number, string)

Recuperar uma solicitação de pull.

function getPullRequestById(pullRequestId: number, project?: string): Promise<GitPullRequest>

Parâmetros

pullRequestId: number

A ID da solicitação de pull a ser recuperada.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

Obtenha as confirmações para a solicitação de pull especificada.

function getPullRequestCommits(repositoryId: string, pullRequestId: number, project?: string): Promise<PagedList<GitCommitRef>>

Parâmetros

repositoryId: string

ID ou nome do repositório.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Recuperar um conflito para uma solicitação de pull por ID

function getPullRequestConflict(repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

Parâmetros

repositoryId: string

pullRequestId: number

conflictId: number

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitConflict>

getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)

Recuperar todos os conflitos para uma solicitação de pull

function getPullRequestConflicts(repositoryId: string, pullRequestId: number, project?: string, skip?: number, top?: number, includeObsolete?: boolean, excludeResolved?: boolean, onlyResolved?: boolean): Promise<GitConflict[]>

Parâmetros

repositoryId: string

O repositório da Solicitação pull.

pullRequestId: number

A ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

skip: number

Conflitos para ignorar.

top: number

Conflitos para retornar após ignorar.

includeObsolete: boolean

Inclui conflitos obsoletos.

excludeResolved: boolean

Exclui conflitos já resolvidos.

onlyResolved: boolean

Retorna apenas os conflitos resolvidos.

Retornos

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

Obtenha a iteração especificada para uma solicitação de pull.

function getPullRequestIteration(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestIteration>

Parâmetros

repositoryId: string

ID ou nome do repositório.

pullRequestId: number

ID da solicitação de pull.

iterationId: number

ID da iteração de solicitação de pull a ser retornada.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequestIteration>

getPullRequestIterationChanges(string, number, number, string, number, number, number)

Recupere as alterações feitas em uma solicitação de pull entre duas iterações.

function getPullRequestIterationChanges(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number, compareTo?: number): Promise<GitPullRequestIterationChanges>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

iterationId: number

ID da iteração de solicitação de pull. <br/> Iteração um é o chefe do branch de origem no momento em que a solicitação de pull é criada e as iterações subsequentes são criadas quando há pushes para o branch de origem. Os valores permitidos estão entre 1 e a iteração máxima nesta solicitação de pull.

project: string

ID do projeto ou nome do projeto

top: number

Opcional. O número de alterações a serem recuperadas. O valor padrão é 100 e o valor máximo é 2000.

skip: number

Opcional. O número de alterações a serem ignoradas. Por exemplo, para recuperar as alterações 101-150, defina os 50 primeiros e pule para 100.

compareTo: number

ID da iteração de solicitação de pull com a qual comparar. O valor padrão é zero, o que indica que a comparação é feita em relação à confirmação comum entre os branches de origem e de destino

Retornos

Promise<GitPullRequestIterationChanges>

getPullRequestIterationCommits(string, number, number, string, number, number)

Obtenha as confirmações para a iteração especificada de uma solicitação de pull.

function getPullRequestIterationCommits(repositoryId: string, pullRequestId: number, iterationId: number, project?: string, top?: number, skip?: number): Promise<GitCommitRef[]>

Parâmetros

repositoryId: string

ID ou nome do repositório.

pullRequestId: number

ID da solicitação de pull.

iterationId: number

ID da iteração da qual obter as confirmações.

project: string

ID do projeto ou nome do projeto

top: number

Número máximo de confirmações a serem retornadas. O número máximo de confirmações que podem ser retornadas por lote é 500.

skip: number

Número de confirmações a serem ignoradas.

Retornos

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

Obtenha a lista de iterações para a solicitação de pull especificada.

function getPullRequestIterations(repositoryId: string, pullRequestId: number, project?: string, includeCommits?: boolean): Promise<GitPullRequestIteration[]>

Parâmetros

repositoryId: string

ID ou nome do repositório.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

includeCommits: boolean

Se for true, inclua as confirmações associadas a cada iteração na resposta.

Retornos

Promise<GitPullRequestIteration[]>

getPullRequestIterationStatus(string, number, number, number, string)

Obtenha o status de iteração de solicitação de pull específico por ID. A ID de status é exclusiva dentro da solicitação de pull em todas as iterações.

function getPullRequestIterationStatus(repositoryId: string, pullRequestId: number, iterationId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

iterationId: number

ID da iteração de solicitação de pull.

statusId: number

ID do status da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

Obtenha todos os status associados a uma iteração de solicitação de pull.

function getPullRequestIterationStatuses(repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<GitPullRequestStatus[]>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

iterationId: number

ID da iteração de solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequestStatus[]>

getPullRequestLabel(string, number, string, string, string)

Recupera um único rótulo (marca) que foi atribuído a uma solicitação de pull.

function getPullRequestLabel(repositoryId: string, pullRequestId: number, labelIdOrName: string, project?: string, projectId?: string): Promise<WebApiTagDefinition>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

labelIdOrName: string

O nome ou a ID do rótulo solicitado.

project: string

ID do projeto ou nome do projeto

projectId: string

ID do projeto ou nome do projeto.

Retornos

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

Obtenha todos os rótulos (marcas) atribuídos a uma solicitação de pull.

function getPullRequestLabels(repositoryId: string, pullRequestId: number, project?: string, projectId?: string): Promise<WebApiTagDefinition[]>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

projectId: string

ID do projeto ou nome do projeto.

Retornos

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

Obtenha propriedades externas da solicitação de pull.

function getPullRequestProperties(repositoryId: string, pullRequestId: number, project?: string): Promise<any>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

Essa API é usada para localizar quais solicitações de pull estão relacionadas a uma determinada confirmação. Ele pode ser usado para localizar a solicitação de pull que criou uma confirmação de mesclagem específica ou pode ser usada para localizar todas as solicitações de pull que já mesclaram uma confirmação específica. A entrada é uma lista de consultas que contêm uma lista de confirmações. Para cada confirmação que você pesquisa, você receberá de volta um dicionário de confirmação –> solicitações de pull.

function getPullRequestQuery(queries: GitPullRequestQuery, repositoryId: string, project?: string): Promise<GitPullRequestQuery>

Parâmetros

queries: GitPullRequestQuery

A lista de consultas a serem executadas.

repositoryId: string

ID do repositório.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

Recuperar informações sobre um revisor específico em uma solicitação de pull

function getPullRequestReviewer(repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

reviewerId: string

ID do revisor.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

Recuperar os revisores para uma solicitação de pull

function getPullRequestReviewers(repositoryId: string, pullRequestId: number, project?: string): Promise<IdentityRefWithVote[]>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<IdentityRefWithVote[]>

getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)

Recupere todas as solicitações de pull que correspondam a um critério especificado.

function getPullRequests(repositoryId: string, searchCriteria: GitPullRequestSearchCriteria, project?: string, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

searchCriteria: GitPullRequestSearchCriteria

Serão retornadas solicitações de pull que correspondam a esses critérios de pesquisa.

project: string

ID do projeto ou nome do projeto

maxCommentLength: number

Não usado.

skip: number

O número de solicitações de pull a serem ignoradas. Por exemplo, para recuperar os resultados de 101 a 150, defina a parte superior como 50 e pule para 100.

top: number

O número de solicitações de pull a serem recuperadas.

Retornos

Promise<GitPullRequest[]>

getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)

Recupere todas as solicitações de pull que correspondam a um critério especificado.

function getPullRequestsByProject(project: string, searchCriteria: GitPullRequestSearchCriteria, maxCommentLength?: number, skip?: number, top?: number): Promise<GitPullRequest[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

searchCriteria: GitPullRequestSearchCriteria

Serão retornadas solicitações de pull que correspondam a esses critérios de pesquisa.

maxCommentLength: number

Não usado.

skip: number

O número de solicitações de pull a serem ignoradas. Por exemplo, para recuperar os resultados de 101 a 150, defina a parte superior como 50 e pule para 100.

top: number

O número de solicitações de pull a serem recuperadas.

Retornos

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

Obtenha o status de solicitação de pull específico por ID. A ID de status é exclusiva dentro da solicitação de pull em todas as iterações.

function getPullRequestStatus(repositoryId: string, pullRequestId: number, statusId: number, project?: string): Promise<GitPullRequestStatus>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

statusId: number

ID do status da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

Obtenha todos os status associados a uma solicitação de pull.

function getPullRequestStatuses(repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequestStatus[]>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequestStatus[]>

getPullRequestThread(string, number, number, string, number, number)

Recupere um thread em uma solicitação de pull.

function getPullRequestThread(repositoryId: string, pullRequestId: number, threadId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

threadId: number

ID do thread.

project: string

ID do projeto ou nome do projeto

iteration: number

Se especificado, a posição do thread será controlada usando essa iteração como o lado direito da diferença.

baseIteration: number

Se especificado, a posição do thread será controlada usando essa iteração como o lado esquerdo da diferença.

Retornos

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

Recupere uma lista de itens de trabalho associados a uma solicitação de pull.

function getPullRequestWorkItemRefs(repositoryId: string, pullRequestId: number, project?: string): Promise<ResourceRef[]>

Parâmetros

repositoryId: string

ID ou nome do repositório.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<ResourceRef[]>

getPush(string, number, string, number, boolean)

Recupera um push específico.

function getPush(repositoryId: string, pushId: number, project?: string, includeCommits?: number, includeRefUpdates?: boolean): Promise<GitPush>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

pushId: number

ID do push.

project: string

ID do projeto ou nome do projeto

includeCommits: number

O número de confirmações a serem incluídas no resultado.

includeRefUpdates: boolean

Se for true, inclua a lista de refs que foram atualizados pelo push.

Retornos

Promise<GitPush>

getPushCommits(string, number, string, number, number, boolean)

Recupere uma lista de confirmações associadas a um push específico.

function getPushCommits(repositoryId: string, pushId: number, project?: string, top?: number, skip?: number, includeLinks?: boolean): Promise<GitCommitRef[]>

Parâmetros

repositoryId: string

A ID ou o nome amigável do repositório. Para usar o nome amigável, projectId também deve ser especificado.

pushId: number

A ID do push.

project: string

ID do projeto ou nome do projeto

top: number

O número máximo de confirmações a serem retornadas ("obter as confirmações x superiores").

skip: number

O número de confirmações a serem ignoradas.

includeLinks: boolean

Defina como false para evitar a inclusão de links de URL REST para recursos. O padrão é true.

Retornos

Promise<GitCommitRef[]>

getPushes(string, string, number, number, GitPushSearchCriteria)

Recupera pushes associados ao repositório especificado.

function getPushes(repositoryId: string, project?: string, skip?: number, top?: number, searchCriteria?: GitPushSearchCriteria): Promise<GitPush[]>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

skip: number

Número de pushes a serem ignoradas.

top: number

Número de pushes a serem retornados.

searchCriteria: GitPushSearchCriteria

Atributos de critérios de pesquisa: fromDate, toDate, pusherId, refName, includeRefUpdates ou includeLinks. fromDate: data de início da pesquisa. toDate: Data de término para a qual pesquisar. pusherId: identidade da pessoa que enviou o push. refName: nome do branch a ser considerado. includeRefUpdates: se verdadeiro, inclua a lista de refs que foram atualizados pelo push. includeLinks: se deve incluir o campo _links nas referências rasas.

Retornos

Promise<GitPush[]>

getRecycleBinRepositories(string)

Recupere repositórios git excluídos suavemente da lixeira.

function getRecycleBinRepositories(project: string): Promise<GitDeletedRepository[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Obtém o favorito dos árbitros para uma ID favorita.

function getRefFavorite(project: string, favoriteId: number): Promise<GitRefFavorite>

Parâmetros

project: string

ID do projeto ou nome do projeto

favoriteId: number

A ID do ref favorito solicitado.

Retornos

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Obtém os favoritos de refs para um repositório e uma identidade.

function getRefFavorites(project: string, repositoryId?: string, identityId?: string): Promise<GitRefFavorite[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryId: string

A ID do repositório.

identityId: string

A ID da identidade cujos favoritos devem ser recuperados. Se for nulo, a identidade de solicitação será usada.

Retornos

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

function getRefFavoritesForProject(project: string, identityId?: string): Promise<GitRefFavorite[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

identityId: string

Retornos

Promise<GitRefFavorite[]>

getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)

Consulta o repositório fornecido para seus refs e os retorna.

function getRefs(repositoryId: string, project?: string, filter?: string, includeLinks?: boolean, includeStatuses?: boolean, includeMyBranches?: boolean, latestStatusesOnly?: boolean, peelTags?: boolean, filterContains?: string): Promise<PagedList<GitRef>>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

filter: string

[opcional] Um filtro a ser aplicado aos refs (começa com).

includeLinks: boolean

[opcional] Especifica se referenceLinks devem ser incluídos no resultado. o padrão é false.

includeStatuses: boolean

[opcional] Inclui até os primeiros 1000 status de confirmação para cada ref. O valor padrão é false.

includeMyBranches: boolean

[opcional] Inclui apenas branches que o usuário possui, os branches dos favoritos do usuário e o branch padrão. O valor padrão é false. Não é possível combinar com o parâmetro de filtro.

latestStatusesOnly: boolean

[opcional] True para incluir apenas o status de confirmação de gorjeta para cada ref. Essa opção requer que includeStatuses seja verdadeira. O valor padrão é false.

peelTags: boolean

[opcional] As marcas anotadas preencherão a propriedade PeeledObjectId. o padrão é false.

filterContains: string

[opcional] Um filtro a ser aplicado aos refs (contém).

Retornos

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

Recuperar repositórios git.

function getRepositories(project?: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean): Promise<GitRepository[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

includeLinks: boolean

[opcional] True para incluir links de referência. O valor padrão é false.

includeAllUrls: boolean

[opcional] True para incluir todas as URLs remotas. O valor padrão é false.

includeHidden: boolean

[opcional] True para incluir repositórios ocultos. O valor padrão é false.

Retornos

Promise<GitRepository[]>

getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)

Recupere repositórios git com filtro por nome e paginação.

function getRepositoriesPaged(projectId: string, includeLinks?: boolean, includeAllUrls?: boolean, includeHidden?: boolean, filterContains?: string, top?: number, continuationToken?: string): Promise<PagedList<GitRepository>>

Parâmetros

projectId: string

ID ou nome do projeto de equipe.

includeLinks: boolean

[opcional] True para incluir links de referência. O valor padrão é false.

includeAllUrls: boolean

[opcional] True para incluir todas as URLs remotas. O valor padrão é false.

includeHidden: boolean

[opcional] True para incluir repositórios ocultos. O valor padrão é false.

filterContains: string

[opcional] Um filtro a ser aplicado aos refs (contém).

top: number

[opcional] Número máximo de repositórios a serem retornados. Não pode ser maior que 500. Se ele não for fornecido, mas continuationToken for, a parte superior será padrão para 100.

continuationToken: string

O token de continuação usado para paginação.

Retornos

Promise<PagedList<GitRepository>>

getRepository(string, string)

Recupere um repositório git.

function getRepository(repositoryId: string, project?: string): Promise<GitRepository>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

Recupere um repositório git.

function getRepositoryWithParent(repositoryId: string, includeParent: boolean, project?: string): Promise<GitRepository>

Parâmetros

repositoryId: string

O nome ou a ID do repositório.

includeParent: boolean

True para incluir o repositório pai. Disponível apenas em chamadas autenticadas.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitRepository>

getRevert(string, number, string)

Recupere informações sobre uma operação de reversão por ID de reversão.

function getRevert(project: string, revertId: number, repositoryId: string): Promise<GitRevert>

Parâmetros

project: string

ID do projeto ou nome do projeto

revertId: number

ID da operação de reversão.

repositoryId: string

ID do repositório.

Retornos

Promise<GitRevert>

getRevertConflict(string, number, number, string)

Recuperar um conflito para reverter por ID

function getRevertConflict(repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

Parâmetros

repositoryId: string

revertId: number

conflictId: number

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitConflict>

getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)

Recuperar todos os conflitos para reverter

function getRevertConflicts(repositoryId: string, revertId: number, project?: string, continuationToken?: string, top?: number, excludeResolved?: boolean, onlyResolved?: boolean, includeObsolete?: boolean): Promise<PagedList<GitConflict>>

Parâmetros

repositoryId: string

revertId: number

project: string

ID do projeto ou nome do projeto

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Retornos

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

Recupere informações sobre uma operação de reversão para um branch específico.

function getRevertForRefName(project: string, repositoryId: string, refName: string): Promise<GitRevert>

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryId: string

ID do repositório.

refName: string

O GitAsyncRefOperationParameters generatedRefName usado para a operação de reversão.

Retornos

Promise<GitRevert>

getStatuses(string, string, string, number, number, boolean)

Obter status associados à confirmação do Git.

function getStatuses(commitId: string, repositoryId: string, project?: string, top?: number, skip?: number, latestOnly?: boolean): Promise<GitStatus[]>

Parâmetros

commitId: string

ID da confirmação do Git.

repositoryId: string

ID do repositório.

project: string

ID do projeto ou nome do projeto

top: number

Opcional. O número de status a serem recuperados. O padrão é 1000.

skip: number

Opcional. O número de status a serem ignorados. O padrão é 0. Por exemplo, para recuperar os resultados de 101 a 150, defina a parte superior como 50 e pule para 100.

latestOnly: boolean

O sinalizador indica se os status mais recentes serão agrupados apenas por Context.Name e Context.Genre.

Retornos

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

Recupere uma sugestão de solicitação de pull para um repositório ou projeto de equipe específico.

function getSuggestions(repositoryId: string, project?: string, preferCompareBranch?: boolean): Promise<GitSuggestion[]>

Parâmetros

repositoryId: string

ID do repositório git.

project: string

ID do projeto ou nome do projeto

preferCompareBranch: boolean

Se for true, prefira a ramificação de comparação em vez do branch padrão como branch de destino para solicitações de pull.

Retornos

Promise<GitSuggestion[]>

getThreads(string, number, string, number, number)

Recupere todos os threads em uma solicitação de pull.

function getThreads(repositoryId: string, pullRequestId: number, project?: string, iteration?: number, baseIteration?: number): Promise<GitPullRequestCommentThread[]>

Parâmetros

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

iteration: number

Se especificado, as posições de thread serão controladas usando essa iteração como o lado direito da diferença.

baseIteration: number

Se especificado, as posições de thread serão controladas usando essa iteração como o lado esquerdo da diferença.

Retornos

Promise<GitPullRequestCommentThread[]>

getTree(string, string, string, string, boolean, string)

O ponto de extremidade árvore retorna a coleção de objetos abaixo da árvore especificada. Árvores são pastas em um repositório Git.

function getTree(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<GitTreeRef>

Parâmetros

repositoryId: string

ID do repositório.

sha1: string

Hash SHA1 do objeto de árvore.

project: string

ID do projeto ou nome do projeto

projectId: string

ID do projeto.

recursive: boolean

Pesquise recursivamente. Inclua árvores abaixo desta árvore. O padrão é false.

fileName: string

Nome a ser usado se um arquivo .zip for retornado. O padrão é a ID do objeto.

Retornos

Promise<GitTreeRef>

getTreeZip(string, string, string, string, boolean, string)

O ponto de extremidade árvore retorna a coleção de objetos abaixo da árvore especificada. Árvores são pastas em um repositório Git.

function getTreeZip(repositoryId: string, sha1: string, project?: string, projectId?: string, recursive?: boolean, fileName?: string): Promise<ArrayBuffer>

Parâmetros

repositoryId: string

ID do repositório.

sha1: string

Hash SHA1 do objeto de árvore.

project: string

ID do projeto ou nome do projeto

projectId: string

ID do projeto.

recursive: boolean

Pesquise recursivamente. Inclua árvores abaixo desta árvore. O padrão é false.

fileName: string

Nome a ser usado se um arquivo .zip for retornado. O padrão é a ID do objeto.

Retornos

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

Recupere solicitações de importação para um repositório.

function queryImportRequests(project: string, repositoryId: string, includeAbandoned?: boolean): Promise<GitImportRequest[]>

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryId: string

O nome ou a ID do repositório.

includeAbandoned: boolean

True para incluir solicitações de importação abandonadas nos resultados.

Retornos

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

Recupere um repositório Git com exclusão reversível. Os repositórios excluídos recentemente entram em um estado de exclusão reversível por um período antes de serem excluídos e se tornarem irrecuperáveis.

function restoreRepositoryFromRecycleBin(repositoryDetails: GitRecycleBinRepositoryDetails, project: string, repositoryId: string): Promise<GitRepository>

Parâmetros

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

ID do projeto ou nome do projeto

repositoryId: string

A ID do repositório.

Retornos

Promise<GitRepository>

setEnableOnCreateHost(boolean)

function setEnableOnCreateHost(enableOnCreateHost: boolean): Promise<void>

Parâmetros

enableOnCreateHost: boolean

Retornos

Promise<void>

setEnableOnCreateProject(string, boolean)

function setEnableOnCreateProject(enableOnCreateProjectId: string, enableOnStatus: boolean): Promise<void>

Parâmetros

enableOnCreateProjectId: string

enableOnStatus: boolean

Retornos

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

Envia uma notificação por email sobre uma solicitação de pull específica para um conjunto de destinatários

function sharePullRequest(userMessage: ShareNotificationContext, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Parâmetros

userMessage: ShareNotificationContext

repositoryId: string

ID do repositório git.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

updateCherryPickConflict(GitConflict, string, number, number, string)

Atualizar a resolução de conflitos de mesclagem

function updateCherryPickConflict(conflict: GitConflict, repositoryId: string, cherryPickId: number, conflictId: number, project?: string): Promise<GitConflict>

Parâmetros

conflict: GitConflict

repositoryId: string

cherryPickId: number

conflictId: number

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitConflict>

updateCherryPickConflicts(GitConflict[], string, number, string)

Atualizar várias resoluções de conflitos de mesclagem

function updateCherryPickConflicts(conflictUpdates: GitConflict[], repositoryId: string, cherryPickId: number, project?: string): Promise<GitConflictUpdateResult[]>

Parâmetros

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitConflictUpdateResult[]>

updateComment(Comment, string, number, number, number, string)

Atualize um comentário associado a um thread específico em uma solicitação de pull.

function updateComment(comment: Comment, repositoryId: string, pullRequestId: number, threadId: number, commentId: number, project?: string): Promise<Comment>

Parâmetros

comment: Comment

O conteúdo do comentário que deve ser atualizado. Os comentários podem ter até 150.000 caracteres.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

threadId: number

ID do thread em que o comentário desejado está.

commentId: number

ID do comentário a ser atualizado.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

Status de habilitação POST para repositórios.

function updateEnablementStatus(enablementUpdates: AdvSecEnablementUpdate[]): Promise<void>

Parâmetros

enablementUpdates: AdvSecEnablementUpdate[]

Retornos

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

Tente novamente ou abandone uma solicitação de importação com falha.

function updateImportRequest(importRequestToUpdate: GitImportRequest, project: string, repositoryId: string, importRequestId: number): Promise<GitImportRequest>

Parâmetros

importRequestToUpdate: GitImportRequest

A versão atualizada da solicitação de importação. Atualmente, a única alteração permitida é definir o Status como Enfileirado ou Abandonado.

project: string

ID do projeto ou nome do projeto

repositoryId: string

O nome ou a ID do repositório.

importRequestId: number

O identificador exclusivo da solicitação de importação a ser atualizada.

Retornos

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

Atualizar uma solicitação de pull

function updatePullRequest(gitPullRequestToUpdate: GitPullRequest, repositoryId: string, pullRequestId: number, project?: string): Promise<GitPullRequest>

Parâmetros

gitPullRequestToUpdate: GitPullRequest

O conteúdo da solicitação de pull que deve ser atualizado.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull a ser atualizada.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequest>

updatePullRequestConflict(GitConflict, string, number, number, string)

Atualizar a resolução de conflitos de mesclagem

function updatePullRequestConflict(conflict: GitConflict, repositoryId: string, pullRequestId: number, conflictId: number, project?: string): Promise<GitConflict>

Parâmetros

conflict: GitConflict

repositoryId: string

pullRequestId: number

conflictId: number

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitConflict>

updatePullRequestConflicts(GitConflict[], string, number, string)

Atualizar várias resoluções de conflitos de mesclagem

function updatePullRequestConflicts(conflictUpdates: GitConflict[], repositoryId: string, pullRequestId: number, project?: string): Promise<GitConflictUpdateResult[]>

Parâmetros

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitConflictUpdateResult[]>

updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)

Atualizar a coleção de status de iteração de solicitação de pull de atualização. O único tipo de operação com suporte é remove.

function updatePullRequestIterationStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, iterationId: number, project?: string): Promise<void>

Parâmetros

patchDocument: JsonPatchDocument

Operações a serem aplicadas aos status da solicitação de pull no formato de patch JSON.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

iterationId: number

ID da iteração de solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

Criar ou atualizar propriedades externas da solicitação de pull. A operação de patch pode ser add, replace ou remove. Para add operação, o caminho pode estar vazio. Se o caminho estiver vazio, o valor deverá ser uma lista de pares de valores de chave. Para replace operação, o caminho não pode estar vazio. Se o caminho não existir, a propriedade será adicionada à coleção. Para remove operação, o caminho não pode estar vazio. Se o caminho não existir, nenhuma ação será executada.

function updatePullRequestProperties(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<any>

Parâmetros

patchDocument: JsonPatchDocument

Propriedades a serem adicionadas, substituídas ou removidas no formato de Patch JSON.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<any>

updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)

Editar uma entrada de revisor. Esses campos podem ser corrigidos: isFlagged, hasDeclined

function updatePullRequestReviewer(reviewer: IdentityRefWithVote, repositoryId: string, pullRequestId: number, reviewerId: string, project?: string): Promise<IdentityRefWithVote>

Parâmetros

reviewer: IdentityRefWithVote

Dados do revisor.<br/>Se a ID do revisor estiver incluída aqui, ela deverá corresponder ao parâmetro reviewerID.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

reviewerId: string

ID do revisor.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<IdentityRefWithVote>

updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)

Redefina os votos de vários revisores em uma solicitação de pull. OBSERVAÇÃO: esse ponto de extremidade só dá suporte à atualização de votos, mas não dá suporte à atualização de revisores necessários (política de uso) ou nomes de exibição.

function updatePullRequestReviewers(patchVotes: IdentityRefWithVote[], repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Parâmetros

patchVotes: IdentityRefWithVote[]

IDs dos revisores cujos votos serão redefinidos para zero

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

Atualizar a coleção de status de solicitação de pull. O único tipo de operação com suporte é remove.

function updatePullRequestStatuses(patchDocument: JsonPatchDocument, repositoryId: string, pullRequestId: number, project?: string): Promise<void>

Parâmetros

patchDocument: JsonPatchDocument

Operações a serem aplicadas aos status da solicitação de pull no formato de patch JSON.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<void>

updateRef(GitRefUpdate, string, string, string, string)

Bloquear ou desbloquear um branch.

function updateRef(newRefInfo: GitRefUpdate, repositoryId: string, filter: string, project?: string, projectId?: string): Promise<GitRef>

Parâmetros

newRefInfo: GitRefUpdate

A ação de atualização ref (bloqueio/desbloqueio) a ser executada

repositoryId: string

O nome ou a ID do repositório.

filter: string

O nome do branch a ser bloqueado/desbloqueado

project: string

ID do projeto ou nome do projeto

projectId: string

ID ou nome do projeto de equipe. Opcional se especificar uma ID para o repositório.

Retornos

Promise<GitRef>

updateRefs(GitRefUpdate[], string, string, string)

Criando, atualizando ou excluindo refs(branches).

function updateRefs(refUpdates: GitRefUpdate[], repositoryId: string, project?: string, projectId?: string): Promise<GitRefUpdateResult[]>

Parâmetros

refUpdates: GitRefUpdate[]

Lista de atualizações ref para tentar executar

repositoryId: string

O nome ou a ID do repositório.

project: string

ID do projeto ou nome do projeto

projectId: string

ID ou nome do projeto de equipe. Opcional se especificar uma ID para o repositório.

Retornos

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Atualiza o repositório Git com um novo nome de repositório ou um novo branch padrão.

function updateRepository(newRepositoryInfo: GitRepository, repositoryId: string, project?: string): Promise<GitRepository>

Parâmetros

newRepositoryInfo: GitRepository

Especificar um novo nome de repositório ou um novo branch padrão do repositório

repositoryId: string

A ID do repositório.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitRepository>

updateRevertConflict(GitConflict, string, number, number, string)

Atualizar a resolução de conflitos de mesclagem

function updateRevertConflict(conflict: GitConflict, repositoryId: string, revertId: number, conflictId: number, project?: string): Promise<GitConflict>

Parâmetros

conflict: GitConflict

repositoryId: string

revertId: number

conflictId: number

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitConflict>

updateRevertConflicts(GitConflict[], string, number, string)

Atualizar várias resoluções de conflitos de mesclagem

function updateRevertConflicts(conflictUpdates: GitConflict[], repositoryId: string, revertId: number, project?: string): Promise<GitConflictUpdateResult[]>

Parâmetros

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitConflictUpdateResult[]>

updateThread(GitPullRequestCommentThread, string, number, number, string)

Atualize um thread em uma solicitação de pull.

function updateThread(commentThread: GitPullRequestCommentThread, repositoryId: string, pullRequestId: number, threadId: number, project?: string): Promise<GitPullRequestCommentThread>

Parâmetros

commentThread: GitPullRequestCommentThread

O conteúdo do thread que deve ser atualizado.

repositoryId: string

A ID do repositório do branch de destino da solicitação de pull.

pullRequestId: number

ID da solicitação de pull.

threadId: number

ID do thread a ser atualizado.

project: string

ID do projeto ou nome do projeto

Retornos

Promise<GitPullRequestCommentThread>

Compartilhar via

GitRestClient class

Construtores

Propriedades

Métodos

Detalhes do construtor

GitRestClient(IVssRestClientOptions)

Parâmetros

Detalhes da propriedade

RESOURCE_AREA_ID

Valor da propriedade

Detalhes do método

createAnnotatedTag(GitAnnotatedTag, string, string)

Parâmetros

Retornos

createAttachment(any, string, string, number, string)

Parâmetros

Retornos

createCherryPick(GitAsyncRefOperationParameters, string, string)

Parâmetros

Retornos

createComment(Comment, string, number, number, string)

Parâmetros

Retornos

createCommitStatus(GitStatus, string, string, string)

Parâmetros

Retornos

createFavorite(GitRefFavorite, string)

Parâmetros

Retornos

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Parâmetros

Retornos

createImportRequest(GitImportRequest, string, string)

Parâmetros

Retornos

createLike(string, number, number, number, string)

Parâmetros

Retornos

createMergeRequest(GitMergeParameters, string, string, boolean)

Parâmetros

Retornos

createPullRequest(GitPullRequest, string, string, boolean)

Parâmetros

Retornos

createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)

Parâmetros

Retornos

createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)

Parâmetros

Retornos

createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)

Parâmetros

Retornos

createPullRequestReviewers(IdentityRef[], string, number, string)

Parâmetros

Retornos

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Parâmetros

Retornos

createPush(GitPush, string, string)

Parâmetros

Retornos

createRepository(GitRepositoryCreateOptions, string, string)

Parâmetros

Retornos

createRevert(GitAsyncRefOperationParameters, string, string)

Parâmetros

Retornos

createThread(GitPullRequestCommentThread, string, number, string)

Parâmetros

Retornos

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Parâmetros

Retornos

deleteAttachment(string, string, number, string)

Parâmetros

Retornos

deleteComment(string, number, number, number, string)

Parâmetros