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 tag anotada.
createAttachment(any, string, string, number, string)	Anexe um novo arquivo a uma solicitação pull.
createCherryPick(GitAsyncRefOperationParameters, string, string)	Escolha a dedo uma confirmação ou confirmações específicas associadas a uma solicitação pull em uma nova ramificação.
createComment(Comment, string, number, number, string)	Crie um comentário em um thread específico em uma solicitação pull (até 500 comentários podem ser criados por thread).
createCommitStatus(GitStatus, string, string, string)	Crie o status de confirmação do Git.
createFavorite(GitRefFavorite, string)	Cria um favorito ref
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Solicite que as refs de outro repositório sejam buscadas neste. Ele sincroniza duas bifurcações existentes. Para criar uma bifurcação, consulte a <a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> pontos finais de repositórios</a>
createImportRequest(GitImportRequest, string, string)	Crie uma solicitação de importação.
createLike(string, number, number, number, string)	Adicione um gosto a um comentário.
createMergeRequest(GitMergeParameters, string, string, boolean)	Solicite uma operação de mesclagem git. Atualmente apoiamos a fusão de apenas 2 commits.
createPullRequest(GitPullRequest, string, string, boolean)	Crie uma solicitação pull.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Crie um status de solicitação pull na iteração. Esta operação terá o mesmo resultado que Criar status na solicitação pull com ID de iteração especificado no corpo da solicitação.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Crie uma tag (se ela ainda não existir) e adicione-a como um label (tag) para uma solicitação pull especificada. O único campo obrigatório é o nome da nova etiqueta (etiqueta).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Adicione um revisor a um pull request ou vote nele.
createPullRequestReviewers(IdentityRef[], string, number, string)	Adicione revisores a uma solicitação pull.
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Crie um status de solicitação 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 uma nova ramificação que reverte as alterações introduzidas por uma confirmação específica ou confirmações associadas a uma solicitação pull.
createThread(GitPullRequestCommentThread, string, number, string)	Crie um thread em uma solicitação pull.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Adicione uma identidade não materializada aos revisores de uma solicitação pull.
deleteAttachment(string, string, number, string)	Exclua um anexo de solicitação pull.
deleteComment(string, number, number, number, string)	Exclua um comentário associado a um thread específico em uma solicitação pull.
deleteEnablementStatus(boolean, boolean, string[])	DELETE Exclui o status de ativação e os dados de BillableCommitters do banco de dados. A exclusão dos dados de ativação os desativará efetivamente para os repositórios afetados.
deleteLike(string, number, number, number, string)	Excluir uma curtida em um comentário.
deletePullRequestIterationStatus(string, number, number, number, string)	Exclua o status da iteração da solicitação pull.
deletePullRequestLabels(string, number, string, string, string)	Remove um rótulo (tag) do conjunto daqueles atribuídos à solicitação pull. A tag em si não será excluída.
deletePullRequestReviewer(string, number, string, string)	Remova um revisor de uma solicitação pull.
deletePullRequestStatus(string, number, number, string)	Exclua o status da solicitação pull.
deleteRefFavorite(string, number)	Exclui o favorito de refs especificado
deleteRepository(string, string)	Excluir um repositório git
deleteRepositoryFromRecycleBin(string, string)	Destrua (exclusão forçada) um repositório Git excluído suavemente.
getAnnotatedTag(string, string, string)	Obtenha uma tag anotada.
getAttachmentContent(string, string, number, string)	Obtenha o conteúdo do arquivo de um anexo de solicitação pull.
getAttachments(string, number, string)	Obtenha uma lista de arquivos anexados a uma determinada solicitação pull.
getAttachmentZip(string, string, number, string)	Obtenha o conteúdo do arquivo de um anexo de solicitação pull.
getBillableCommitters(string, Date, number, number)	Recupere committers faturáveis reais para o serviço de Segurança Avançada para uma determinada data.
getBillableCommittersDetail(string, string, Date)	Recupere committers reais faturáveis detalhados para o serviço de Segurança Avançada para uma determinada data. Resultados detalhados intencionalmente não filtram projetos e repositórios excluídos suavemente para ajudar a diagnosticar problemas de faturamento.
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 uma única ramificação.
getBranches(string, string, GitVersionDescriptor)	Recupere estatísticas sobre todas as ramificações em um repositório.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Recuperar estatísticas de 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 cherry pick pelo Id cherry pick.
getCherryPickConflict(string, number, number, string)	Recuperar um conflito para uma escolha seletiva por ID
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Recupere todos os conflitos para uma escolha seletiva
getCherryPickForRefName(string, string, string)	Recupere informações sobre uma operação de escolha seletiva para uma ramificação específica. Esta operação é dispendiosa devido à estrutura subjacente do objeto, pelo que esta API analisa apenas as 1000 operações de cherry pick mais recentes.
getCherryPickRelationships(string, string, string, boolean)	Dado um commitId, retorna uma lista de commits que estão na mesma família cherry-pick.
getComment(string, number, number, number, string)	Recupere um comentário associado a um thread específico em uma solicitação pull.
getComments(string, number, number, string)	Recupere todos os comentários associados a um thread específico em uma solicitação pull.
getCommit(string, string, string, number)	Recupere uma confirmação específica.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	Encontre a confirmação comum mais próxima (a base de mesclagem) entre as confirmações de base e de destino e obtenha a diferença entre as confirmações de base e de destino ou as 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)	Recupere repositórios git excluídos.
getEnablementStatus(string[], Date, number, number)	Status de ativação GET para repositórios do projeto.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Obtenha committers 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 empurradores faturáveis estimados para um projeto nos últimos 90 dias.
getFileDiffs(FileDiffsCriteria, string, string)	Obter as comparações 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 os detalhes de uma operação de sincronização de fork específica.
getForkSyncRequests(string, string, boolean, boolean)	Recupere todas as operações de sincronização de fork solicitadas neste repositório.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter Metadados e/ou Conteúdo do Item para um único item. O parâmetro de download é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a conteúdo compactado, que é sempre retornado como um download.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter Metadados e/ou Conteúdo do Item para um único item. O parâmetro de download é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a 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 é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a conteúdo compactado que é sempre retornado como um download.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter Metadados e/ou Conteúdo do Item para um único item. O parâmetro de download é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a conteúdo compactado, que é sempre retornado como um download.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter Metadados e/ou Conteúdo do Item para um único item. O parâmetro de download é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a 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 e/ou Conteúdo do Item para um único item. O parâmetro de download é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a conteúdo compactado, que é sempre retornado como um download.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter Metadados e/ou Conteúdo do Item para um único item. O parâmetro de download é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a 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 é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a conteúdo compactado que é sempre retornado como um download.
getItemsBatch(GitItemRequestData, string, string)	Post para recuperar a criação de um lote de um conjunto de itens em um repo / projeto dado uma lista de caminhos ou um caminho longo
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter Metadados e/ou Conteúdo do Item para um único item. O parâmetro de download é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a conteúdo compactado, que é sempre retornado como um download.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obter Metadados e/ou Conteúdo do Item para um único item. O parâmetro de download é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a conteúdo compactado, que é sempre retornado como um download.
getLikes(string, number, number, number, string)	Receba curtidas para um comentário.
getMergeBases(string, string, string, string, string, string)	Encontre 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 dentro do contexto do repositoryNameOrId local.
getMergeRequest(string, string, number, boolean)	Obtenha os detalhes de uma operação de mesclagem específica.
getPermission(string, string, string)	GET status de Permissão de Segurança Avançada.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Recupere uma solicitação pull.
getPullRequestById(number, string)	Recupere uma solicitação pull.
getPullRequestCommits(string, number, string)	Obtenha as confirmações para a solicitação pull especificada.
getPullRequestConflict(string, number, number, string)	Recuperar um conflito para uma solicitação pull por ID
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Recuperar todos os conflitos para uma solicitação pull
getPullRequestIteration(string, number, number, string)	Obtenha a iteração especificada para uma solicitação pull.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Recupere as alterações feitas em uma solicitação 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 pull.
getPullRequestIterations(string, number, string, boolean)	Obtenha a lista de iterações para a solicitação pull especificada.
getPullRequestIterationStatus(string, number, number, number, string)	Obtenha o status específico da iteração da solicitação pull por ID. O ID de status é exclusivo dentro da solicitação pull em todas as iterações.
getPullRequestIterationStatuses(string, number, number, string)	Obtenha todos os status associados a uma iteração de solicitação pull.
getPullRequestLabel(string, number, string, string, string)	Recupera um único rótulo (tag) que foi atribuído a uma solicitação pull.
getPullRequestLabels(string, number, string, string)	Obtenha todos os rótulos (tags) atribuídos a uma solicitação pull.
getPullRequestProperties(string, number, string)	Obtenha propriedades externas da solicitação pull.
getPullRequestQuery(GitPullRequestQuery, string, string)	Essa API é usada para encontrar quais solicitações pull estão relacionadas a uma determinada confirmação. Ele pode ser usado para localizar a solicitação pull que criou uma confirmação de mesclagem específica ou pode ser usado para localizar todas as solicitações pull que já mesclaram uma confirmação específica. A entrada é uma lista de consultas que contêm cada uma uma lista de confirmações. Para cada confirmação que você pesquisar, você receberá de volta um dicionário de solicitações commit -> pull.
getPullRequestReviewer(string, number, string, string)	Recuperar informações sobre um revisor específico em uma solicitação pull
getPullRequestReviewers(string, number, string)	Recuperar os revisores para uma solicitação pull
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	Recupere todas as solicitações pull que correspondam a um critério especificado.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	Recupere todas as solicitações pull que correspondam a um critério especificado.
getPullRequestStatus(string, number, number, string)	Obtenha o status específico da solicitação pull por ID. O ID de status é exclusivo dentro da solicitação pull em todas as iterações.
getPullRequestStatuses(string, number, string)	Obtenha todos os status associados a uma solicitação pull.
getPullRequestThread(string, number, number, string, number, number)	Recupere um thread em uma solicitação pull.
getPullRequestWorkItemRefs(string, number, string)	Recupere uma lista de itens de trabalho associados a uma solicitação 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 as refs favoritas para um Id favorito.
getRefFavorites(string, string, string)	Obtém as refs favoritas para um repo e uma identidade.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	Consulta o repositório fornecido para suas refs e as retorna.
getRepositories(string, boolean, boolean, boolean)	Recupere 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 revert Id.
getRevertConflict(string, number, number, string)	Recuperar um conflito para uma reversão por ID
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	Recuperar todos os conflitos para uma reversão
getRevertForRefName(string, string, string)	Recupere informações sobre uma operação de reversão para uma ramificação específica.
getStatuses(string, string, string, number, number, boolean)	Obtenha status associados à confirmação do Git.
getSuggestions(string, string, boolean)	Recupere uma sugestão de solicitação pull para um repositório específico ou projeto de equipe.
getThreads(string, number, string, number, number)	Recupere todos os threads em uma solicitação pull.
getTree(string, string, string, string, boolean, string)	O ponto de extremidade Tree retorna a coleção de objetos abaixo da árvore especificada. As árvores são pastas em um repositório Git.
getTreeZip(string, string, string, string, boolean, string)	O ponto de extremidade Tree retorna a coleção de objetos abaixo da árvore especificada. As árvores são pastas em um repositório Git.
queryImportRequests(string, string, boolean)	Recuperar solicitações de importação para um repositório.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Recupere um repositório Git excluído por software. Os repositórios excluídos recentemente entram em um estado de exclusão suave por um período de tempo 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 e-mail sobre uma solicitação pull específica para um conjunto de destinatários
updateCherryPickConflict(GitConflict, string, number, number, string)	Atualizar 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 pull.
updateEnablementStatus(AdvSecEnablementUpdate[])	Status de ativaçã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 um pull request
updatePullRequestConflict(GitConflict, string, number, number, string)	Atualizar 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)	Atualize a coleção de status de iteração de solicitação pull. O único tipo de operação suportado é `remove`.
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Crie ou atualize as propriedades externas da solicitação 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 deve 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. Estes campos podem ser corrigidos: isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Redefina os votos de vários revisores em uma solicitação pull. NOTA: Este ponto de extremidade suporta apenas a atualização de votos, mas não suporta a atualização dos revisores necessários (política de utilização) ou nomes de visualização.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	Atualize a coleta de status da solicitação pull. O único tipo de operação suportado é `remove`.
updateRef(GitRefUpdate, string, string, string, string)	Bloquear ou desbloquear uma ramificação.
updateRefs(GitRefUpdate[], string, string, string)	Criar, atualizar ou excluir refs(branches).
updateRepository(GitRepository, string, string)	Atualiza o repositório Git com um novo nome de repositório ou uma nova ramificação padrão.
updateRevertConflict(GitConflict, string, number, number, string)	Atualizar 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 pull.

