GitRestClient class

Referencia

Paquete:: azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends: RestClientBase

Constructores

GitRestClient(IVssRestClientOptions)

Propiedades

RESOURCE_AREA_ID

Métodos

createAnnotatedTag(GitAnnotatedTag, string, string)	Cree una etiqueta anotada.
createAttachment(any, string, string, number, string)	Adjunte un nuevo archivo a una solicitud de incorporación de cambios.
createCherryPick(GitAsyncRefOperationParameters, string, string)	Cherry elige una confirmación o confirmaciones específicas asociadas a una solicitud de incorporación de cambios en una nueva rama.
createComment(Comment, string, number, number, string)	Cree un comentario en un subproceso específico en una solicitud de incorporación de cambios (se pueden crear hasta 500 comentarios por subproceso).
createCommitStatus(GitStatus, string, string, string)	Cree el estado de confirmación de Git.
createFavorite(GitRefFavorite, string)	Crea un favorito de referencia
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Solicite que las referencias de otro repositorio se capturen en esta. Sincroniza dos bifurcaciones existentes. Para crear una bifurcación, consulte el <un href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> repositorios de punto de conexión</a>
createImportRequest(GitImportRequest, string, string)	Cree una solicitud de importación.
createLike(string, number, number, number, string)	Agregue un like en un comentario.
createMergeRequest(GitMergeParameters, string, string, boolean)	Solicite una operación de combinación de Git. Actualmente solo se admite la combinación de 2 confirmaciones.
createPullRequest(GitPullRequest, string, string, boolean)	Cree una solicitud de incorporación de cambios.
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Cree un estado de solicitud de incorporación de cambios en la iteración. Esta operación tendrá el mismo resultado que Crear estado en la solicitud de incorporación de cambios con el identificador de iteración especificado en el cuerpo de la solicitud.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Cree una etiqueta (si aún no existe) y agréguela como etiqueta (etiqueta) para una solicitud de incorporación de cambios especificada. El único campo obligatorio es el nombre de la nueva etiqueta (etiqueta).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Agregue un revisor a una solicitud de incorporación de cambios o emita un voto.
createPullRequestReviewers(IdentityRef[], string, number, string)	Agregue revisores a una solicitud de incorporación de cambios.
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Cree un estado de solicitud de incorporación de cambios.
createPush(GitPush, string, string)	Inserte los cambios en el repositorio.
createRepository(GitRepositoryCreateOptions, string, string)	Cree un repositorio git en un proyecto de equipo.
createRevert(GitAsyncRefOperationParameters, string, string)	Inicia la operación para crear una nueva rama que revierta los cambios introducidos por una confirmación específica o confirmaciones asociadas a una solicitud de incorporación de cambios.
createThread(GitPullRequestCommentThread, string, number, string)	Cree un subproceso en una solicitud de incorporación de cambios.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Agregue una identidad no materializada a los revisores de una solicitud de incorporación de cambios.
deleteAttachment(string, string, number, string)	Elimine los datos adjuntos de una solicitud de incorporación de cambios.
deleteComment(string, number, number, number, string)	Elimine un comentario asociado a un subproceso específico en una solicitud de incorporación de cambios.
deleteEnablementStatus(boolean, boolean, string[])	DELETE Elimina el estado de habilitación y los datos billableCommitters de la base de datos. Al eliminar los datos de habilitación, se deshabilitará eficazmente para los repositorios afectados.
deleteLike(string, number, number, number, string)	Elimine un como en un comentario.
deletePullRequestIterationStatus(string, number, number, number, string)	Elimine el estado de iteración de la solicitud de incorporación de cambios.
deletePullRequestLabels(string, number, string, string, string)	Quita una etiqueta (etiqueta) del conjunto de los asignados a la solicitud de incorporación de cambios. La propia etiqueta no se eliminará.
deletePullRequestReviewer(string, number, string, string)	Quite un revisor de una solicitud de incorporación de cambios.
deletePullRequestStatus(string, number, number, string)	Elimine el estado de la solicitud de incorporación de cambios.
deleteRefFavorite(string, number)	Elimina el favorito de referencias especificado.
deleteRepository(string, string)	Eliminación de un repositorio de Git
deleteRepositoryFromRecycleBin(string, string)	Destruir (eliminar de forma temporal) un repositorio git eliminado temporalmente.
getAnnotatedTag(string, string, string)	Obtiene una etiqueta anotada.
getAttachmentContent(string, string, number, string)	Obtenga el contenido del archivo de los datos adjuntos de una solicitud de incorporación de cambios.
getAttachments(string, number, string)	Obtenga una lista de archivos adjuntos a una solicitud de incorporación de cambios determinada.
getAttachmentZip(string, string, number, string)	Obtenga el contenido del archivo de los datos adjuntos de una solicitud de incorporación de cambios.
getBillableCommitters(string, Date, number, number)	Recupere confirmadores facturables reales para el servicio advanced Security para una fecha determinada.
getBillableCommittersDetail(string, string, Date)	Recupere confirmadores facturables reales detallados para el servicio advanced Security para una fecha determinada. Los resultados detallados no filtran intencionadamente los proyectos y repositorios eliminados temporalmente para ayudar a diagnosticar problemas de facturación.
getBlob(string, string, string, boolean, string, boolean)	Obtenga un único blob.
getBlobContent(string, string, string, boolean, string, boolean)	Obtenga un único blob.
getBlobsZip(string[], string, string, string)	Obtiene uno o varios blobs en una descarga de archivos ZIP.
getBlobZip(string, string, string, boolean, string, boolean)	Obtenga un único blob.
getBranch(string, string, string, GitVersionDescriptor)	Recuperar estadísticas sobre una sola rama.
getBranches(string, string, GitVersionDescriptor)	Recupere estadísticas sobre todas las ramas de un repositorio.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Recuperación de estadísticas para varias confirmaciones
getChanges(string, string, string, number, number)	Recupere los cambios de una confirmación determinada.
getCherryPick(string, number, string)	Recupere información sobre una operación de selección de cerezas por identificador de selección de cereza.
getCherryPickConflict(string, number, number, string)	Recuperar un conflicto para una selección de cereza por identificador
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Recuperar todos los conflictos de una selección de cereza
getCherryPickForRefName(string, string, string)	Recupere información sobre una operación de selección de cereza para una rama específica. Esta operación es costosa debido a la estructura de objetos subyacente, por lo que esta API solo examina las 1000 operaciones de selección de cereza más recientes.
getCherryPickRelationships(string, string, string, boolean)	Dado un commitId, devuelve una lista de confirmaciones que se encuentran en la misma familia cherry-pick.
getComment(string, number, number, number, string)	Recupere un comentario asociado a un subproceso específico en una solicitud de incorporación de cambios.
getComments(string, number, number, string)	Recupere todos los comentarios asociados a un subproceso específico en una solicitud de incorporación de cambios.
getCommit(string, string, string, number)	Recuperar una confirmación determinada.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	Busque la confirmación común más cercana (la base de combinación) entre las confirmaciones base y de destino, y obtenga la diferencia entre las confirmaciones base y de destino o las confirmaciones comunes y de destino.
getCommits(string, GitQueryCommitsCriteria, string)	Recuperación de confirmaciones de Git para un proyecto
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	Recuperación de confirmaciones de Git para un proyecto que coincida con los criterios de búsqueda
getDeletedRepositories(string)	Recuperar repositorios git eliminados.
getEnablementStatus(string[], Date, number, number)	GET Estado de habilitación para los repositorios del proyecto.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Obtenga confirmadores facturables estimados para un repositorio durante los últimos 90 días.
getEstimatedBillablePushersOrg()	Obtenga los pushers facturables estimados para una organización durante los últimos 90 días.
getEstimatedBillablePushersProject(string)	Obtenga los pushers facturables estimados para un proyecto durante los últimos 90 días.
getFileDiffs(FileDiffsCriteria, string, string)	Obtener las diferencias de archivo para cada uno de los archivos especificados
getForks(string, string, string, boolean)	Recupere todas las bifurcaciones de un repositorio de la colección.
getForkSyncRequest(string, number, string, boolean)	Obtenga los detalles de una operación de sincronización de bifurcación específica.
getForkSyncRequests(string, string, boolean, boolean)	Recupere todas las operaciones de sincronización de bifurcación solicitadas en este repositorio.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido, que siempre se devuelve como descarga.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido, que siempre se devuelve como descarga.
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Obtener metadatos de elemento o contenido para una colección de elementos. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido, que siempre se devuelve como descarga.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido, que siempre se devuelve como descarga.
getImportRequest(string, string, number)	Recupere una solicitud de importación determinada.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido, que siempre se devuelve como descarga.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido, que siempre se devuelve como descarga.
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Obtener metadatos de elemento o contenido para una colección de elementos. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.
getItemsBatch(GitItemRequestData, string, string)	Publicar para recuperar un lote fuera de un conjunto de elementos de un repositorio o proyecto dada una lista de rutas de acceso o una ruta de acceso larga
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido, que siempre se devuelve como descarga.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido, que siempre se devuelve como descarga.
getLikes(string, number, number, number, string)	Obtenga likes para un comentario.
getMergeBases(string, string, string, string, string, string)	Busque las bases de combinación de dos confirmaciones, opcionalmente en bifurcaciones. Si no se especifica otherRepositoryId, las bases de combinación solo se calcularán en el contexto del repositoryNameOrId local.
getMergeRequest(string, string, number, boolean)	Obtenga los detalles de una operación de combinación específica.
getPermission(string, string, string)	Get Advanced Security Permission status (Obtener el estado del permiso de seguridad avanzada).
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Recupere una solicitud de incorporación de cambios.
getPullRequestById(number, string)	Recupere una solicitud de incorporación de cambios.
getPullRequestCommits(string, number, string)	Obtenga las confirmaciones de la solicitud de incorporación de cambios especificada.
getPullRequestConflict(string, number, number, string)	Recuperación de un conflicto para una solicitud de incorporación de cambios por identificador
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Recuperar todos los conflictos de una solicitud de incorporación de cambios
getPullRequestIteration(string, number, number, string)	Obtiene la iteración especificada para una solicitud de incorporación de cambios.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Recupere los cambios realizados en una solicitud de incorporación de cambios entre dos iteraciones.
getPullRequestIterationCommits(string, number, number, string, number, number)	Obtenga las confirmaciones de la iteración especificada de una solicitud de incorporación de cambios.
getPullRequestIterations(string, number, string, boolean)	Obtenga la lista de iteraciones de la solicitud de incorporación de cambios especificada.
getPullRequestIterationStatus(string, number, number, number, string)	Obtenga el estado de iteración de solicitud de incorporación de cambios específico por identificador. El identificador de estado es único dentro de la solicitud de incorporación de cambios en todas las iteraciones.
getPullRequestIterationStatuses(string, number, number, string)	Obtenga todos los estados asociados a una iteración de solicitud de incorporación de cambios.
getPullRequestLabel(string, number, string, string, string)	Recupera una sola etiqueta (etiqueta) que se ha asignado a una solicitud de incorporación de cambios.
getPullRequestLabels(string, number, string, string)	Obtenga todas las etiquetas (etiquetas) asignadas a una solicitud de incorporación de cambios.
getPullRequestProperties(string, number, string)	Obtiene las propiedades externas de la solicitud de incorporación de cambios.
getPullRequestQuery(GitPullRequestQuery, string, string)	Esta API se usa para buscar qué solicitudes de incorporación de cambios están relacionadas con una confirmación determinada. Se puede usar para buscar la solicitud de incorporación de cambios que creó una confirmación de combinación determinada o se puede usar para buscar todas las solicitudes de incorporación de cambios que alguna vez han combinado una confirmación determinada. La entrada es una lista de consultas que contienen una lista de confirmaciones. Para cada confirmación en la que busque, obtendrá un diccionario de confirmación:> solicitudes de incorporación de cambios.
getPullRequestReviewer(string, number, string, string)	Recuperar información sobre un revisor determinado en una solicitud de incorporación de cambios
getPullRequestReviewers(string, number, string)	Recuperación de los revisores para una solicitud de incorporación de cambios
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	Recupere todas las solicitudes de incorporación de cambios que coincidan con un criterio especificado.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	Recupere todas las solicitudes de incorporación de cambios que coincidan con un criterio especificado.
getPullRequestStatus(string, number, number, string)	Obtenga el estado específico de la solicitud de incorporación de cambios por identificador. El identificador de estado es único dentro de la solicitud de incorporación de cambios en todas las iteraciones.
getPullRequestStatuses(string, number, string)	Obtenga todos los estados asociados a una solicitud de incorporación de cambios.
getPullRequestThread(string, number, number, string, number, number)	Recuperar un subproceso en una solicitud de incorporación de cambios.
getPullRequestWorkItemRefs(string, number, string)	Recupere una lista de elementos de trabajo asociados a una solicitud de incorporación de cambios.
getPush(string, number, string, number, boolean)	Recupera una inserción determinada.
getPushCommits(string, number, string, number, number, boolean)	Recupere una lista de confirmaciones asociadas a una inserción determinada.
getPushes(string, string, number, number, GitPushSearchCriteria)	Recupera inserciones asociadas al repositorio especificado.
getRecycleBinRepositories(string)	Recupere repositorios git eliminados temporalmente de la papelera de reciclaje.
getRefFavorite(string, number)	Obtiene el favorito de referencias para un identificador favorito.
getRefFavorites(string, string, string)	Obtiene los favoritos de las referencias para un repositorio y una identidad.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	Consulta el repositorio proporcionado para sus referencias y los devuelve.
getRepositories(string, boolean, boolean, boolean)	Recuperar repositorios de Git.
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	Recupere repositorios de Git con filtro por nombre y paginación.
getRepository(string, string)	Recuperar un repositorio de Git.
getRepositoryWithParent(string, boolean, string)	Recuperar un repositorio de Git.
getRevert(string, number, string)	Recupere información sobre una operación de reversión mediante el identificador de reversión.
getRevertConflict(string, number, number, string)	Recuperación de un conflicto para una reversión por identificador
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	Recuperar todos los conflictos de una reversión
getRevertForRefName(string, string, string)	Recupere información sobre una operación de reversión para una rama específica.
getStatuses(string, string, string, number, number, boolean)	Obtenga los estados asociados a la confirmación de Git.
getSuggestions(string, string, boolean)	Recupere una sugerencia de solicitud de incorporación de cambios para un repositorio o proyecto de equipo determinado.
getThreads(string, number, string, number, number)	Recupere todos los subprocesos de una solicitud de incorporación de cambios.
getTree(string, string, string, string, boolean, string)	El punto de conexión tree devuelve la colección de objetos debajo del árbol especificado. Los árboles son carpetas en un repositorio de Git.
getTreeZip(string, string, string, string, boolean, string)	El punto de conexión tree devuelve la colección de objetos debajo del árbol especificado. Los árboles son carpetas en un repositorio de Git.
queryImportRequests(string, string, boolean)	Recuperar solicitudes de importación para un repositorio.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Recuperar un repositorio git eliminado temporalmente. Los repositorios eliminados recientemente entran en un estado de eliminación temporal durante un período de tiempo antes de que se eliminen de forma permanente y se vuelvan irrecuperables.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	Envía una notificación por correo electrónico sobre una solicitud de incorporación de cambios específica a un conjunto de destinatarios.
updateCherryPickConflict(GitConflict, string, number, number, string)	Actualización de la resolución de conflictos de mezcla
updateCherryPickConflicts(GitConflict[], string, number, string)	Actualización de varias resoluciones de conflictos de combinación
updateComment(Comment, string, number, number, number, string)	Actualice un comentario asociado a un subproceso específico en una solicitud de incorporación de cambios.
updateEnablementStatus(AdvSecEnablementUpdate[])	Estado de habilitación POST para repositorios.
updateImportRequest(GitImportRequest, string, string, number)	Vuelva a intentar o abandone una solicitud de importación con errores.
updatePullRequest(GitPullRequest, string, number, string)	Actualización de una solicitud de incorporación de cambios
updatePullRequestConflict(GitConflict, string, number, number, string)	Actualización de la resolución de conflictos de mezcla
updatePullRequestConflicts(GitConflict[], string, number, string)	Actualización de varias resoluciones de conflictos de combinación
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	Actualice la colección de estados de iteración de solicitudes de incorporación de cambios. El único tipo de operación admitido es `remove`.
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Cree o actualice las propiedades externas de la solicitud de incorporación de cambios. La operación de revisión puede ser `add`, `replace` o `remove`. Para `add` operación, la ruta de acceso puede estar vacía. Si la ruta de acceso está vacía, el valor debe ser una lista de pares clave-valor. Para `replace` operación, la ruta de acceso no puede estar vacía. Si la ruta de acceso no existe, la propiedad se agregará a la colección. Para `remove` operación, la ruta de acceso no puede estar vacía. Si la ruta de acceso no existe, no se realizará ninguna acción.
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Edite una entrada de revisor. Estos campos son revisables: isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Restablezca los votos de varios revisores en una solicitud de incorporación de cambios. NOTA: Este punto de conexión solo admite la actualización de votos, pero no admite la actualización de revisores necesarios (use la directiva) o los nombres para mostrar.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	Actualice la colección de estados de solicitud de incorporación de cambios. El único tipo de operación admitido es `remove`.
updateRef(GitRefUpdate, string, string, string, string)	Bloquear o desbloquear una rama.
updateRefs(GitRefUpdate[], string, string, string)	Creación, actualización o eliminación de referencias (ramas).
updateRepository(GitRepository, string, string)	Actualiza el repositorio de Git con un nuevo nombre de repositorio o una nueva rama predeterminada.
updateRevertConflict(GitConflict, string, number, number, string)	Actualización de la resolución de conflictos de mezcla
updateRevertConflicts(GitConflict[], string, number, string)	Actualización de varias resoluciones de conflictos de combinación
updateThread(GitPullRequestCommentThread, string, number, number, string)	Actualice un subproceso en una solicitud de incorporación de cambios.