Detalhes do Construtor

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

Parâmetros

options: IVssRestClientOptions

Detalhes de Propriedade

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de Propriedade

string

Detalhes de Método

createAnnotatedTag(GitAnnotatedTag, string, string)

Crie uma tag anotada.

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

Parâmetros

tagObject: GitAnnotatedTag

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

project: string

ID do projeto ou nome do projeto

repositoryId: string

ID ou nome do repositório.

Devoluções

Promise<GitAnnotatedTag>

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

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

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

Parâmetros

content: any

Conteúdo para carregar

fileName: string

O nome do arquivo.

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

Escolha a dedo uma confirmação ou confirmações específicas associadas a uma solicitação pull em uma nova ramificação.

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.

Devoluções

Promise<GitCherryPick>

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

Crie um comentário em um thread específico em uma solicitação 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

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

pullRequestId: number

ID do pull request.

threadId: number

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

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Crie o status de confirmação do Git.

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

Parâmetros

gitCommitStatusToCreate: GitStatus

Git commit objeto de status para criar.

commitId: string

ID da confirmação do Git.

repositoryId: string

ID do repositório.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

Cria um favorito ref

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

Parâmetros

favorite: GitRefFavorite

O ref favorito para criar.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Solicite que as refs de outro repositório sejam buscadas neste. Ele sincroniza duas bifurcações existentes. Para criar uma bifurcação, consulte a <a href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> pontos finais 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 ID do repositório.