Detalles del constructor

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

Parámetros

options: IVssRestClientOptions

Detalles de las propiedades

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valor de propiedad

string

Detalles del método

createAnnotatedTag(GitAnnotatedTag, string, string)

Cree una etiqueta anotada.

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

Parámetros

tagObject: GitAnnotatedTag

Objeto que contiene detalles de la etiqueta que se va a crear.

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Identificador o nombre del repositorio.

Devoluciones

Promise<GitAnnotatedTag>

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

Adjunte un nuevo archivo a una solicitud de incorporación de cambios.

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

Parámetros

content: any

Contenido que se va a cargar

fileName: string

Nombre del archivo.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

Cherry elige una confirmación o confirmaciones específicas asociadas a una solicitud de incorporación de cambios en una nueva rama.

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

Parámetros

cherryPickToCreate: GitAsyncRefOperationParameters

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Identificador del repositorio.

Devoluciones

Promise<GitCherryPick>

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

Cree un comentario en un subproceso específico en una solicitud de incorporación de cambios (se pueden crear hasta 500 comentarios por subproceso).

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

Parámetros

comment: Comment

Comentario que se va a crear. Los comentarios pueden tener hasta 150 000 caracteres.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

threadId: number

Identificador del subproceso en el que está el comentario deseado.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Cree el estado de confirmación de Git.

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

Parámetros

gitCommitStatusToCreate: GitStatus

Objeto de estado de confirmación de Git que se va a crear.

commitId: string

Identificador de la confirmación de Git.

repositoryId: string

Identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

Crea un favorito de referencia

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

Parámetros

favorite: GitRefFavorite

Favorito de referencia que se va a crear.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Solicite que las referencias de otro repositorio se capturen en esta. Sincroniza dos bifurcaciones existentes. Para crear una bifurcación, consulte el <un href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"> repositorios de punto de conexión</a>

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

Parámetros

syncParams: GitForkSyncRequestParameters

Repositorio de origen y asignación de referencias.

repositoryNameOrId: string

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

includeLinks: boolean

True para incluir vínculos

Devoluciones

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

Cree una solicitud de importación.

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

Parámetros

importRequest: GitImportRequest

Solicitud de importación que se va a crear.

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Nombre o identificador del repositorio.

Devoluciones

Promise<GitImportRequest>

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

Agregue un like en un comentario.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

threadId: number

Identificador del subproceso que contiene el comentario.

commentId: number

Identificador del comentario.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Solicite una operación de combinación de Git. Actualmente solo se admite la combinación de 2 confirmaciones.

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

Parámetros

mergeParameters: GitMergeParameters

Los commitIds primarios y el error de confirmación de combinación.

project: string

Id. de proyecto o nombre del proyecto

repositoryNameOrId: string

Nombre o identificador del repositorio.

includeLinks: boolean

True para incluir vínculos

Devoluciones

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

Cree una solicitud de incorporación de cambios.

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

Parámetros

gitPullRequestToCreate: GitPullRequest

Solicitud de incorporación de cambios que se va a crear.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

supportsIterations: boolean

Si es true, las inserciones posteriores a la solicitud de incorporación de cambios se podrán revisar individualmente. Establézcalo en false para las solicitudes de incorporación de cambios grandes por motivos de rendimiento si no se necesita esta funcionalidad.

Devoluciones

Promise<GitPullRequest>

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

Cree un estado de solicitud de incorporación de cambios en la iteración. Esta operación tendrá el mismo resultado que Crear estado en la solicitud de incorporación de cambios con el identificador de iteración especificado en el cuerpo de la solicitud.

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

Parámetros

status: GitPullRequestStatus

Estado de la solicitud de incorporación de cambios para crear.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

iterationId: number

Identificador de la iteración de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequestStatus>

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

Cree una etiqueta (si aún no existe) y agréguela como etiqueta (etiqueta) para una solicitud de incorporación de cambios especificada. El único campo obligatorio es el nombre de la nueva etiqueta (etiqueta).

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

Parámetros

label: WebApiCreateTagRequestData

Etiqueta que se va a asignar a la solicitud de incorporación de cambios.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

projectId: string

Id. de proyecto o nombre del proyecto.

Devoluciones

Promise<WebApiTagDefinition>

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

Agregue un revisor a una solicitud de incorporación de cambios o emita un voto.

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

Parámetros

reviewer: IdentityRefWithVote

Voto del revisor.<br/>Si el identificador del revisor está incluido aquí, debe coincidir con el parámetro reviewerID.<br />Revisores pueden establecer su propio voto con este método. Al agregar otros revisores, el voto debe establecerse en cero.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

reviewerId: string

Identificador del revisor.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<IdentityRefWithVote>

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

Agregue revisores a una solicitud de incorporación de cambios.

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

Parámetros

reviewers: IdentityRef[]

Revisores que se van a agregar a la solicitud de incorporación de cambios.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Cree un estado de solicitud de incorporación de cambios.

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

Parámetros

status: GitPullRequestStatus

Estado de la solicitud de incorporación de cambios para crear.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

Inserte los cambios en el repositorio.

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

Parámetros

push: GitPush

repositoryId: string

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

Cree un repositorio git en un proyecto de equipo.

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

Parámetros

gitRepositoryToCreate: GitRepositoryCreateOptions

Especifique el nombre del repositorio, el proyecto de equipo o el repositorio primario. La información del proyecto de equipo se puede omitir de gitRepositoryToCreate si la solicitud tiene ámbito de proyecto (es decir, incluye el identificador del proyecto).

project: string

Id. de proyecto o nombre del proyecto

sourceRef: string

[opcional] Especificar las referencias de origen que se van a usar al crear un repositorio de bifurcación

Devoluciones

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

Inicia la operación para crear una nueva rama que revierta los cambios introducidos por una confirmación específica o confirmaciones asociadas a una solicitud de incorporación de cambios.

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

Parámetros

revertToCreate: GitAsyncRefOperationParameters

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Identificador del repositorio.

Devoluciones

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

Cree un subproceso en una solicitud de incorporación de cambios.

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

Parámetros

commentThread: GitPullRequestCommentThread

Subproceso que se va a crear. El subproceso debe contener al menos un comentario.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Agregue una identidad no materializada a los revisores de una solicitud de incorporación de cambios.

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

Parámetros

reviewer: IdentityRefWithVote

Revisor para agregar a la solicitud de incorporación de cambios.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Elimine los datos adjuntos de una solicitud de incorporación de cambios.

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

Parámetros

fileName: string

Nombre de los datos adjuntos que se van a eliminar.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

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

Elimine un comentario asociado a un subproceso específico en una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

threadId: number

Identificador del subproceso en el que está el comentario deseado.

commentId: number

Id. del comentario.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE Elimina el estado de habilitación y los datos billableCommitters de la base de datos. Al eliminar los datos de habilitación, se deshabilitará eficazmente para los repositorios afectados.

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

Parámetros

allProjects: boolean

includeBillableCommitters: boolean

projectIds: string[]

Devoluciones

Promise<void>

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

Elimine un como en un comentario.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

threadId: number

Identificador del subproceso que contiene el comentario.

commentId: number

Identificador del comentario.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

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

Elimine el estado de iteración de la solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

iterationId: number

Identificador de la iteración de la solicitud de incorporación de cambios.

statusId: number

Identificador del estado de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

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

Quita una etiqueta (etiqueta) del conjunto de los asignados a la solicitud de incorporación de cambios. La propia etiqueta no se eliminará.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

labelIdOrName: string

Nombre o identificador de la etiqueta solicitada.

project: string

Id. de proyecto o nombre del proyecto

projectId: string

Id. de proyecto o nombre del proyecto.

Devoluciones

Promise<void>

deletePullRequestReviewer(string, number, string, string)

Quite un revisor de una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

reviewerId: string

Identificador del revisor que se va a quitar.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

deletePullRequestStatus(string, number, number, string)

Elimine el estado de la solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

statusId: number

Identificador del estado de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

deleteRefFavorite(string, number)

Elimina el favorito de referencias especificado.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

favoriteId: number

Identificador del favorito de referencia que se va a eliminar.

Devoluciones

Promise<void>

deleteRepository(string, string)

Eliminación de un repositorio de Git

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

Parámetros

repositoryId: string

Identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

Destruir (eliminar de forma temporal) un repositorio git eliminado temporalmente.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Identificador del repositorio.

Devoluciones

Promise<void>

getAnnotatedTag(string, string, string)

Obtiene una etiqueta anotada.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Identificador o nombre del repositorio.

objectId: string

ObjectId (Sha1Id) de la etiqueta que se va a obtener.

Devoluciones

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

Obtenga el contenido del archivo de los datos adjuntos de una solicitud de incorporación de cambios.

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

Parámetros

fileName: string

Nombre de los datos adjuntos.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<ArrayBuffer>

getAttachments(string, number, string)

Obtenga una lista de archivos adjuntos a una solicitud de incorporación de cambios determinada.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

Obtenga el contenido del archivo de los datos adjuntos de una solicitud de incorporación de cambios.

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

Parámetros

fileName: string

Nombre de los datos adjuntos.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

Recupere confirmadores facturables reales para el servicio advanced Security para una fecha determinada.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

billingDate: Date

Se esperaba UTC. Si no se especifican valores predeterminados para el día de facturación anterior.

skip: number

Omita las filas X del conjunto de resultados para simular la paginación.

take: number

Devuelve filas Y del conjunto de resultados para simular la paginación.

Devoluciones

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

Recupere confirmadores facturables reales detallados para el servicio advanced Security para una fecha determinada. Los resultados detallados no filtran intencionadamente los proyectos y repositorios eliminados temporalmente para ayudar a diagnosticar problemas de facturación.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

includeDetails: string

Devuelve todos los detalles de los confirmadores facturables.

billingDate: Date

Se esperaba UTC. Si no se especifican valores predeterminados para el día de facturación anterior.

Devoluciones

Promise<BillableCommitterDetail[]>

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

Obtenga un único blob.

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

Parámetros

repositoryId: string

Nombre o identificador del repositorio.

sha1: string

Hash SHA1 del archivo. Puede obtener el SHA1 de un archivo mediante el punto de conexión "Git/Items/Get Item".

project: string

Id. de proyecto o nombre del proyecto

download: boolean

Si es true, solicite una descarga en lugar de representarla en un explorador. Nota: este valor tiene como valor predeterminado true si $format es zip.

fileName: string

Proporcione un fileName que se usará para una descarga.

resolveLfs: boolean

Si es true, intente resolver un blob en su contenido de LFS, si es un archivo de puntero LFS. Solo es compatible con octet-stream Accept encabezados o tipos de $format

Devoluciones

Promise<GitBlobRef>

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

Obtenga un único blob.

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

Parámetros