project: string

ID do projeto ou nome do projeto

includeLinks: boolean

True para incluir links

Devoluções

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 ID do repositório.

Devoluções

Promise<GitImportRequest>

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

Adicione um gosto a um comentário.

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

threadId: number

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

commentId: number

O ID do comentário.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Solicite uma operação de mesclagem git. Atualmente apoiamos a fusão de apenas 2 commits.

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

Parâmetros

mergeParameters: GitMergeParameters

Os pais commitIds e merge commit messsage.

project: string

ID do projeto ou nome do projeto

repositoryNameOrId: string

O nome ou ID do repositório.

includeLinks: boolean

True para incluir links

Devoluções

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

Crie uma solicitação pull.

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

Parâmetros

gitPullRequestToCreate: GitPullRequest

A solicitação pull para criar.

repositoryId: string

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

project: string

ID do projeto ou nome do projeto

supportsIterations: boolean

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

Devoluções

Promise<GitPullRequest>

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

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

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

Parâmetros

status: GitPullRequestStatus

Pull status da solicitação para criar.

repositoryId: string

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

pullRequestId: number

ID do pull request.

iterationId: number

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

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitPullRequestStatus>

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

Crie uma tag (se ela ainda não existir) e adicione-a como um label (tag) para uma solicitação pull especificada. O único campo obrigatório é o nome da nova etiqueta (etiqueta).

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

Parâmetros

label: WebApiCreateTagRequestData

Rótulo para atribuir à solicitação pull.

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

projectId: string

ID do projeto ou nome do projeto.

Devoluções

Promise<WebApiTagDefinition>

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

Adicione um revisor a um pull request ou vote nele.

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

Parâmetros

reviewer: IdentityRefWithVote

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

repositoryId: string

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

pullRequestId: number

ID do pull request.

reviewerId: string

ID do revisor.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<IdentityRefWithVote>

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