repositoryId: string

Nombre o identificador del repositorio.

sha1: string

Hash SHA1 del archivo. Puede obtener el SHA1 de un archivo mediante el punto de conexión "Git/Items/Get Item".

project: string

Id. de proyecto o nombre del proyecto

download: boolean

Si es true, solicite una descarga en lugar de representarla en un explorador. Nota: este valor tiene como valor predeterminado true si $format es zip.

fileName: string

Proporcione un fileName que se usará para una descarga.

resolveLfs: boolean

Si es true, intente resolver un blob en su contenido de LFS, si es un archivo de puntero LFS. Solo es compatible con octet-stream Accept encabezados o tipos de $format

Devoluciones

Promise<ArrayBuffer>

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

Obtiene uno o varios blobs en una descarga de archivos ZIP.

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

Parámetros

blobIds: string[]

Identificadores de blob (hash SHA1) que se devolverán en el archivo ZIP.

repositoryId: string

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

filename: string

Devoluciones

Promise<ArrayBuffer>

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

Obtenga un único blob.

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

Parámetros

repositoryId: string

Nombre o identificador del repositorio.

sha1: string

Hash SHA1 del archivo. Puede obtener el SHA1 de un archivo mediante el punto de conexión "Git/Items/Get Item".

project: string

Id. de proyecto o nombre del proyecto

download: boolean

Si es true, solicite una descarga en lugar de representarla en un explorador. Nota: este valor tiene como valor predeterminado true si $format es zip.

fileName: string

Proporcione un fileName que se usará para una descarga.

resolveLfs: boolean

Si es true, intente resolver un blob en su contenido de LFS, si es un archivo de puntero LFS. Solo es compatible con octet-stream Accept encabezados o tipos de $format

Devoluciones

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Recuperar estadísticas sobre una sola rama.

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

Parámetros

repositoryId: string

Nombre o identificador del repositorio.

name: string

Nombre de la rama.

project: string

Id. de proyecto o nombre del proyecto

baseVersionDescriptor: GitVersionDescriptor

Identifica la confirmación o rama que se va a usar como base.

Devoluciones

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

Recupere estadísticas sobre todas las ramas de un repositorio.

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

Parámetros

repositoryId: string

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

baseVersionDescriptor: GitVersionDescriptor

Identifica la confirmación o rama que se va a usar como base.

Devoluciones

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

Recuperación de estadísticas para varias confirmaciones

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

Parámetros

searchCriteria: GitQueryBranchStatsCriteria

Confirmación base y lista de confirmaciones de destino que se van a comparar.

repositoryId: string

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitBranchStats[]>

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

Recupere los cambios de una confirmación determinada.

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

Parámetros

commitId: string

Identificador de la confirmación.

repositoryId: string

Identificador o nombre descriptivo del repositorio. Para usar el nombre descriptivo, también se debe especificar projectId.

project: string

Id. de proyecto o nombre del proyecto

top: number

Número máximo de cambios que se van a devolver.

skip: number

Número de cambios que se van a omitir.

Devoluciones

Promise<GitCommitChanges>

getCherryPick(string, number, string)

Recupere información sobre una operación de selección de cerezas por identificador de selección de cereza.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

cherryPickId: number

Id. de la selección de cereza.

repositoryId: string

Identificador del repositorio.

Devoluciones

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Recuperar un conflicto para una selección de cereza por identificador

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

Parámetros

repositoryId: string

cherryPickId: number

conflictId: number

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitConflict>

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

Recuperar todos los conflictos de una selección de cereza

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. de proyecto o nombre del proyecto

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Devoluciones

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

Recupere información sobre una operación de selección de cereza para una rama específica. Esta operación es costosa debido a la estructura de objetos subyacente, por lo que esta API solo examina las 1000 operaciones de selección de cereza más recientes.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Identificador del repositorio.

refName: string

GitAsyncRefOperationParameters generatedRefName usado para la operación de selección de cherry.

Devoluciones

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

Dado un commitId, devuelve una lista de confirmaciones que se encuentran en la misma familia cherry-pick.

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

Parámetros

repositoryNameOrId: string

commitId: string

project: string

Id. de proyecto o nombre del proyecto

includeLinks: boolean

Devoluciones

Promise<GitCommitRef[]>

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

Recupere un comentario asociado a un subproceso específico en una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

threadId: number

Identificador del subproceso en el que está el comentario deseado.

commentId: number

Id. del comentario.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<Comment>

getComments(string, number, number, string)

Recupere todos los comentarios asociados a un subproceso específico en una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

threadId: number

Identificador del subproceso.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<Comment[]>

getCommit(string, string, string, number)

Recuperar una confirmación determinada.

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

Parámetros

commitId: string

Identificador de la confirmación.

repositoryId: string

Identificador o nombre descriptivo del repositorio. Para usar el nombre descriptivo, también se debe especificar projectId.

project: string

Id. de proyecto o nombre del proyecto

changeCount: number

Número de cambios que se van a incluir en el resultado.

Devoluciones

Promise<GitCommit>

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

Busque la confirmación común más cercana (la base de combinación) entre las confirmaciones base y de destino, y obtenga la diferencia entre las confirmaciones base y de destino o las confirmaciones comunes y de destino.

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

Parámetros

repositoryId: string

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

diffCommonCommit: boolean

Si es true, diferencias entre las confirmaciones comunes y de destino. Si es false, diferencias entre confirmaciones base y de destino.

top: number

Número máximo de cambios que se van a devolver. El valor predeterminado es 100.

skip: number

Número de cambios que se van a omitir

baseVersionDescriptor: GitBaseVersionDescriptor

Descriptor para confirmación base.

targetVersionDescriptor: GitTargetVersionDescriptor

Descriptor para la confirmación de destino.

Devoluciones

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

Recuperación de confirmaciones de Git para un proyecto

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

Parámetros

repositoryId: string

Identificador o nombre descriptivo del repositorio. Para usar el nombre descriptivo, también se debe especificar projectId.

searchCriteria: GitQueryCommitsCriteria

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitCommitRef[]>

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

Recuperación de confirmaciones de Git para un proyecto que coincida con los criterios de búsqueda

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

Parámetros

searchCriteria: GitQueryCommitsCriteria

Opciones de búsqueda

repositoryId: string

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

skip: number

Número de confirmaciones que se van a omitir. El valor no puede superar los 3000 000.

top: number

Número máximo de confirmaciones que se van a devolver. El valor no puede superar los 50 000.

includeStatuses: boolean

True para incluir información de estado de confirmación adicional.

Devoluciones

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Recuperar repositorios git eliminados.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitDeletedRepository[]>

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

GET Estado de habilitación para los repositorios del proyecto.

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

Parámetros

projectIds: string[]

El valor predeterminado null es todos los proyectos del host, lista del estado de los repositorios del proyecto que se va a devolver

billingDate: Date

Se esperaba UTC, se pueden proporcionar valores predeterminados NULL a UtcNow(), para un estado de momento dado.

skip: number

Omita las filas X del conjunto de resultados para simular la paginación.

take: number

Devuelve filas Y del conjunto de resultados para simular la paginación.

Devoluciones

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

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

Parámetros

enableOnCreateHost: boolean

Devoluciones

Promise<boolean>

getEnableOnCreateProject(string)

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

Parámetros

enableOnCreateProjectId: string

Devoluciones

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

Obtenga confirmadores facturables estimados para un repositorio durante los últimos 90 días.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Devoluciones

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

Obtenga los pushers facturables estimados para una organización durante los últimos 90 días.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Devoluciones

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

Obtenga los pushers facturables estimados para un proyecto durante los últimos 90 días.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

Obtener las diferencias de archivo para cada uno de los archivos especificados

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

Parámetros

fileDiffsCriteria: FileDiffsCriteria

Lista de objetos de parámetros de archivo

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Nombre o identificador del repositorio

Devoluciones

Promise<FileDiff[]>

getForks(string, string, string, boolean)

Recupere todas las bifurcaciones de un repositorio de la colección.

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

Parámetros

repositoryNameOrId: string

Nombre o identificador del repositorio.

collectionId: string

Identificador de colección de proyectos de equipo.

project: string

Id. de proyecto o nombre del proyecto

includeLinks: boolean

True para incluir vínculos.

Devoluciones

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

Obtenga los detalles de una operación de sincronización de bifurcación específica.

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

Parámetros

repositoryNameOrId: string

Nombre o identificador del repositorio.

forkSyncOperationId: number

OperationId de la solicitud de sincronización.

project: string

Id. de proyecto o nombre del proyecto

includeLinks: boolean

True para incluir vínculos.

Devoluciones

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

Recupere todas las operaciones de sincronización de bifurcación solicitadas en este repositorio.

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

Parámetros

repositoryNameOrId: string

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

includeAbandoned: boolean

True para incluir solicitudes abandonadas.

includeLinks: boolean

True para incluir vínculos.

Devoluciones

Promise<GitForkSyncRequest[]>

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

Obtener metadatos de elemento o contenido para un solo elemento. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido, que siempre se devuelve como descarga.

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

Nombre o identificador del repositorio.

path: string

Ruta de acceso del elemento.

project: string

Id. de proyecto o nombre del proyecto

scopePath: string

Ámbito de ruta de acceso. El valor predeterminado es NULL.

recursionLevel: VersionControlRecursionType

Nivel de recursividad de esta solicitud. El valor predeterminado es "none", sin recursividad.

includeContentMetadata: boolean

Establézcalo en true para incluir metadatos de contenido. El valor predeterminado es false.

latestProcessedChange: boolean

Establézcalo en true para incluir los cambios más recientes. El valor predeterminado es false.

download: boolean

Establézcalo en true para descargar la respuesta como un archivo. El valor predeterminado es false.

versionDescriptor: GitVersionDescriptor

Descriptor de versión. El valor predeterminado es la rama predeterminada para el repositorio.

includeContent: boolean

Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es false.

resolveHfs: boolean

Establézcalo en true para resolver los archivos de puntero DE HFS de Git para devolver contenido real de Git HFS. El valor predeterminado es true.

sanitize: boolean

Establézcalo en true para sanear un archivo svg y devolverlo como imagen. Solo resulta útil si se solicita para el archivo svg. El valor predeterminado es false.

Devoluciones

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

Nombre o identificador del repositorio.

path: string

Ruta de acceso del elemento.

project: string

Id. de proyecto o nombre del proyecto

scopePath: string

Ámbito de ruta de acceso. El valor predeterminado es NULL.

recursionLevel: VersionControlRecursionType

Nivel de recursividad de esta solicitud. El valor predeterminado es "none", sin recursividad.

includeContentMetadata: boolean

Establézcalo en true para incluir metadatos de contenido. El valor predeterminado es false.

latestProcessedChange: boolean

Establézcalo en true para incluir los cambios más recientes. El valor predeterminado es false.

download: boolean

Establézcalo en true para descargar la respuesta como un archivo. El valor predeterminado es false.

versionDescriptor: GitVersionDescriptor

Descriptor de versión. El valor predeterminado es la rama predeterminada para el repositorio.

includeContent: boolean

Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es false.

resolveHfs: boolean

Establézcalo en true para resolver los archivos de puntero DE HFS de Git para devolver contenido real de Git HFS. El valor predeterminado es true.

sanitize: boolean

Establézcalo en true para sanear un archivo svg y devolverlo como imagen. Solo resulta útil si se solicita para el archivo svg. El valor predeterminado es false.

Devoluciones

Promise<ArrayBuffer>

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

Obtener metadatos de elemento o contenido para una colección de elementos. El parámetro de descarga es indicar si el contenido debe estar disponible como una descarga o simplemente enviar como una secuencia en la respuesta. No se aplica al contenido comprimido que siempre se devuelve como descarga.

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

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

scopePath: string

Ámbito de ruta de acceso. El valor predeterminado es NULL.

recursionLevel: VersionControlRecursionType

Nivel de recursividad de esta solicitud. El valor predeterminado es "none", sin recursividad.

includeContentMetadata: boolean

Establézcalo en true para incluir metadatos de contenido. El valor predeterminado es false.

latestProcessedChange: boolean

Establézcalo en true para incluir los cambios más recientes. El valor predeterminado es false.

download: boolean

Establézcalo en true para descargar la respuesta como un archivo. El valor predeterminado es false.

includeLinks: boolean

Establézcalo en true para incluir vínculos a elementos. El valor predeterminado es false.

versionDescriptor: GitVersionDescriptor

Descriptor de versión. El valor predeterminado es la rama predeterminada para el repositorio.

zipForUnix: boolean

Establézcalo en true para mantener los permisos de archivo para sistemas unix (y POSIX), como ejecutables y vínculos simbólicos.

Devoluciones

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

Nombre o identificador del repositorio.

path: string

Ruta de acceso del elemento.

project: string

Id. de proyecto o nombre del proyecto

scopePath: string

Ámbito de ruta de acceso. El valor predeterminado es NULL.

recursionLevel: VersionControlRecursionType

Nivel de recursividad de esta solicitud. El valor predeterminado es "none", sin recursividad.

includeContentMetadata: boolean

Establézcalo en true para incluir metadatos de contenido. El valor predeterminado es false.

latestProcessedChange: boolean

Establézcalo en true para incluir los cambios más recientes. El valor predeterminado es false.

download: boolean

Establézcalo en true para descargar la respuesta como un archivo. El valor predeterminado es false.

versionDescriptor: GitVersionDescriptor

Descriptor de versión. El valor predeterminado es la rama predeterminada para el repositorio.

includeContent: boolean

Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es false.

resolveHfs: boolean

Establézcalo en true para resolver los archivos de puntero DE HFS de Git para devolver contenido real de Git HFS. El valor predeterminado es true.

sanitize: boolean

Establézcalo en true para sanear un archivo svg y devolverlo como imagen. Solo resulta útil si se solicita para el archivo svg. El valor predeterminado es false.

Devoluciones

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

Nombre o identificador del repositorio.

path: string

Ruta de acceso del elemento.

project: string

Id. de proyecto o nombre del proyecto

scopePath: string

Ámbito de ruta de acceso. El valor predeterminado es NULL.

recursionLevel: VersionControlRecursionType

Nivel de recursividad de esta solicitud. El valor predeterminado es "none", sin recursividad.

includeContentMetadata: boolean

Establézcalo en true para incluir metadatos de contenido. El valor predeterminado es false.

latestProcessedChange: boolean

Establézcalo en true para incluir los cambios más recientes. El valor predeterminado es false.

download: boolean

Establézcalo en true para descargar la respuesta como un archivo. El valor predeterminado es false.

versionDescriptor: GitVersionDescriptor

Descriptor de versión. El valor predeterminado es la rama predeterminada para el repositorio.

includeContent: boolean

Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es false.

resolveHfs: boolean

Establézcalo en true para resolver los archivos de puntero DE HFS de Git para devolver contenido real de Git HFS. El valor predeterminado es true.

sanitize: boolean

Establézcalo en true para sanear un archivo svg y devolverlo como imagen. Solo resulta útil si se solicita para el archivo svg. El valor predeterminado es false.

Devoluciones

Promise<ArrayBuffer>

getImportRequest(string, string, number)

Recupere una solicitud de importación determinada.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Nombre o identificador del repositorio.

importRequestId: number

Identificador único de la solicitud de importación.

Devoluciones

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

Nombre o identificador del repositorio.

path: string

Ruta de acceso del elemento.

project: string

Id. de proyecto o nombre del proyecto

scopePath: string

Ámbito de ruta de acceso. El valor predeterminado es NULL.

recursionLevel: VersionControlRecursionType

Nivel de recursividad de esta solicitud. El valor predeterminado es "none", sin recursividad.

includeContentMetadata: boolean

Establézcalo en true para incluir metadatos de contenido. El valor predeterminado es false.

latestProcessedChange: boolean

Establézcalo en true para incluir los cambios más recientes. El valor predeterminado es false.

download: boolean

Establézcalo en true para descargar la respuesta como un archivo. El valor predeterminado es false.

versionDescriptor: GitVersionDescriptor

Descriptor de versión. El valor predeterminado es la rama predeterminada para el repositorio.

includeContent: boolean

Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es false.

resolveLfs: boolean

Establézcalo en true para resolver los archivos de puntero de Git LFS para devolver contenido real de Git LFS. El valor predeterminado es false.

sanitize: boolean

Establézcalo en true para sanear un archivo svg y devolverlo como imagen. Solo resulta útil si se solicita para el archivo svg. El valor predeterminado es false.

Devoluciones

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

Nombre o identificador del repositorio.

path: string

Ruta de acceso del elemento.

project: string

Id. de proyecto o nombre del proyecto

scopePath: string

Ámbito de ruta de acceso. El valor predeterminado es NULL.

recursionLevel: VersionControlRecursionType

Nivel de recursividad de esta solicitud. El valor predeterminado es "none", sin recursividad.

includeContentMetadata: boolean

Establézcalo en true para incluir metadatos de contenido. El valor predeterminado es false.

latestProcessedChange: boolean

Establézcalo en true para incluir los cambios más recientes. El valor predeterminado es false.

download: boolean

Establézcalo en true para descargar la respuesta como un archivo. El valor predeterminado es false.

versionDescriptor: GitVersionDescriptor

Descriptor de versión. El valor predeterminado es la rama predeterminada para el repositorio.

includeContent: boolean

Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es false.

resolveLfs: boolean

Establézcalo en true para resolver los archivos de puntero de Git LFS para devolver contenido real de Git LFS. El valor predeterminado es false.

sanitize: boolean

Establézcalo en true para sanear un archivo svg y devolverlo como imagen. Solo resulta útil si se solicita para el archivo svg. El valor predeterminado es false.

Devoluciones

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

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

scopePath: string

Ámbito de ruta de acceso. El valor predeterminado es NULL.

recursionLevel: VersionControlRecursionType

Nivel de recursividad de esta solicitud. El valor predeterminado es "none", sin recursividad.

includeContentMetadata: boolean

Establézcalo en true para incluir metadatos de contenido. El valor predeterminado es false.

latestProcessedChange: boolean

Establézcalo en true para incluir los cambios más recientes. El valor predeterminado es false.

download: boolean

Establézcalo en true para descargar la respuesta como un archivo. El valor predeterminado es false.

includeLinks: boolean

Establézcalo en true para incluir vínculos a elementos. El valor predeterminado es false.

versionDescriptor: GitVersionDescriptor

Descriptor de versión. El valor predeterminado es la rama predeterminada para el repositorio.

zipForUnix: boolean

Establézcalo en true para mantener los permisos de archivo para sistemas unix (y POSIX), como ejecutables y vínculos simbólicos.

Devoluciones

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Publicar para recuperar un lote fuera de un conjunto de elementos de un repositorio o proyecto dada una lista de rutas de acceso o una ruta de acceso larga

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

Parámetros

requestData: GitItemRequestData

Solicitar atributos de datos: ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors: colección de elementos que se van a capturar, incluida la ruta de acceso, la versión y el nivel de recursividad. IncludeContentMetadata: indica si se deben incluir metadatos para todos los elementos LatestProcessedChange: indica si se debe incluir una referencia superficial para confirmar que ha cambiado por última vez cada elemento. IncludeLinks: indica si se debe incluir el campo _links en las referencias poco profundas.