Adicione revisores a uma solicitação pull.

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

Parâmetros

reviewers: IdentityRef[]

Revisores para adicionar à solicitação pull.

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Crie um status de solicitação pull.

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

Parâmetros

status: GitPullRequestStatus

Pull status da solicitação para criar.

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

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 ID do repositório.

project: string

ID do projeto ou nome do projeto

Devoluções

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 o escopo do projeto (ou seja, incluir a ID do projeto).

project: string

ID do projeto ou nome do projeto

sourceRef: string

[opcional] Especificar a origem que se recusa a usar ao criar um repositório de fork

Devoluções

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

Inicia a operação para criar uma nova ramificação que reverte as alterações introduzidas por uma confirmação específica ou confirmações associadas a uma solicitação 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.

Devoluções

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

Crie um thread em uma solicitação pull.

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

Parâmetros

commentThread: GitPullRequestCommentThread

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

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

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

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

Parâmetros

reviewer: IdentityRefWithVote

Revisor para adicionar à solicitação pull.

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Exclua um anexo de solicitação 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

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

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

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

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

Devoluções

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE Exclui o status de ativação e os dados de BillableCommitters do banco de dados. A exclusão dos dados de ativação os desativará efetivamente para os repositórios afetados.

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

Parâmetros

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

Devoluções

Promise<void>

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

Excluir uma curtida em um comentário.

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

threadId: number

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

commentId: number

O ID do comentário.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

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

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

iterationId: number

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

statusId: number

ID do status da solicitação pull.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

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

Remove um rótulo (tag) do conjunto daqueles atribuídos à solicitação pull. A tag 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

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

pullRequestId: number

ID do pull request.

labelIdOrName: string

O nome ou ID do rótulo solicitado.

project: string

ID do projeto ou nome do projeto

projectId: string

ID do projeto ou nome do projeto.

Devoluções

Promise<void>

deletePullRequestReviewer(string, number, string, string)

Remova um revisor de uma solicitação pull.

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

reviewerId: string

ID do revisor a ser removido.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

deletePullRequestStatus(string, number, number, string)

Exclua o status da solicitação pull.

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

statusId: number

ID do status da solicitação pull.

project: string

ID do projeto ou nome do projeto

Devoluções

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

O Id do favorito ref para excluir.

Devoluções

Promise<void>

deleteRepository(string, string)

Excluir um repositório git

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

Parâmetros

repositoryId: string

O ID do repositório.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

Destrua (exclusão forçada) um repositório Git excluído suavemente.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

repositoryId: string

O ID do repositório.

Devoluções

Promise<void>

getAnnotatedTag(string, string, string)

Obtenha uma tag 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 tag a obter.

Devoluções

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

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

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

Parâmetros

fileName: string

O nome do anexo.

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<ArrayBuffer>

getAttachments(string, number, string)

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

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

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

Parâmetros

fileName: string

O nome do anexo.

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

Recupere 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 será o dia de faturamento anterior.

skip: number

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

take: number

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

Devoluções

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

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

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

Parâmetros

project: string

ID do projeto ou nome do projeto

includeDetails: string

Devolva todos os detalhes sobre os committers faturáveis.

billingDate: Date

UTC esperado. Se não for especificado, o padrão será o dia de faturamento anterior.

Devoluções

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 ID do repositório.

sha1: string

SHA1 hash 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 verdadeiro, solicite um download em vez de renderizar em um navegador. Nota: este valor assume como padrão true se $format for zip

fileName: string

Forneça um fileName para usar em um download.

resolveLfs: boolean

Se verdadeiro, tente resolver um blob para seu conteúdo LFS, se for um arquivo de ponteiro LFS. Compatível apenas com octeto-stream Aceitar cabeçalhos ou tipos de $format

Devoluções

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 ID do repositório.

sha1: string

SHA1 hash 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 verdadeiro, solicite um download em vez de renderizar em um navegador. Nota: este valor assume como padrão true se $format for zip

fileName: string

Forneça um fileName para usar em um download.

resolveLfs: boolean

Se verdadeiro, tente resolver um blob para seu conteúdo LFS, se for um arquivo de ponteiro LFS. Compatível apenas com octeto-stream Aceitar cabeçalhos ou tipos de $format

Devoluções

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 retornados no arquivo zip.

repositoryId: string

O nome ou ID do repositório.

project: string

ID do projeto ou nome do projeto

filename: string

Devoluções

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 ID do repositório.

sha1: string

SHA1 hash 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 verdadeiro, solicite um download em vez de renderizar em um navegador. Nota: este valor assume como padrão true se $format for zip

fileName: string

Forneça um fileName para usar em um download.

resolveLfs: boolean

Se verdadeiro, tente resolver um blob para seu conteúdo LFS, se for um arquivo de ponteiro LFS. Compatível apenas com octeto-stream Aceitar cabeçalhos ou tipos de $format

Devoluções

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Recupere estatísticas sobre uma única ramificação.

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

Parâmetros

repositoryId: string

O nome ou ID do repositório.

name: string

Nome da sucursal.

project: string

ID do projeto ou nome do projeto

baseVersionDescriptor: GitVersionDescriptor

Identifica a confirmação ou ramificação a ser usada como base.

Devoluções

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

Recupere estatísticas sobre todas as ramificações em um repositório.

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

Parâmetros

repositoryId: string

O nome ou ID do repositório.

project: string

ID do projeto ou nome do projeto

baseVersionDescriptor: GitVersionDescriptor