repositoryId: string

Nombre o identificador del repositorio

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

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

Nombre o identificador del repositorio.

path: string

Ruta de acceso del elemento.

project: string

Id. de proyecto o nombre del proyecto

scopePath: string

Ámbito de ruta de acceso. El valor predeterminado es NULL.

recursionLevel: VersionControlRecursionType

Nivel de recursividad de esta solicitud. El valor predeterminado es "none", sin recursividad.

includeContentMetadata: boolean

Establézcalo en true para incluir metadatos de contenido. El valor predeterminado es false.

latestProcessedChange: boolean

Establézcalo en true para incluir los cambios más recientes. El valor predeterminado es false.

download: boolean

Establézcalo en true para descargar la respuesta como un archivo. El valor predeterminado es false.

versionDescriptor: GitVersionDescriptor

Descriptor de versión. El valor predeterminado es la rama predeterminada para el repositorio.

includeContent: boolean

Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es false.

resolveLfs: boolean

Establézcalo en true para resolver los archivos de puntero de Git LFS para devolver contenido real de Git LFS. El valor predeterminado es false.

sanitize: boolean

Establézcalo en true para sanear un archivo svg y devolverlo como imagen. Solo resulta útil si se solicita para el archivo svg. El valor predeterminado es false.

Devoluciones

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

Nombre o identificador del repositorio.

path: string

Ruta de acceso del elemento.

project: string

Id. de proyecto o nombre del proyecto

scopePath: string

Ámbito de ruta de acceso. El valor predeterminado es NULL.

recursionLevel: VersionControlRecursionType

Nivel de recursividad de esta solicitud. El valor predeterminado es "none", sin recursividad.

includeContentMetadata: boolean

Establézcalo en true para incluir metadatos de contenido. El valor predeterminado es false.

latestProcessedChange: boolean

Establézcalo en true para incluir los cambios más recientes. El valor predeterminado es false.

download: boolean

Establézcalo en true para descargar la respuesta como un archivo. El valor predeterminado es false.

versionDescriptor: GitVersionDescriptor

Descriptor de versión. El valor predeterminado es la rama predeterminada para el repositorio.

includeContent: boolean

Establézcalo en true para incluir el contenido del elemento al solicitar json. El valor predeterminado es false.

resolveLfs: boolean

Establézcalo en true para resolver los archivos de puntero de Git LFS para devolver contenido real de Git LFS. El valor predeterminado es false.

sanitize: boolean

Establézcalo en true para sanear un archivo svg y devolverlo como imagen. Solo resulta útil si se solicita para el archivo svg. El valor predeterminado es false.

Devoluciones

Promise<ArrayBuffer>

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

Obtenga likes para un comentario.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

threadId: number

Identificador del subproceso que contiene el comentario.

commentId: number

Identificador del comentario.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<IdentityRef[]>

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

Busque las bases de combinación de dos confirmaciones, opcionalmente en bifurcaciones. Si no se especifica otherRepositoryId, las bases de combinación solo se calcularán en el contexto del repositoryNameOrId local.

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

Parámetros

repositoryNameOrId: string

Identificador o nombre del repositorio local.

commitId: string

Primera confirmación, normalmente la sugerencia de la rama de destino de la posible combinación.

otherCommitId: string

Otra confirmación, normalmente la sugerencia de la rama de origen de la posible combinación.

project: string

Id. de proyecto o nombre del proyecto

otherCollectionId: string

Identificador de colección donde reside otherCommitId.

otherRepositoryId: string

Identificador del repositorio donde reside otherCommitId.

Devoluciones

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

Obtenga los detalles de una operación de combinación específica.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

repositoryNameOrId: string

Nombre o identificador del repositorio.

mergeOperationId: number

OperationId de la solicitud de combinación.

includeLinks: boolean

True para incluir vínculos

Devoluciones

Promise<GitMerge>

getPermission(string, string, string)

Get Advanced Security Permission status (Obtener el estado del permiso de seguridad avanzada).

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

Parámetros

projectName: string

repositoryId: string

El usuario del repositorio está intentando acceder

permission: string

El permiso que se solicita debe ser "viewAlert" "dismissAlert" "manage" "viewEnablement" o "repoRead"

Devoluciones

Promise<boolean>

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

Recupere una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios que se va a recuperar.

project: string

Id. de proyecto o nombre del proyecto

maxCommentLength: number

No se usa.

skip: number

No se usa.

top: number

No se usa.

includeCommits: boolean

Si es true, la solicitud de incorporación de cambios se devolverá con las confirmaciones asociadas.

includeWorkItemRefs: boolean

Si es true, la solicitud de incorporación de cambios se devolverá con las referencias de elemento de trabajo asociadas.

Devoluciones

Promise<GitPullRequest>

getPullRequestById(number, string)

Recupere una solicitud de incorporación de cambios.

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

Parámetros

pullRequestId: number

Identificador de la solicitud de incorporación de cambios que se va a recuperar.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

Obtenga las confirmaciones de la solicitud de incorporación de cambios especificada.

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

Parámetros

repositoryId: string

Identificador o nombre del repositorio.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Recuperación de un conflicto para una solicitud de incorporación de cambios por identificador

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

Parámetros

repositoryId: string

pullRequestId: number

conflictId: number

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitConflict>

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

Recuperar todos los conflictos de una solicitud de incorporación de cambios

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

Parámetros

repositoryId: string

Repositorio de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

skip: number

Conflictos que se van a omitir.

top: number

Conflictos que se devuelven después de omitir.

includeObsolete: boolean

Incluye conflictos obsoletos.

excludeResolved: boolean

Excluye los conflictos ya resueltos.

onlyResolved: boolean

Devuelve solo los conflictos que se resuelven.

Devoluciones

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

Obtiene la iteración especificada para una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador o nombre del repositorio.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

iterationId: number

Identificador de la iteración de la solicitud de incorporación de cambios que se va a devolver.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequestIteration>

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

Recupere los cambios realizados en una solicitud de incorporación de cambios entre dos iteraciones.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

iterationId: number

Identificador de la iteración de la solicitud de incorporación de cambios. <br /> Iteración uno es el encabezado de la rama de origen en el momento en que se crea la solicitud de incorporación de cambios y las iteraciones posteriores se crean cuando hay inserciones en la rama de origen. Los valores permitidos están comprendidos entre 1 y la iteración máxima en esta solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

top: number

Opcional. Número de cambios que se van a recuperar. El valor predeterminado es 100 y el valor máximo es 2000.

skip: number

Opcional. Número de cambios que se omitirán. Por ejemplo, para recuperar los cambios 101-150, establezca los 50 principales y vaya a 100.

compareTo: number

Identificador de la iteración de la solicitud de incorporación de cambios con la que se va a comparar. El valor predeterminado es cero, lo que indica que la comparación se realiza con respecto a la confirmación común entre las ramas de origen y de destino.

Devoluciones

Promise<GitPullRequestIterationChanges>

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

Obtenga las confirmaciones de la iteración especificada de una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador o nombre del repositorio.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

iterationId: number

Identificador de la iteración desde la que se van a obtener las confirmaciones.

project: string

Id. de proyecto o nombre del proyecto

top: number

Número máximo de confirmaciones que se van a devolver. El número máximo de confirmaciones que se pueden devolver por lote es 500.

skip: number

Número de confirmaciones que se van a omitir.

Devoluciones

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

Obtenga la lista de iteraciones de la solicitud de incorporación de cambios especificada.

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

Parámetros

repositoryId: string

Identificador o nombre del repositorio.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

includeCommits: boolean

Si es true, incluya las confirmaciones asociadas a cada iteración en la respuesta.

Devoluciones

Promise<GitPullRequestIteration[]>

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

Obtenga el estado de iteración de solicitud de incorporación de cambios específico por identificador. El identificador de estado es único dentro de la solicitud de incorporación de cambios en todas las iteraciones.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

iterationId: number

Identificador de la iteración de la solicitud de incorporación de cambios.

statusId: number

Identificador del estado de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

Obtenga todos los estados asociados a una iteración de solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

iterationId: number

Identificador de la iteración de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequestStatus[]>

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

Recupera una sola etiqueta (etiqueta) que se ha asignado a una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

labelIdOrName: string

Nombre o identificador de la etiqueta solicitada.

project: string

Id. de proyecto o nombre del proyecto

projectId: string

Id. de proyecto o nombre del proyecto.

Devoluciones

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

Obtenga todas las etiquetas (etiquetas) asignadas a una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

projectId: string

Id. de proyecto o nombre del proyecto.

Devoluciones

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

Obtiene las propiedades externas de la solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

Esta API se usa para buscar qué solicitudes de incorporación de cambios están relacionadas con una confirmación determinada. Se puede usar para buscar la solicitud de incorporación de cambios que creó una confirmación de combinación determinada o se puede usar para buscar todas las solicitudes de incorporación de cambios que alguna vez han combinado una confirmación determinada. La entrada es una lista de consultas que contienen una lista de confirmaciones. Para cada confirmación en la que busque, obtendrá un diccionario de confirmación:> solicitudes de incorporación de cambios.

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

Parámetros

queries: GitPullRequestQuery

Lista de consultas que se van a realizar.

repositoryId: string

Identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

Recuperar información sobre un revisor determinado en una solicitud de incorporación de cambios

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

reviewerId: string

Identificador del revisor.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

Recuperación de los revisores para una solicitud de incorporación de cambios

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<IdentityRefWithVote[]>

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

Recupere todas las solicitudes de incorporación de cambios que coincidan con un criterio especificado.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