Identifica a confirmação ou ramificação a ser usada como base.

Devoluções

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

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

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

Parâmetros

searchCriteria: GitQueryBranchStatsCriteria

Base Commit e List of Target Commits para comparar.

repositoryId: string

O nome ou ID do repositório.

project: string

ID do projeto ou nome do projeto

Devoluções

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

O id da confirmação.

repositoryId: string

O id ou 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.

Devoluções

Promise<GitCommitChanges>

getCherryPick(string, number, string)

Recupere informações sobre uma operação cherry pick pelo Id cherry pick.

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 a dedo.

repositoryId: string

ID do repositório.

Devoluções

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Recuperar um conflito para uma escolha seletiva 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

Devoluções

Promise<GitConflict>

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

Recupere todos os conflitos para uma escolha seletiva

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

Devoluções

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

Recupere informações sobre uma operação de escolha seletiva para uma ramificação específica. Esta operação é dispendiosa devido à estrutura subjacente do objeto, pelo que esta API analisa apenas as 1000 operações de cherry pick 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 cherry pick.

Devoluções

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

Dado um commitId, retorna uma lista de commits que estão na mesma família 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

Devoluções

Promise<GitCommitRef[]>

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

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

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

Devoluções

Promise<Comment>

getComments(string, number, number, string)

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

threadId: number

ID do thread.

project: string

ID do projeto ou nome do projeto

Devoluções

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

O id da confirmação.

repositoryId: string

O id ou 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 incluir no resultado.

Devoluções

Promise<GitCommit>

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

Encontre a confirmação comum mais próxima (a base de mesclagem) entre as confirmações de base e de destino e obtenha a diferença entre as confirmações de base e de destino ou as 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 ID do repositório.

project: string

ID do projeto ou nome do projeto

diffCommonCommit: boolean

Se verdadeiro, difiram entre confirmações comuns e de destino. Se false, diferencie entre confirmações de base e de destino.

top: number

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

skip: number

Número de alterações a ignorar

baseVersionDescriptor: GitBaseVersionDescriptor

Descritor para confirmação de base.

targetVersionDescriptor: GitTargetVersionDescriptor

Descritor para confirmação de destino.

Devoluções

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

O id ou 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

Devoluções

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 ID do repositório.

project: string

ID do projeto ou nome do projeto

skip: number

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

top: number

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

includeStatuses: boolean

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

Devoluções

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Recupere repositórios git excluídos.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitDeletedRepository[]>

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

Status de ativaçã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 de status de repositórios do projeto a retornar

billingDate: Date

UTC esperado, Null padrão para UtcNow(), pode ser fornecido para um status point-in-time

skip: number

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

take: number

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

Devoluções

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

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

Parâmetros

enableOnCreateHost: boolean

Devoluções

Promise<boolean>

getEnableOnCreateProject(string)

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

Parâmetros

enableOnCreateProjectId: string

Devoluções

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

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

Devoluções

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

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

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Devoluções

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

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

Devoluções

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

Obter as comparações 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 ID do repositório

Devoluções

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 ID do repositório.

collectionId: string

ID da coleção do projeto de equipe.

project: string

ID do projeto ou nome do projeto

includeLinks: boolean

True para incluir links.

Devoluções

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

Obtenha os detalhes de uma operação de sincronização de fork específica.

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

Parâmetros

repositoryNameOrId: string

O nome ou 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.

Devoluções

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

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

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

Parâmetros

repositoryNameOrId: string

O nome ou 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.

Devoluções

Promise<GitForkSyncRequest[]>

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

Obter Metadados e/ou Conteúdo do Item para um único item. O parâmetro de download é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a 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 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 é null.

recursionLevel: VersionControlRecursionType

O nível de recursão desta solicitação. O padrão é 'nenhum', 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 é a ramificação 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 Git HFS para retornar conteúdo real do Git HFS. O padrão é true.

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.

Devoluções

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 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 é null.

recursionLevel: VersionControlRecursionType

O nível de recursão desta solicitação. O padrão é 'nenhum', 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 é a ramificação 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 Git HFS para retornar conteúdo real do Git HFS. O padrão é true.

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.

Devoluções

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 é para indicar se o conteúdo deve estar disponível como um download ou apenas enviado como um fluxo na resposta. Não se aplica a 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 ID do repositório.

project: string

ID do projeto ou nome do projeto

scopePath: string

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

recursionLevel: VersionControlRecursionType

O nível de recursão desta solicitação. O padrão é 'nenhum', 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 é a ramificação 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 links simbólicos

Devoluções

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 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 é null.

recursionLevel: VersionControlRecursionType

O nível de recursão desta solicitação. O padrão é 'nenhum', 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 é a ramificação 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 Git HFS para retornar conteúdo real do Git HFS. O padrão é true.

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.

Devoluções

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 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 é null.

recursionLevel: VersionControlRecursionType

O nível de recursão desta solicitação. O padrão é 'nenhum', 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 é a ramificação 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 Git HFS para retornar conteúdo real do Git HFS. O padrão é true.

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.

Devoluções

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 ID do repositório.

importRequestId: number

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

Devoluções

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 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 é null.

recursionLevel: VersionControlRecursionType

O nível de recursão desta solicitação. O padrão é 'nenhum', 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 é a ramificação 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 do 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.

Devoluções

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 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 é null.

recursionLevel: VersionControlRecursionType

O nível de recursão desta solicitação. O padrão é 'nenhum', 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 é a ramificação 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 do 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.