searchCriteria: GitPullRequestSearchCriteria

Se devolverán solicitudes de incorporación de cambios que coincidan con estos criterios de búsqueda.

project: string

Id. de proyecto o nombre del proyecto

maxCommentLength: number

No se usa.

skip: number

Número de solicitudes de incorporación de cambios que se omitirán. Por ejemplo, para recuperar los resultados 101-150, establezca top en 50 y vaya a 100.

top: number

Número de solicitudes de incorporación de cambios que se van a recuperar.

Devoluciones

Promise<GitPullRequest[]>

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

Recupere todas las solicitudes de incorporación de cambios que coincidan con un criterio especificado.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

searchCriteria: GitPullRequestSearchCriteria

Se devolverán solicitudes de incorporación de cambios que coincidan con estos criterios de búsqueda.

maxCommentLength: number

No se usa.

skip: number

Número de solicitudes de incorporación de cambios que se omitirán. Por ejemplo, para recuperar los resultados 101-150, establezca top en 50 y vaya a 100.

top: number

Número de solicitudes de incorporación de cambios que se van a recuperar.

Devoluciones

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

Obtenga el estado específico de la solicitud de incorporación de cambios por identificador. El identificador de estado es único dentro de la solicitud de incorporación de cambios en todas las iteraciones.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

statusId: number

Identificador del estado de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

Obtenga todos los estados asociados a una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequestStatus[]>

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

Recuperar un subproceso en una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

threadId: number

Identificador del subproceso.

project: string

Id. de proyecto o nombre del proyecto

iteration: number

Si se especifica, se realizará un seguimiento de la posición del subproceso mediante esta iteración como lado derecho de la diferencia.

baseIteration: number

Si se especifica, se realizará un seguimiento de la posición del subproceso mediante esta iteración como lado izquierdo de la diferencia.

Devoluciones

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

Recupere una lista de elementos de trabajo asociados a una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador o nombre del repositorio.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<ResourceRef[]>

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

Recupera una inserción determinada.

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

Parámetros

repositoryId: string

Nombre o identificador del repositorio.

pushId: number

Identificador de la inserción.

project: string

Id. de proyecto o nombre del proyecto

includeCommits: number

Número de confirmaciones que se van a incluir en el resultado.

includeRefUpdates: boolean

Si es true, incluya la lista de referencias actualizadas por la inserción.

Devoluciones

Promise<GitPush>

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

Recupere una lista de confirmaciones asociadas a una inserción determinada.

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

Parámetros

repositoryId: string

Identificador o nombre descriptivo del repositorio. Para usar el nombre descriptivo, también se debe especificar projectId.

pushId: number

Identificador de la inserción.

project: string

Id. de proyecto o nombre del proyecto

top: number

Número máximo de confirmaciones que se van a devolver ("obtener las confirmaciones x principales").

skip: number

Número de confirmaciones que se van a omitir.

includeLinks: boolean

Establézcalo en false para evitar incluir vínculos url de REST para recursos. El valor predeterminado es true.

Devoluciones

Promise<GitCommitRef[]>

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

Recupera inserciones asociadas al repositorio especificado.

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

Parámetros

repositoryId: string

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

skip: number

Número de inserciones que se van a omitir.

top: number

Número de inserciones que se van a devolver.

searchCriteria: GitPushSearchCriteria

Atributos de criterios de búsqueda: fromDate, toDate, pusherId, refName, includeRefUpdates o includeLinks. fromDate: fecha de inicio desde la que se va a buscar. toDate: fecha de finalización a la que se va a buscar. pusherId: identidad de la persona que envió la inserción. refName: nombre de rama que se debe tener en cuenta. includeRefUpdates: si es true, incluya la lista de referencias actualizadas por la inserción. includeLinks: indica si se debe incluir el campo _links en las referencias poco profundas.

Devoluciones

Promise<GitPush[]>

getRecycleBinRepositories(string)

Recupere repositorios git eliminados temporalmente de la papelera de reciclaje.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Obtiene el favorito de referencias para un identificador favorito.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

favoriteId: number

Identificador del favorito de referencia solicitado.

Devoluciones

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Obtiene los favoritos de las referencias para un repositorio y una identidad.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Identificador del repositorio.

identityId: string

Identificador de la identidad cuyos favoritos se van a recuperar. Si es null, se usa la identidad solicitante.

Devoluciones

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

identityId: string

Devoluciones

Promise<GitRefFavorite[]>

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

Consulta el repositorio proporcionado para sus referencias y los devuelve.

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

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

filter: string

[opcional] Filtro que se va a aplicar a las referencias (comienza por).

includeLinks: boolean

[opcional] Especifica si referenceLinks debe incluirse en el resultado. el valor predeterminado es false.

includeStatuses: boolean

[opcional] Incluye hasta los primeros 1000 estados de confirmación para cada referencia. El valor predeterminado es false.

includeMyBranches: boolean

[opcional] Incluye solo ramas que posee el usuario, las ramas favoritas del usuario y la rama predeterminada. El valor predeterminado es false. No se puede combinar con el parámetro de filtro.

latestStatusesOnly: boolean

[opcional] True para incluir solo el estado de confirmación de propina para cada referencia. Esta opción requiere que includeStatuses sea true. El valor predeterminado es false.

peelTags: boolean

[opcional] Las etiquetas anotadas rellenarán la propiedad PeeledObjectId. el valor predeterminado es false.

filterContains: string

[opcional] Filtro que se va a aplicar a las referencias (contiene).

Devoluciones

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

Recuperar repositorios de Git.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

includeLinks: boolean

[opcional] True para incluir vínculos de referencia. El valor predeterminado es false.

includeAllUrls: boolean

[opcional] True para incluir todas las direcciones URL remotas. El valor predeterminado es false.

includeHidden: boolean

[opcional] True para incluir repositorios ocultos. El valor predeterminado es false.

Devoluciones

Promise<GitRepository[]>

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

Recupere repositorios de Git con filtro por nombre y paginación.

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

Parámetros

projectId: string

Identificador o nombre del proyecto de equipo.

includeLinks: boolean

[opcional] True para incluir vínculos de referencia. El valor predeterminado es false.

includeAllUrls: boolean

[opcional] True para incluir todas las direcciones URL remotas. El valor predeterminado es false.

includeHidden: boolean

[opcional] True para incluir repositorios ocultos. El valor predeterminado es false.

filterContains: string

[opcional] Filtro que se va a aplicar a las referencias (contiene).

top: number

[opcional] Número máximo de repositorios que se van a devolver. No puede ser mayor que 500. Si no se proporciona, pero continuationToken es, el valor predeterminado es 100.

continuationToken: string

Token de continuación usado para la paginación.

Devoluciones

Promise<PagedList<GitRepository>>

getRepository(string, string)

Recuperar un repositorio de Git.

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

Parámetros

repositoryId: string

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

Recuperar un repositorio de Git.

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

Parámetros

repositoryId: string

Nombre o identificador del repositorio.

includeParent: boolean

True para incluir el repositorio primario. Solo está disponible en llamadas autenticadas.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitRepository>

getRevert(string, number, string)

Recupere información sobre una operación de reversión mediante el identificador de reversión.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

revertId: number

Id. de la operación de reversión.

repositoryId: string

Identificador del repositorio.

Devoluciones

Promise<GitRevert>

getRevertConflict(string, number, number, string)

Recuperación de un conflicto para una reversión por identificador

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

Parámetros

repositoryId: string

revertId: number

conflictId: number

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitConflict>

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

Recuperar todos los conflictos de una reversión

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. de proyecto o nombre del proyecto

continuationToken: string

top: number

excludeResolved: boolean

onlyResolved: boolean

includeObsolete: boolean

Devoluciones

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

Recupere información sobre una operación de reversión para una rama específica.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Identificador del repositorio.

refName: string

GitAsyncRefOperationParameters generatedRefName usado para la operación de reversión.

Devoluciones

Promise<GitRevert>

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

Obtenga los estados asociados a la confirmación de Git.

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

Parámetros

commitId: string

Identificador de la confirmación de Git.

repositoryId: string

Identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

top: number

Opcional. Número de estados que se van a recuperar. El valor predeterminado es 1000.

skip: number

Opcional. Número de estados que se omitirán. El valor predeterminado es 0. Por ejemplo, para recuperar los resultados 101-150, establezca top en 50 y vaya a 100.

latestOnly: boolean

La marca indica si solo se agrupan los estados más recientes por Context.Name y Context.Genre.

Devoluciones

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

Recupere una sugerencia de solicitud de incorporación de cambios para un repositorio o proyecto de equipo determinado.

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

Parámetros

repositoryId: string

Identificador del repositorio de Git.

project: string

Id. de proyecto o nombre del proyecto

preferCompareBranch: boolean

Si es true, se prefiere la rama de comparación sobre la rama predeterminada como rama de destino para las solicitudes de incorporación de cambios.

Devoluciones

Promise<GitSuggestion[]>

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

Recupere todos los subprocesos de una solicitud de incorporación de cambios.

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

Parámetros

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

iteration: number

Si se especifica, se realizará un seguimiento de las posiciones del subproceso mediante esta iteración como lado derecho de la diferencia.

baseIteration: number

Si se especifica, se realizará un seguimiento de las posiciones del subproceso mediante esta iteración como lado izquierdo de la diferencia.

Devoluciones

Promise<GitPullRequestCommentThread[]>

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

El punto de conexión tree devuelve la colección de objetos debajo del árbol especificado. Los árboles son carpetas en un repositorio de Git.

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

Parámetros

repositoryId: string

Id. del repositorio.

sha1: string

Hash SHA1 del objeto de árbol.