Devoluções

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 ID do repositório.

project: string

ID do projeto ou nome do projeto

scopePath: string

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

recursionLevel: VersionControlRecursionType

O nível de recursão desta solicitação. O padrão é 'nenhum', 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 é a ramificação 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 links simbólicos

Devoluções

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Post para recuperar a criação de um lote de um conjunto de itens em um repo / projeto dado uma lista de caminhos ou um caminho longo

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

Parâmetros

requestData: GitItemRequestData

Atributos de dados de solicitação: 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 que alterou pela última vez cada item. IncludeLinks: Se o campo _links deve ser incluído nas referências superficiais.

repositoryId: string

O nome ou ID do repositório

project: string

ID do projeto ou nome do projeto

Devoluções

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 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 é null.

recursionLevel: VersionControlRecursionType

O nível de recursão desta solicitação. O padrão é 'nenhum', 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 é a ramificação 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 do 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.

Devoluções

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 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 é null.

recursionLevel: VersionControlRecursionType

O nível de recursão desta solicitação. O padrão é 'nenhum', 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 é a ramificação 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 do 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.

Devoluções

Promise<ArrayBuffer>

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

Receba curtidas para um comentário.

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

threadId: number

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

commentId: number

O ID do comentário.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<IdentityRef[]>

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

Encontre 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 dentro do contexto do repositoryNameOrId local.

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

Primeiro confirmar, geralmente a ponta da ramificação de destino da possível mesclagem.

otherCommitId: string

Outra confirmação, geralmente a ponta da ramificação de origem da possível fusão.

project: string

ID do projeto ou nome do projeto

otherCollectionId: string

O ID da coleção onde outro CommitId vive.

otherRepositoryId: string

O ID do repositório onde outro CommitId vive.

Devoluções

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

Obtenha os 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 ID do repositório.

mergeOperationId: number

OperationId da solicitação de mesclagem.

includeLinks: boolean

True para incluir links

Devoluções

Promise<GitMerge>

getPermission(string, string, string)

GET status de Permissão de Segurança Avançada.

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 solicitada deve ser "viewAlert", "dismissAlert", "manage", "viewEnablement" ou "repoRead"

Devoluções

Promise<boolean>

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

Recupere uma solicitação 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

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

pullRequestId: number

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

project: string

ID do projeto ou nome do projeto

maxCommentLength: number

Não utilizado.

skip: number

Não utilizado.

top: number

Não utilizado.

includeCommits: boolean

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

includeWorkItemRefs: boolean

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

Devoluções

Promise<GitPullRequest>

getPullRequestById(number, string)

Recupere uma solicitação pull.

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

Parâmetros

pullRequestId: number

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

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

Obtenha as confirmações para a solicitação 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 do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Recuperar um conflito para uma solicitação 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

Devoluções

Promise<GitConflict>

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

Recuperar todos os conflitos para uma solicitação 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 do Pull Request.

pullRequestId: number

O ID da solicitação pull.

project: string

ID do projeto ou nome do projeto

skip: number

Conflitos a ignorar.

top: number

Conflitos para retornar após pular.

includeObsolete: boolean

Inclui conflitos obsoletos.

excludeResolved: boolean

Exclui conflitos já resolvidos.

onlyResolved: boolean

Retorna apenas os conflitos que foram resolvidos.

Devoluções

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

Obtenha a iteração especificada para uma solicitação 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 do pull request.

iterationId: number

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

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitPullRequestIteration>

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

Recupere as alterações feitas em uma solicitação 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

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

pullRequestId: number

ID do pull request.

iterationId: number

ID da iteração de solicitação pull. <iteração br /> um é o chefe da ramificação de origem no momento em que a solicitação pull é criada e iterações subsequentes são criadas quando há pushes para a ramificação de origem. Os valores permitidos estão entre 1 e a iteração máxima nessa solicitação 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 o top 50 e pule para 100.

compareTo: number

ID da iteração de solicitação pull para comparação. O valor padrão é zero, o que indica que a comparação é feita em relação à confirmação comum entre as ramificações de origem e de destino

Devoluções

Promise<GitPullRequestIterationChanges>

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

Obtenha as confirmações para a iteração especificada de uma solicitação 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 do pull request.

iterationId: number

ID da iteração a partir 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 devolver. O número máximo de confirmações que podem ser retornadas por lote é 500.

skip: number

Número de confirmações a ignorar.

Devoluções

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

Obtenha a lista de iterações para a solicitação 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 do pull request.

project: string

ID do projeto ou nome do projeto

includeCommits: boolean

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

Devoluções

Promise<GitPullRequestIteration[]>

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

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

iterationId: number

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

statusId: number

ID do status da solicitação pull.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

iterationId: number

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

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitPullRequestStatus[]>

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

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

labelIdOrName: string

O nome ou ID do rótulo solicitado.

project: string

ID do projeto ou nome do projeto

projectId: string

ID do projeto ou nome do projeto.

Devoluções

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

projectId: string

ID do projeto ou nome do projeto.

Devoluções

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

Obtenha propriedades externas da solicitação pull.

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

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

Devoluções

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

reviewerId: string

ID do revisor.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

Recuperar os revisores para uma solicitação pull

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<IdentityRefWithVote[]>

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

Recupere todas as solicitações 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

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

searchCriteria: GitPullRequestSearchCriteria

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

project: string

ID do projeto ou nome do projeto

maxCommentLength: number

Não utilizado.

skip: number

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

top: number

O número de solicitações pull para recuperar.

Devoluções

Promise<GitPullRequest[]>

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

Recupere todas as solicitações 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 pull que correspondam a esses critérios de pesquisa.

maxCommentLength: number

Não utilizado.

skip: number

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

top: number

O número de solicitações pull para recuperar.

Devoluções

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

statusId: number

ID do status da solicitação pull.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitPullRequestStatus[]>

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

Recupere um thread em uma solicitação pull.

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

threadId: number

ID do thread.

project: string

ID do projeto ou nome do projeto

iteration: number

Se especificado, a posição do thread será rastreada usando essa iteração como o lado direito do diff.

baseIteration: number

Se especificado, a posição do thread será rastreada usando essa iteração como o lado esquerdo do diff.

Devoluções

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

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

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

Parâmetros

repositoryId: string

ID ou nome do repositório.

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

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 ID do repositório.

pushId: number

ID do push.

project: string

ID do projeto ou nome do projeto

includeCommits: number

O número de compromissos a incluir no resultado.

includeRefUpdates: boolean

Se verdadeiro, inclua a lista de refs que foram atualizadas pelo push.

Devoluções

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

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

pushId: number

O id do empurrão.

project: string

ID do projeto ou nome do projeto

top: number

O número máximo de confirmações a devolver ("obter o topo x confirmações").

skip: number

O número de confirmações a ignorar.

includeLinks: boolean

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

Devoluções

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 ID do repositório.

project: string

ID do projeto ou nome do projeto

skip: number

Número de pushes para ignorar.

top: number

Número de empurrões para retornar.

searchCriteria: GitPushSearchCriteria

Atributos de critérios de pesquisa: fromDate, toDate, pusherId, refName, includeRefUpdates ou includeLinks. fromDate: Data de início para pesquisar. toDate: Data de término para pesquisar. pusherId: Identidade da pessoa que enviou o push. refName: Nome da filial a considerar. includeRefUpdates: Se verdadeiro, inclua a lista de refs que foram atualizadas pelo push. includeLinks: Se o campo _links deve ser incluído nas referências superficiais.

Devoluções

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

Devoluções

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Obtém as refs favoritas para um Id favorito.

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

Parâmetros

project: string

ID do projeto ou nome do projeto

favoriteId: number

O Id do favorito ref solicitado.

Devoluções

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Obtém as refs favoritas para um repo 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

O id do repositório.

identityId: string

O id da identidade cujos favoritos devem ser recuperados. Se null, a identidade solicitante é usada.

Devoluções

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

Devoluções

Promise<GitRefFavorite[]>

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

Consulta o repositório fornecido para suas refs e as 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 ID do repositório.

project: string

ID do projeto ou nome do projeto

filter: string

[opcional] Um filtro para aplicar às refs (começa com).

includeLinks: boolean

[opcional] Especifica se referenceLinks deve ser incluído 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 as ramificações que o usuário possui, as ramificações favoritas do usuário e a ramificação padrão. O valor padrão é false. Não pode ser combinado com o parâmetro filter.

latestStatusesOnly: boolean

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

peelTags: boolean

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

filterContains: string

[opcional] Um filtro para aplicar às refs (contém).

Devoluções

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

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

Devoluções

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 para aplicar às refs (contém).

top: number

[opcional] Número máximo de repositórios a devolver. Não pode ser maior que 500. Se não for fornecido, mas continuationToken for, o padrão top será 100.

continuationToken: string

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

Devoluções

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 ID do repositório.

project: string

ID do projeto ou nome do projeto

Devoluções

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

Devoluções

Promise<GitRepository>

getRevert(string, number, string)

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

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.

Devoluções

Promise<GitRevert>

getRevertConflict(string, number, number, string)

Recuperar um conflito para uma reversão 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

Devoluções

Promise<GitConflict>

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

Recuperar todos os conflitos para uma reversão

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

Devoluções

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

Recupere informações sobre uma operação de reversão para uma ramificação específica.

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.

Devoluções

Promise<GitRevert>

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

Obtenha 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 101-150, defina como 50 e pule para 100.

latestOnly: boolean

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

Devoluções

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

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

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 verdadeiro, prefira a ramificação de comparação sobre a ramificação padrão como ramificação de destino para solicitações pull.

Devoluções

Promise<GitSuggestion[]>

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

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

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

Parâmetros

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

iteration: number

Se especificado, as posições do thread serão rastreadas usando essa iteração como o lado direito do diff.

baseIteration: number

Se especificado, as posições do thread serão rastreadas usando essa iteração como o lado esquerdo do diff.

Devoluções

Promise<GitPullRequestCommentThread[]>

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

O ponto de extremidade Tree retorna a coleção de objetos abaixo da árvore especificada. As á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

SHA1 hash do objeto de árvore.

project: string

ID do projeto ou nome do projeto

projectId: string

Id do projeto.

recursive: boolean

Pesquisar recursivamente. Inclua árvores debaixo desta árvore. O padrão é false.

fileName: string

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

Devoluções

Promise<GitTreeRef>

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

O ponto de extremidade Tree retorna a coleção de objetos abaixo da árvore especificada. As á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

SHA1 hash do objeto de árvore.

project: string

ID do projeto ou nome do projeto

projectId: string

Id do projeto.

recursive: boolean

Pesquisar recursivamente. Inclua árvores debaixo desta árvore. O padrão é false.

fileName: string

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

Devoluções

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