project: string

Id. de proyecto o nombre del proyecto

projectId: string

Identificador del proyecto.

recursive: boolean

Buscar de forma recursiva. Incluya árboles debajo de este árbol. El valor predeterminado es false.

fileName: string

Nombre que se usará si se devuelve un archivo .zip. El valor predeterminado es el identificador de objeto.

Devoluciones

Promise<GitTreeRef>

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

El punto de conexión tree devuelve la colección de objetos debajo del árbol especificado. Los árboles son carpetas en un repositorio de Git.

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

Parámetros

repositoryId: string

Id. del repositorio.

sha1: string

Hash SHA1 del objeto de árbol.

project: string

Id. de proyecto o nombre del proyecto

projectId: string

Identificador del proyecto.

recursive: boolean

Buscar de forma recursiva. Incluya árboles debajo de este árbol. El valor predeterminado es false.

fileName: string

Nombre que se usará si se devuelve un archivo .zip. El valor predeterminado es el identificador de objeto.

Devoluciones

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

Recuperar solicitudes de importación para un repositorio.

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

Parámetros

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Nombre o identificador del repositorio.

includeAbandoned: boolean

True para incluir solicitudes de importación abandonadas en los resultados.

Devoluciones

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

Recuperar un repositorio git eliminado temporalmente. Los repositorios eliminados recientemente entran en un estado de eliminación temporal durante un período de tiempo antes de que se eliminen de forma permanente y se vuelvan irrecuperables.

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

Parámetros

repositoryDetails: GitRecycleBinRepositoryDetails

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Identificador del repositorio.

Devoluciones

Promise<GitRepository>

setEnableOnCreateHost(boolean)

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

Parámetros

enableOnCreateHost: boolean

Devoluciones

Promise<void>

setEnableOnCreateProject(string, boolean)

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

Parámetros

enableOnCreateProjectId: string

enableOnStatus: boolean

Devoluciones

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

Envía una notificación por correo electrónico sobre una solicitud de incorporación de cambios específica a un conjunto de destinatarios.

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

Parámetros

userMessage: ShareNotificationContext

repositoryId: string

Identificador del repositorio de Git.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

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

Actualización de la resolución de conflictos de mezcla

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. de proyecto o nombre del proyecto

Devoluciones

Promise<GitConflict>

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

Actualización de varias resoluciones de conflictos de combinación

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

Parámetros

conflictUpdates: GitConflict[]

repositoryId: string

cherryPickId: number

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitConflictUpdateResult[]>

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

Actualice un comentario asociado a un subproceso específico en una solicitud de incorporación de cambios.

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

Parámetros

comment: Comment

Contenido del comentario que se debe actualizar. Los comentarios pueden tener hasta 150 000 caracteres.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

threadId: number

Identificador del subproceso en el que está el comentario deseado.

commentId: number

Identificador del comentario que se va a actualizar.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

Estado de habilitación POST para repositorios.

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

Parámetros

enablementUpdates: AdvSecEnablementUpdate[]

Devoluciones

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

Vuelva a intentar o abandone una solicitud de importación con errores.

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

Parámetros

importRequestToUpdate: GitImportRequest

Versión actualizada de la solicitud de importación. Actualmente, el único cambio permitido es establecer el estado en En cola o Abandonado.

project: string

Id. de proyecto o nombre del proyecto

repositoryId: string

Nombre o identificador del repositorio.

importRequestId: number

Identificador único de la solicitud de importación que se va a actualizar.

Devoluciones

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

Actualización de una solicitud de incorporación de cambios

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

Parámetros

gitPullRequestToUpdate: GitPullRequest

Contenido de la solicitud de incorporación de cambios que se debe actualizar.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios que se va a actualizar.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequest>

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

Actualización de la resolución de conflictos de mezcla

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. de proyecto o nombre del proyecto

Devoluciones

Promise<GitConflict>

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

Actualización de varias resoluciones de conflictos de combinación

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

Parámetros

conflictUpdates: GitConflict[]

repositoryId: string

pullRequestId: number

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitConflictUpdateResult[]>

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

Actualice la colección de estados de iteración de solicitudes de incorporación de cambios. El único tipo de operación admitido es remove.

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

Parámetros

patchDocument: JsonPatchDocument

Operaciones que se aplican a los estados de la solicitud de incorporación de cambios en formato de revisión JSON.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

iterationId: number

Identificador de la iteración de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

Cree o actualice las propiedades externas de la solicitud de incorporación de cambios. La operación de revisión puede ser add, replace o remove. Para add operación, la ruta de acceso puede estar vacía. Si la ruta de acceso está vacía, el valor debe ser una lista de pares clave-valor. Para replace operación, la ruta de acceso no puede estar vacía. Si la ruta de acceso no existe, la propiedad se agregará a la colección. Para remove operación, la ruta de acceso no puede estar vacía. Si la ruta de acceso no existe, no se realizará ninguna acción.

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

Parámetros

patchDocument: JsonPatchDocument

Propiedades que se van a agregar, reemplazar o quitar en formato de revisión JSON.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<any>

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

Edite una entrada de revisor. Estos campos son revisables: isFlagged, hasDeclined

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

Parámetros

reviewer: IdentityRefWithVote

Datos del revisor.<br/>Si el identificador del revisor está incluido aquí, debe coincidir con el parámetro reviewerID.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

reviewerId: string

Identificador del revisor.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<IdentityRefWithVote>

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

Restablezca los votos de varios revisores en una solicitud de incorporación de cambios. NOTA: Este punto de conexión solo admite la actualización de votos, pero no admite la actualización de revisores necesarios (use la directiva) o los nombres para mostrar.

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

Parámetros

patchVotes: IdentityRefWithVote[]

Identificadores de los revisores cuyos votos se restablecerán a cero

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

Actualice la colección de estados de solicitud de incorporación de cambios. El único tipo de operación admitido es remove.

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

Parámetros

patchDocument: JsonPatchDocument

Operaciones que se aplican a los estados de la solicitud de incorporación de cambios en formato de revisión JSON.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

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

Bloquear o desbloquear una rama.

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

Parámetros

newRefInfo: GitRefUpdate

Acción de actualización de referencia (bloqueo/desbloqueo) que se va a realizar

repositoryId: string

Nombre o identificador del repositorio.

filter: string

Nombre de la rama que se va a bloquear o desbloquear

project: string

Id. de proyecto o nombre del proyecto

projectId: string

Identificador o nombre del proyecto de equipo. Opcional si especifica un identificador para el repositorio.

Devoluciones

Promise<GitRef>

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

Creación, actualización o eliminación de referencias (ramas).

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

Parámetros

refUpdates: GitRefUpdate[]

Lista de actualizaciones ref para intentar realizar

repositoryId: string

Nombre o identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

projectId: string

Identificador o nombre del proyecto de equipo. Opcional si especifica un identificador para el repositorio.

Devoluciones

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Actualiza el repositorio de Git con un nuevo nombre de repositorio o una nueva rama predeterminada.

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

Parámetros

newRepositoryInfo: GitRepository

Especificar un nuevo nombre de repositorio o una nueva rama predeterminada del repositorio

repositoryId: string

Identificador del repositorio.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitRepository>

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

Actualización de la resolución de conflictos de mezcla

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. de proyecto o nombre del proyecto

Devoluciones

Promise<GitConflict>

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

Actualización de varias resoluciones de conflictos de combinación

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

Parámetros

conflictUpdates: GitConflict[]

repositoryId: string

revertId: number

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitConflictUpdateResult[]>

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

Actualice un subproceso en una solicitud de incorporación de cambios.

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

Parámetros

commentThread: GitPullRequestCommentThread

Contenido del subproceso que se debe actualizar.

repositoryId: string

Identificador del repositorio de la rama de destino de la solicitud de incorporación de cambios.

pullRequestId: number

Identificador de la solicitud de incorporación de cambios.

threadId: number

Identificador del subproceso que se va a actualizar.

project: string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<GitPullRequestCommentThread>

Compartir a través de

GitRestClient class

Constructores

Propiedades

Métodos

Detalles del constructor

GitRestClient(IVssRestClientOptions)

Parámetros

Detalles de las propiedades

RESOURCE_AREA_ID

Valor de propiedad

Detalles del método

createAnnotatedTag(GitAnnotatedTag, string, string)

Parámetros

Devoluciones

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

Parámetros

Devoluciones

createCherryPick(GitAsyncRefOperationParameters, string, string)

Parámetros

Devoluciones

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

Parámetros

Devoluciones

createCommitStatus(GitStatus, string, string, string)

Parámetros

Devoluciones

createFavorite(GitRefFavorite, string)

Parámetros

Devoluciones

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Parámetros

Devoluciones

createImportRequest(GitImportRequest, string, string)

Parámetros

Devoluciones

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

Parámetros

Devoluciones

createMergeRequest(GitMergeParameters, string, string, boolean)

Parámetros

Devoluciones

createPullRequest(GitPullRequest, string, string, boolean)

Parámetros

Devoluciones

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

Parámetros

Devoluciones

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

Parámetros

Devoluciones

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

Parámetros

Devoluciones

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

Parámetros

Devoluciones

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Parámetros

Devoluciones

createPush(GitPush, string, string)

Parámetros

Devoluciones

createRepository(GitRepositoryCreateOptions, string, string)

Parámetros

Devoluciones

createRevert(GitAsyncRefOperationParameters, string, string)

Parámetros

Devoluciones

createThread(GitPullRequestCommentThread, string, number, string)

Parámetros

Devoluciones

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Parámetros

Devoluciones

deleteAttachment(string, string, number, string)

Parámetros

Devoluciones

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

Parámetros