Recuperar 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 ID do repositório.

includeAbandoned: boolean

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

Devoluções

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

Recupere um repositório Git excluído por software. Os repositórios excluídos recentemente entram em um estado de exclusão suave por um período de tempo 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

O ID do repositório.

Devoluções

Promise<GitRepository>

setEnableOnCreateHost(boolean)

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

Parâmetros

enableOnCreateHost: boolean

Devoluções

Promise<void>

setEnableOnCreateProject(string, boolean)

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

Parâmetros

enableOnCreateProjectId: string

enableOnStatus: boolean

Devoluções

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

Envia uma notificação por e-mail sobre uma solicitação 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 do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

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

Atualizar 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

Devoluções

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

Devoluções

Promise<GitConflictUpdateResult[]>

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

Atualize um comentário associado a um thread específico em uma solicitação 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

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

pullRequestId: number

ID do pull request.

threadId: number

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

commentId: number

ID do comentário a atualizar.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

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

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

Parâmetros

enablementUpdates: AdvSecEnablementUpdate[]

Devoluções

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 ID do repositório.

importRequestId: number

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

Devoluções

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

Atualizar um pull request

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

Parâmetros

gitPullRequestToUpdate: GitPullRequest

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

repositoryId: string

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

pullRequestId: number

ID da solicitação pull para atualização.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitPullRequest>

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

Atualizar 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

Devoluções

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

Devoluções

Promise<GitConflictUpdateResult[]>

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

Atualize a coleção de status de iteração de solicitação pull. O único tipo de operação suportado é remove.

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

Parâmetros

patchDocument: JsonPatchDocument

Operações para aplicar aos status da solicitação pull no formato de patch JSON.

repositoryId: string

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

pullRequestId: number

ID do pull request.

iterationId: number

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

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

Crie ou atualize as propriedades externas da solicitação 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 deve 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 para adicionar, substituir ou remover no formato de patch JSON.

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<any>

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

Editar uma entrada de revisor. Estes 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 o ID do revisor estiver incluído aqui, ele deverá corresponder ao parâmetro reviewerID.

repositoryId: string

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

pullRequestId: number

ID do pull request.

reviewerId: string

ID do revisor.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<IdentityRefWithVote>

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

Redefina os votos de vários revisores em uma solicitação pull. NOTA: Este ponto de extremidade suporta apenas a atualização de votos, mas não suporta a atualização dos revisores necessários (política de utilização) ou nomes de visualizaçã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

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

pullRequestId: number

ID do pull request

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

Atualize a coleta de status da solicitação pull. O único tipo de operação suportado é remove.

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

Parâmetros

patchDocument: JsonPatchDocument

Operações para aplicar aos status da solicitação pull no formato de patch JSON.

repositoryId: string

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

pullRequestId: number

ID do pull request.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<void>

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

Bloquear ou desbloquear uma ramificação.

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 (bloquear/desbloquear) a ser executada

repositoryId: string

O nome ou ID do repositório.

filter: string

O nome da ramificação a bloquear/desbloquear

project: string

ID do projeto ou nome do projeto

projectId: string

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

Devoluções

Promise<GitRef>

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

Criar, atualizar ou excluir 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 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 um ID para o repositório.

Devoluções

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Atualiza o repositório Git com um novo nome de repositório ou uma nova ramificação padrão.

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

Parâmetros

newRepositoryInfo: GitRepository

Especificar um novo nome de repositório ou uma nova ramificação padrão do repositório

repositoryId: string

O ID do repositório.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitRepository>

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

Atualizar 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

Devoluções

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

Devoluções

Promise<GitConflictUpdateResult[]>

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

Atualize um thread em uma solicitação 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

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

pullRequestId: number

ID do pull request.

threadId: number

ID do thread a ser atualizado.

project: string

ID do projeto ou nome do projeto

Devoluções

Promise<GitPullRequestCommentThread>

Partilhar via

GitRestClient class

Construtores

Propriedades

Métodos

Detalhes do Construtor

GitRestClient(IVssRestClientOptions)

Parâmetros

Detalhes de Propriedade

RESOURCE_AREA_ID

Valor de Propriedade

Detalhes de Método

createAnnotatedTag(GitAnnotatedTag, string, string)

Parâmetros

Devoluções

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

Parâmetros

Devoluções

createCherryPick(GitAsyncRefOperationParameters, string, string)

Parâmetros

Devoluções

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

Parâmetros

Devoluções

createCommitStatus(GitStatus, string, string, string)

Parâmetros

Devoluções

createFavorite(GitRefFavorite, string)

Parâmetros

Devoluções

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Parâmetros

Devoluções

createImportRequest(GitImportRequest, string, string)

Parâmetros

Devoluções

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

Parâmetros

Devoluções

createMergeRequest(GitMergeParameters, string, string, boolean)

Parâmetros

Devoluções

createPullRequest(GitPullRequest, string, string, boolean)

Parâmetros

Devoluções

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Parâmetros

Devoluções

createPush(GitPush, string, string)

Parâmetros

Devoluções

createRepository(GitRepositoryCreateOptions, string, string)

Parâmetros

Devoluções

createRevert(GitAsyncRefOperationParameters, string, string)

Parâmetros

Devoluções

createThread(GitPullRequestCommentThread, string, number, string)

Parâmetros

Devoluções

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Parâmetros

Devoluções

deleteAttachment(string, string, number, string)

Parâmetros

Devoluções

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

Parâmetros