GitRestClient class

Paquet:

azure-devops-extension-api

Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS

Extends

RestClientBase

Constructeurs

GitRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

createAnnotatedTag(GitAnnotatedTag, string, string)	Créez une balise annotée.
createAttachment(any, string, string, number, string)	Joignez un nouveau fichier à une demande de tirage.
createCherryPick(GitAsyncRefOperationParameters, string, string)	Cherry sélectionne une validation ou des validations spécifiques associées à une demande de tirage dans une nouvelle branche.
createComment(Comment, string, number, number, string)	Créez un commentaire sur un thread spécifique dans une demande de tirage (jusqu’à 500 commentaires peuvent être créés par thread).
createCommitStatus(GitStatus, string, string, string)	Créez l’état de validation Git.
createFavorite(GitRefFavorite, string)	Crée un favori ref
createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)	Demandez que les références d’un autre référentiel soient extraites dans celle-ci. Il synchronise deux duplications existantes. Pour créer une duplication, consultez le <unhttps://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"href=" ; point de terminaison de référentiels></a>
createImportRequest(GitImportRequest, string, string)	Créez une demande d’importation.
createLike(string, number, number, number, string)	Ajoutez une telle option sur un commentaire.
createMergeRequest(GitMergeParameters, string, string, boolean)	Demandez une opération de fusion Git. Actuellement, nous prenons en charge la fusion de 2 validations uniquement.
createPullRequest(GitPullRequest, string, string, boolean)	Créez une demande de tirage ( pull request).
createPullRequestIterationStatus(GitPullRequestStatus, string, number, number, string)	Créez un état de demande de tirage (pull request) sur l’itération. Cette opération aura le même résultat que Créer l’état sur la demande de tirage avec l’ID d’itération spécifié dans le corps de la requête.
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string, string)	Créez une balise (s’il n’existe pas encore) et ajoutez-la en tant qu’étiquette (balise) pour une demande de tirage spécifiée. Le seul champ obligatoire est le nom de la nouvelle étiquette (balise).
createPullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Ajoutez un réviseur à une demande de tirage ou effectuez un vote.
createPullRequestReviewers(IdentityRef[], string, number, string)	Ajoutez des réviseurs à une demande de tirage( pull request).
createPullRequestStatus(GitPullRequestStatus, string, number, string)	Créez un état de demande de tirage( pull request).
createPush(GitPush, string, string)	Envoyer (push) les modifications au référentiel.
createRepository(GitRepositoryCreateOptions, string, string)	Créez un dépôt Git dans un projet d’équipe.
createRevert(GitAsyncRefOperationParameters, string, string)	Démarre l’opération pour créer une branche qui rétablit les modifications introduites par une validation ou des validations spécifiques associées à une demande de tirage.
createThread(GitPullRequestCommentThread, string, number, string)	Créez un thread dans une demande de tirage.
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)	Ajoutez une identité non matérialisée aux réviseurs d’une demande de tirage.
deleteAttachment(string, string, number, string)	Supprimez une pièce jointe de demande de tirage.
deleteComment(string, number, number, number, string)	Supprimez un commentaire associé à un thread spécifique dans une demande de tirage.
deleteEnablementStatus(boolean, boolean, string[])	DELETE supprime l’état d’activation et les données BillableCommitters de la base de données. La suppression des données d’activation le désactive efficacement pour les référentiels affectés.
deleteLike(string, number, number, number, string)	Supprimez une telle option sur un commentaire.
deletePullRequestIterationStatus(string, number, number, number, string)	Supprimez l’état de l’itération de la demande de tirage.
deletePullRequestLabels(string, number, string, string, string)	Supprime une étiquette (balise) de l’ensemble de ceux affectés à la demande de tirage. La balise elle-même ne sera pas supprimée.
deletePullRequestReviewer(string, number, string, string)	Supprimez un réviseur d’une demande de tirage.
deletePullRequestStatus(string, number, number, string)	Supprimez l’état de la demande de tirage.
deleteRefFavorite(string, number)	Supprime le favori refs spécifié
deleteRepository(string, string)	Supprimer un référentiel Git
deleteRepositoryFromRecycleBin(string, string)	Détruire (supprimer en dur) un dépôt Git supprimé de manière réversible.
getAnnotatedTag(string, string, string)	Obtenir une balise annotée.
getAttachmentContent(string, string, number, string)	Obtenez le contenu du fichier d’une pièce jointe de demande de tirage.
getAttachments(string, number, string)	Obtenez la liste des fichiers attachés à une demande de tirage donnée.
getAttachmentZip(string, string, number, string)	Obtenez le contenu du fichier d’une pièce jointe de demande de tirage.
getBillableCommitters(string, Date, number, number)	Récupérez les commiteurs facturables réels pour le service Advanced Security pour une date donnée.
getBillableCommittersDetail(string, string, Date)	Récupérez les commiteurs facturables réels détaillés pour le service Advanced Security pour une date donnée. Les résultats détaillés ne filtrent intentionnellement pas les projets et référentiels supprimés de manière réversible pour diagnostiquer les problèmes de facturation.
getBlob(string, string, string, boolean, string, boolean)	Obtenez un objet blob unique.
getBlobContent(string, string, string, boolean, string, boolean)	Obtenez un objet blob unique.
getBlobsZip(string[], string, string, string)	Obtient un ou plusieurs objets blob dans un téléchargement de fichier zip.
getBlobZip(string, string, string, boolean, string, boolean)	Obtenez un objet blob unique.
getBranch(string, string, string, GitVersionDescriptor)	Récupérer des statistiques sur une branche unique.
getBranches(string, string, GitVersionDescriptor)	Récupérer des statistiques sur toutes les branches d’un référentiel.
getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)	Récupérer des statistiques pour plusieurs validations
getChanges(string, string, string, number, number)	Récupérez les modifications pour une validation particulière.
getCherryPick(string, number, string)	Récupérez des informations sur une opération de sélection de cerise par id de sélection de cerise.
getCherryPickConflict(string, number, number, string)	Récupérer un conflit pour une sélection de cerises par ID
getCherryPickConflicts(string, number, string, string, number, boolean, boolean, boolean)	Récupérer tous les conflits pour une sélection de cerises
getCherryPickForRefName(string, string, string)	Récupérez des informations sur une opération de sélection de cerise pour une branche spécifique. Cette opération est coûteuse en raison de la structure d’objets sous-jacente. Cette API examine uniquement les 1 000 opérations de sélection de cerise les plus récentes.
getCherryPickRelationships(string, string, string, boolean)	En fonction d’un commitId, retourne une liste de validations qui se trouvent dans la même famille de sélection de cerises.
getComment(string, number, number, number, string)	Récupérez un commentaire associé à un thread spécifique dans une demande de tirage.
getComments(string, number, number, string)	Récupérez tous les commentaires associés à un thread spécifique dans une demande de tirage.
getCommit(string, string, string, number)	Récupérez une validation particulière.
getCommitDiffs(string, string, boolean, number, number, GitBaseVersionDescriptor, GitTargetVersionDescriptor)	Recherchez la validation commune la plus proche (la base de fusion) entre les validations de base et de cible et obtenez les différences entre les validations de base et cible ou les validations communes et cibles.
getCommits(string, GitQueryCommitsCriteria, string)	Récupérer des validations Git pour un projet
getCommitsBatch(GitQueryCommitsCriteria, string, string, number, number, boolean)	Récupérer des validations Git pour un projet correspondant aux critères de recherche
getDeletedRepositories(string)	Récupérez les dépôts Git supprimés.
getEnablementStatus(string[], Date, number, number)	État d’activation GET pour les dépôts du projet.
getEnableOnCreateHost(boolean)
getEnableOnCreateProject(string)
getEstimatedBillableCommittersRepo(string, string)	Obtenez les commiteurs facturables estimés pour un dépôt au cours des 90 derniers jours.
getEstimatedBillablePushersOrg()	Obtenez les pushers facturables estimés pour une organisation pendant les 90 derniers jours.
getEstimatedBillablePushersProject(string)	Obtenez les pushers facturables estimés pour un projet pendant les 90 derniers jours.
getFileDiffs(FileDiffsCriteria, string, string)	Obtenir les différences de fichier pour chacun des fichiers spécifiés
getForks(string, string, string, boolean)	Récupérez toutes les duplications d’un référentiel dans la collection.
getForkSyncRequest(string, number, string, boolean)	Obtenez les détails d’une opération de synchronisation de fourche spécifique.
getForkSyncRequests(string, string, boolean, boolean)	Récupérez toutes les opérations de synchronisation de fourche demandées sur ce référentiel.
getHfsItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.
getHfsItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.
getHfsItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Obtenir les métadonnées et/ou le contenu d’un élément pour une collection d’éléments. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.
getHfsItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.
getHfsItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.
getImportRequest(string, string, number)	Récupérer une demande d’importation particulière.
getItem(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.
getItemContent(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.
getItems(string, string, string, VersionControlRecursionType, boolean, boolean, boolean, boolean, GitVersionDescriptor, boolean)	Obtenir les métadonnées et/ou le contenu d’un élément pour une collection d’éléments. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.
getItemsBatch(GitItemRequestData, string, string)	Publier pour récupérer un lot de création d’un ensemble d’éléments dans un dépôt/projet en fonction d’une liste de chemins d’accès ou d’un long chemin d’accès
getItemText(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.
getItemZip(string, string, string, string, VersionControlRecursionType, boolean, boolean, boolean, GitVersionDescriptor, boolean, boolean, boolean)	Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.
getLikes(string, number, number, number, string)	Obtenez des avis pour un commentaire.
getMergeBases(string, string, string, string, string, string)	Recherchez les bases de fusion de deux validations, éventuellement entre les fourches. Si otherRepositoryId n’est pas spécifié, les bases de fusion sont calculées uniquement dans le contexte du repositoryNameOrId local.
getMergeRequest(string, string, number, boolean)	Obtenez les détails d’une opération de fusion spécifique.
getPermission(string, string, string)	État de l’autorisation de sécurité avancée GET.
getPullRequest(string, number, string, number, number, number, boolean, boolean)	Récupérez une demande de tirage( pull request).
getPullRequestById(number, string)	Récupérez une demande de tirage( pull request).
getPullRequestCommits(string, number, string)	Obtenez les validations pour la demande de tirage spécifiée.
getPullRequestConflict(string, number, number, string)	Récupérer un conflit pour une demande de tirage par ID
getPullRequestConflicts(string, number, string, number, number, boolean, boolean, boolean)	Récupérer tous les conflits pour une demande de tirage
getPullRequestIteration(string, number, number, string)	Obtenez l’itération spécifiée pour une demande de tirage.
getPullRequestIterationChanges(string, number, number, string, number, number, number)	Récupérez les modifications apportées dans une demande de tirage entre deux itérations.
getPullRequestIterationCommits(string, number, number, string, number, number)	Obtenez les validations pour l’itération spécifiée d’une demande de tirage.
getPullRequestIterations(string, number, string, boolean)	Obtenez la liste des itérations pour la demande de tirage spécifiée.
getPullRequestIterationStatus(string, number, number, number, string)	Obtenez l’état de l’itération de demande de tirage spécifique par ID. L’ID d’état est unique dans la demande de tirage sur toutes les itérations.
getPullRequestIterationStatuses(string, number, number, string)	Obtenez tous les états associés à une itération de demande de tirage.
getPullRequestLabel(string, number, string, string, string)	Récupère une étiquette unique (balise) qui a été affectée à une demande de tirage.
getPullRequestLabels(string, number, string, string)	Obtenez toutes les étiquettes (étiquettes) affectées à une demande de tirage.
getPullRequestProperties(string, number, string)	Obtenir les propriétés externes de la demande de tirage.
getPullRequestQuery(GitPullRequestQuery, string, string)	Cette API est utilisée pour rechercher les demandes de tirage liées à une validation donnée. Il peut être utilisé pour rechercher la demande de tirage qui a créé une validation de fusion particulière ou pour rechercher toutes les demandes de tirage qui ont jamais fusionné une validation particulière. L’entrée est une liste de requêtes qui contiennent chacune une liste de validations. Pour chaque validation sur laquelle vous effectuez une recherche, vous récupérerez un dictionnaire de validation -> les demandes de tirage.
getPullRequestReviewer(string, number, string, string)	Récupérer des informations sur un réviseur particulier sur une demande de tirage
getPullRequestReviewers(string, number, string)	Récupérer les réviseurs pour une demande de tirage
getPullRequests(string, GitPullRequestSearchCriteria, string, number, number, number)	Récupérez toutes les demandes de tirage correspondant à des critères spécifiés.
getPullRequestsByProject(string, GitPullRequestSearchCriteria, number, number, number)	Récupérez toutes les demandes de tirage correspondant à des critères spécifiés.
getPullRequestStatus(string, number, number, string)	Obtenez l’état de la demande de tirage spécifique par ID. L’ID d’état est unique dans la demande de tirage sur toutes les itérations.
getPullRequestStatuses(string, number, string)	Obtenez tous les états associés à une demande de tirage.
getPullRequestThread(string, number, number, string, number, number)	Récupérez un thread dans une demande de tirage.
getPullRequestWorkItemRefs(string, number, string)	Récupérez une liste d’éléments de travail associés à une demande de tirage.
getPush(string, number, string, number, boolean)	Récupère un push particulier.
getPushCommits(string, number, string, number, number, boolean)	Récupérez une liste de validations associées à un push particulier.
getPushes(string, string, number, number, GitPushSearchCriteria)	Récupère les envois push associés au référentiel spécifié.
getRecycleBinRepositories(string)	Récupérez les dépôts Git supprimés de manière réversible à partir de la corbeille.
getRefFavorite(string, number)	Obtient le favori refs pour un ID favori.
getRefFavorites(string, string, string)	Obtient les favoris refs pour un dépôt et une identité.
getRefFavoritesForProject(string, string)
getRefs(string, string, string, boolean, boolean, boolean, boolean, boolean, string)	Interroge le référentiel fourni pour ses références et les retourne.
getRepositories(string, boolean, boolean, boolean)	Récupérer des référentiels Git.
getRepositoriesPaged(string, boolean, boolean, boolean, string, number, string)	Récupérer des référentiels Git avec un filtre par nom et pagination.
getRepository(string, string)	Récupérez un dépôt Git.
getRepositoryWithParent(string, boolean, string)	Récupérez un dépôt Git.
getRevert(string, number, string)	Récupérez des informations sur une opération de restauration en utilisant l’ID de restauration.
getRevertConflict(string, number, number, string)	Récupérer un conflit pour un rétablissement par ID
getRevertConflicts(string, number, string, string, number, boolean, boolean, boolean)	Récupérer tous les conflits pour un rétablissement
getRevertForRefName(string, string, string)	Récupérez des informations sur une opération de restauration pour une branche spécifique.
getStatuses(string, string, string, number, number, boolean)	Obtenez les états associés à la validation Git.
getSuggestions(string, string, boolean)	Récupérez une suggestion de demande de tirage (pull request) pour un dépôt ou un projet d’équipe particulier.
getThreads(string, number, string, number, number)	Récupérez tous les threads dans une demande de tirage.
getTree(string, string, string, string, boolean, string)	Le point de terminaison Tree retourne la collection d’objets sous l’arborescence spécifiée. Les arborescences sont des dossiers dans un dépôt Git.
getTreeZip(string, string, string, string, boolean, string)	Le point de terminaison Tree retourne la collection d’objets sous l’arborescence spécifiée. Les arborescences sont des dossiers dans un dépôt Git.
queryImportRequests(string, string, boolean)	Récupérez les demandes d’importation d’un référentiel.
restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)	Récupérez un dépôt Git supprimé de manière réversible. Les dépôts récemment supprimés passent à un état de suppression réversible pendant un certain temps avant qu’ils ne soient supprimés en dur et deviennent irrécupérables.
setEnableOnCreateHost(boolean)
setEnableOnCreateProject(string, boolean)
sharePullRequest(ShareNotificationContext, string, number, string)	Envoie une notification par e-mail concernant une demande de tirage spécifique à un ensemble de destinataires
updateCherryPickConflict(GitConflict, string, number, number, string)	Mettre à jour la résolution des conflits de fusion
updateCherryPickConflicts(GitConflict[], string, number, string)	Mettre à jour plusieurs résolutions de conflit de fusion
updateComment(Comment, string, number, number, number, string)	Mettez à jour un commentaire associé à un thread spécifique dans une demande de tirage.
updateEnablementStatus(AdvSecEnablementUpdate[])	État de l’activation POST pour les référentiels.
updateImportRequest(GitImportRequest, string, string, number)	Réessayez ou abandonnez une demande d’importation ayant échoué.
updatePullRequest(GitPullRequest, string, number, string)	Mettre à jour une demande de tirage
updatePullRequestConflict(GitConflict, string, number, number, string)	Mettre à jour la résolution des conflits de fusion
updatePullRequestConflicts(GitConflict[], string, number, string)	Mettre à jour plusieurs résolutions de conflit de fusion
updatePullRequestIterationStatuses(JsonPatchDocument, string, number, number, string)	Mettez à jour la collection d’états d’itération des demandes de tirage. Le seul type d’opération pris en charge est remove.
updatePullRequestProperties(JsonPatchDocument, string, number, string)	Créez ou mettez à jour des propriétés externes de demande de tirage. L’opération de correctif peut être add, replace ou remove. Pour add opération, le chemin d’accès peut être vide. Si le chemin d’accès est vide, la valeur doit être une liste de paires clé-valeur. Pour replace opération, le chemin d’accès ne peut pas être vide. Si le chemin d’accès n’existe pas, la propriété est ajoutée à la collection. Pour remove opération, le chemin d’accès ne peut pas être vide. Si le chemin n’existe pas, aucune action n’est effectuée.
updatePullRequestReviewer(IdentityRefWithVote, string, number, string, string)	Modifiez une entrée de réviseur. Ces champs sont correctives : isFlagged, hasDeclined
updatePullRequestReviewers(IdentityRefWithVote[], string, number, string)	Réinitialisez les votes de plusieurs réviseurs sur une demande de tirage. REMARQUE : ce point de terminaison prend uniquement en charge la mise à jour des votes, mais ne prend pas en charge la mise à jour des réviseurs requis (utiliser la stratégie) ou les noms d’affichage.
updatePullRequestStatuses(JsonPatchDocument, string, number, string)	Mettez à jour la collecte des états des demandes de tirage. Le seul type d’opération pris en charge est remove.
updateRef(GitRefUpdate, string, string, string, string)	Verrouillez ou déverrouillez une branche.
updateRefs(GitRefUpdate[], string, string, string)	Création, mise à jour ou suppression de refs(branches).
updateRepository(GitRepository, string, string)	Met à jour le référentiel Git avec un nouveau nom de dépôt ou une nouvelle branche par défaut.
updateRevertConflict(GitConflict, string, number, number, string)	Mettre à jour la résolution des conflits de fusion
updateRevertConflicts(GitConflict[], string, number, string)	Mettre à jour plusieurs résolutions de conflit de fusion
updateThread(GitPullRequestCommentThread, string, number, number, string)	Mettez à jour un thread dans une demande de tirage.

Détails du constructeur

GitRestClient(IVssRestClientOptions)

new GitRestClient(options: IVssRestClientOptions)

Paramètres

options

IVssRestClientOptions

Détails de la propriété

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Valeur de propriété

string

Détails de la méthode

createAnnotatedTag(GitAnnotatedTag, string, string)

Créez une balise annotée.

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

Paramètres

tagObject

GitAnnotatedTag

Objet contenant les détails de la balise à créer.

project

string

ID de projet ou nom du projet

repositoryId

string

ID ou nom du référentiel.

Retours

Promise<GitAnnotatedTag>

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

Joignez un nouveau fichier à une demande de tirage.

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

Paramètres

content

any

Contenu à charger

fileName

string

Nom du fichier.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<Attachment>

createCherryPick(GitAsyncRefOperationParameters, string, string)

Cherry sélectionne une validation ou des validations spécifiques associées à une demande de tirage dans une nouvelle branche.

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

Paramètres

cherryPickToCreate

GitAsyncRefOperationParameters

project

string

ID de projet ou nom du projet

repositoryId

string

ID du référentiel.

Retours

Promise<GitCherryPick>

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

Créez un commentaire sur un thread spécifique dans une demande de tirage (jusqu’à 500 commentaires peuvent être créés par thread).

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

Paramètres

comment

Comment

Commentaire à créer. Les commentaires peuvent comporter jusqu’à 150 000 caractères.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

threadId

number

ID du thread dans lequel se trouve le commentaire souhaité.

project

string

ID de projet ou nom du projet

Retours

Promise<Comment>

createCommitStatus(GitStatus, string, string, string)

Créez l’état de validation Git.

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

Paramètres

gitCommitStatusToCreate

GitStatus

Objet d’état de validation Git à créer.

commitId

string

ID de la validation Git.

repositoryId

string

ID du référentiel.

project

string

ID de projet ou nom du projet

Retours

Promise<GitStatus>

createFavorite(GitRefFavorite, string)

Crée un favori ref

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

Paramètres

favorite

GitRefFavorite

Favori ref à créer.

project

string

ID de projet ou nom du projet

Retours

Promise<GitRefFavorite>

createForkSyncRequest(GitForkSyncRequestParameters, string, string, boolean)

Demandez que les références d’un autre référentiel soient extraites dans celle-ci. Il synchronise deux duplications existantes. Pour créer une duplication, consultez le <unhttps://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"href=" ; point de terminaison de référentiels></a>

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

Paramètres

syncParams

GitForkSyncRequestParameters

Référentiel source et mappage ref.

repositoryNameOrId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

includeLinks

boolean

True pour inclure des liens

Retours

Promise<GitForkSyncRequest>

createImportRequest(GitImportRequest, string, string)

Créez une demande d’importation.

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

Paramètres

importRequest

GitImportRequest

Demande d’importation à créer.

project

string

ID de projet ou nom du projet

repositoryId

string

Nom ou ID du référentiel.

Retours

Promise<GitImportRequest>

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

Ajoutez une telle option sur un commentaire.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

threadId

number

ID du thread qui contient le commentaire.

commentId

number

ID du commentaire.

project

string

ID de projet ou nom du projet

Retours

Promise<void>

createMergeRequest(GitMergeParameters, string, string, boolean)

Demandez une opération de fusion Git. Actuellement, nous prenons en charge la fusion de 2 validations uniquement.

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

Paramètres

mergeParameters

GitMergeParameters

Les commitIds parents et les erreurs de validation de fusion.

project

string

ID de projet ou nom du projet

repositoryNameOrId

string

Nom ou ID du référentiel.

includeLinks

boolean

True pour inclure des liens

Retours

Promise<GitMerge>

createPullRequest(GitPullRequest, string, string, boolean)

Créez une demande de tirage ( pull request).

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

Paramètres

gitPullRequestToCreate

GitPullRequest

Demande de tirage à créer.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

project

string

ID de projet ou nom du projet

supportsIterations

boolean

Si la valeur est true, les envois push suivants à la demande de tirage sont individuellement modifiables. Définissez cette valeur sur false pour les demandes de tirage volumineuses pour des raisons de performances si cette fonctionnalité n’est pas nécessaire.

Retours

Promise<GitPullRequest>

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

Créez un état de demande de tirage (pull request) sur l’itération. Cette opération aura le même résultat que Créer l’état sur la demande de tirage avec l’ID d’itération spécifié dans le corps de la requête.

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

Paramètres

status

GitPullRequestStatus

État de la demande de tirage à créer.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

iterationId

number

ID de l’itération de demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequestStatus>

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

Créez une balise (s’il n’existe pas encore) et ajoutez-la en tant qu’étiquette (balise) pour une demande de tirage spécifiée. Le seul champ obligatoire est le nom de la nouvelle étiquette (balise).

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

Paramètres

label

WebApiCreateTagRequestData

Étiquette à affecter à la demande de tirage.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

projectId

string

ID de projet ou nom du projet.

Retours

Promise<WebApiTagDefinition>

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

Ajoutez un réviseur à une demande de tirage ou effectuez un vote.

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

Paramètres

reviewer

IdentityRefWithVote

Vote du réviseur.<br />Si l’ID du réviseur est inclus ici, il doit correspondre au paramètre reviewerID.<br />Réviseurs peuvent définir leur propre vote avec cette méthode. Lors de l’ajout d’autres réviseurs, le vote doit être défini sur zéro.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

reviewerId

string

ID du réviseur.

project

string

ID de projet ou nom du projet

Retours

Promise<IdentityRefWithVote>

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

Ajoutez des réviseurs à une demande de tirage( pull request).

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

Paramètres

reviewers

IdentityRef[]

Réviseurs à ajouter à la demande de tirage.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<IdentityRefWithVote[]>

createPullRequestStatus(GitPullRequestStatus, string, number, string)

Créez un état de demande de tirage( pull request).

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

Paramètres

status

GitPullRequestStatus

État de la demande de tirage à créer.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequestStatus>

createPush(GitPush, string, string)

Envoyer (push) les modifications au référentiel.

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

Paramètres

push

GitPush

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPush>

createRepository(GitRepositoryCreateOptions, string, string)

Créez un dépôt Git dans un projet d’équipe.

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

Paramètres

gitRepositoryToCreate

GitRepositoryCreateOptions

Spécifiez le nom du dépôt, le projet d’équipe et/ou le référentiel parent. Les informations du projet d’équipe peuvent être omises à partir de gitRepositoryToCreate si la demande est délimitée par le projet (par exemple, inclut l’ID de projet).

project

string

ID de projet ou nom du projet

sourceRef

string

[facultatif] Spécifier les références sources à utiliser lors de la création d’un dépôt de duplication

Retours

Promise<GitRepository>

createRevert(GitAsyncRefOperationParameters, string, string)

Démarre l’opération pour créer une branche qui rétablit les modifications introduites par une validation ou des validations spécifiques associées à une demande de tirage.

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

Paramètres

revertToCreate

GitAsyncRefOperationParameters

project

string

ID de projet ou nom du projet

repositoryId

string

ID du référentiel.

Retours

Promise<GitRevert>

createThread(GitPullRequestCommentThread, string, number, string)

Créez un thread dans une demande de tirage.

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

Paramètres

commentThread

GitPullRequestCommentThread

Thread à créer. Le thread doit contenir au moins un commentaire.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequestCommentThread>

createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string, number, string)

Ajoutez une identité non matérialisée aux réviseurs d’une demande de tirage.

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

Paramètres

reviewer

IdentityRefWithVote

Réviseur à ajouter à la demande de tirage.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<IdentityRefWithVote>

deleteAttachment(string, string, number, string)

Supprimez une pièce jointe de demande de tirage.

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

Paramètres

fileName

string

Nom de la pièce jointe à supprimer.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<void>

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

Supprimez un commentaire associé à un thread spécifique dans une demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

threadId

number

ID du thread dans lequel se trouve le commentaire souhaité.

commentId

number

ID du commentaire.

project

string

ID de projet ou nom du projet

Retours

Promise<void>

deleteEnablementStatus(boolean, boolean, string[])

DELETE supprime l’état d’activation et les données BillableCommitters de la base de données. La suppression des données d’activation le désactive efficacement pour les référentiels affectés.

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

Paramètres

allProjects

boolean

includeBillableCommitters

boolean

projectIds

string[]

Retours

Promise<void>

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

Supprimez une telle option sur un commentaire.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

threadId

number

ID du thread qui contient le commentaire.

commentId

number

ID du commentaire.

project

string

ID de projet ou nom du projet

Retours

Promise<void>

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

Supprimez l’état de l’itération de la demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

iterationId

number

ID de l’itération de demande de tirage.

statusId

number

ID de l’état de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<void>

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

Supprime une étiquette (balise) de l’ensemble de ceux affectés à la demande de tirage. La balise elle-même ne sera pas supprimée.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

labelIdOrName

string

Nom ou ID de l’étiquette demandée.

project

string

ID de projet ou nom du projet

projectId

string

ID de projet ou nom du projet.

Retours

Promise<void>

deletePullRequestReviewer(string, number, string, string)

Supprimez un réviseur d’une demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

reviewerId

string

ID du réviseur à supprimer.

project

string

ID de projet ou nom du projet

Retours

Promise<void>

deletePullRequestStatus(string, number, number, string)

Supprimez l’état de la demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

statusId

number

ID de l’état de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<void>

deleteRefFavorite(string, number)

Supprime le favori refs spécifié

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

Paramètres

project

string

ID de projet ou nom du projet

favoriteId

number

ID du favori ref à supprimer.

Retours

Promise<void>

deleteRepository(string, string)

Supprimer un référentiel Git

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

Paramètres

repositoryId

string

ID du référentiel.

project

string

ID de projet ou nom du projet

Retours

Promise<void>

deleteRepositoryFromRecycleBin(string, string)

Détruire (supprimer en dur) un dépôt Git supprimé de manière réversible.

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

Paramètres

project

string

ID de projet ou nom du projet

repositoryId

string

ID du référentiel.

Retours

Promise<void>

getAnnotatedTag(string, string, string)

Obtenir une balise annotée.

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

Paramètres

project

string

ID de projet ou nom du projet

repositoryId

string

ID ou nom du référentiel.

objectId

string

ObjectId (Sha1Id) de balise à obtenir.

Retours

Promise<GitAnnotatedTag>

getAttachmentContent(string, string, number, string)

Obtenez le contenu du fichier d’une pièce jointe de demande de tirage.

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

Paramètres

fileName

string

Nom de la pièce jointe.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<ArrayBuffer>

getAttachments(string, number, string)

Obtenez la liste des fichiers attachés à une demande de tirage donnée.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<Attachment[]>

getAttachmentZip(string, string, number, string)

Obtenez le contenu du fichier d’une pièce jointe de demande de tirage.

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

Paramètres

fileName

string

Nom de la pièce jointe.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<ArrayBuffer>

getBillableCommitters(string, Date, number, number)

Récupérez les commiteurs facturables réels pour le service Advanced Security pour une date donnée.

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

Paramètres

project

string

ID de projet ou nom du projet

billingDate

Date

UTC attendu. S’il n’est pas spécifié par défaut le jour de facturation précédent.

skip

number

Ignorez les lignes X du jeu de résultats pour simuler la pagination.

take

number

Retournez les lignes Y du jeu de résultats pour simuler la pagination.

Retours

Promise<BillableCommitter[]>

getBillableCommittersDetail(string, string, Date)

Récupérez les commiteurs facturables réels détaillés pour le service Advanced Security pour une date donnée. Les résultats détaillés ne filtrent intentionnellement pas les projets et référentiels supprimés de manière réversible pour diagnostiquer les problèmes de facturation.

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

Paramètres

project

string

ID de projet ou nom du projet

includeDetails

string

Retournez tous les détails des commiteurs facturables.

billingDate

Date

UTC attendu. S’il n’est pas spécifié par défaut le jour de facturation précédent.

Retours

Promise<BillableCommitterDetail[]>

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

Obtenez un objet blob unique.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

sha1

string

Hachage SHA1 du fichier. Vous pouvez obtenir sha1 d’un fichier à l’aide du point de terminaison « Git/Items/Get Item ».

project

string

ID de projet ou nom du projet

download

boolean

Si la valeur est true, invitez un téléchargement plutôt qu’un rendu dans un navigateur. Remarque : cette valeur a la valeur true si $format est zip

fileName

string

Fournissez un fileName à utiliser pour un téléchargement.

resolveLfs

boolean

Si la valeur est true, essayez de résoudre un objet blob en son contenu LFS, s’il s’agit d’un fichier de pointeur LFS. Compatible uniquement avec les en-têtes Accept d’octets ou les types d'$format

Retours

Promise<GitBlobRef>

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

Obtenez un objet blob unique.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

sha1

string

Hachage SHA1 du fichier. Vous pouvez obtenir sha1 d’un fichier à l’aide du point de terminaison « Git/Items/Get Item ».

project

string

ID de projet ou nom du projet

download

boolean

Si la valeur est true, invitez un téléchargement plutôt qu’un rendu dans un navigateur. Remarque : cette valeur a la valeur true si $format est zip

fileName

string

Fournissez un fileName à utiliser pour un téléchargement.

resolveLfs

boolean

Si la valeur est true, essayez de résoudre un objet blob en son contenu LFS, s’il s’agit d’un fichier de pointeur LFS. Compatible uniquement avec les en-têtes Accept d’octets ou les types d'$format

Retours

Promise<ArrayBuffer>

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

Obtient un ou plusieurs objets blob dans un téléchargement de fichier zip.

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

Paramètres

blobIds

string[]

ID d’objet blob (hachages SHA1) à retourner dans le fichier zip.

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

filename

string

Retours

Promise<ArrayBuffer>

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

Obtenez un objet blob unique.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

sha1

string

Hachage SHA1 du fichier. Vous pouvez obtenir sha1 d’un fichier à l’aide du point de terminaison « Git/Items/Get Item ».

project

string

ID de projet ou nom du projet

download

boolean

Si la valeur est true, invitez un téléchargement plutôt qu’un rendu dans un navigateur. Remarque : cette valeur a la valeur true si $format est zip

fileName

string

Fournissez un fileName à utiliser pour un téléchargement.

resolveLfs

boolean

Si la valeur est true, essayez de résoudre un objet blob en son contenu LFS, s’il s’agit d’un fichier de pointeur LFS. Compatible uniquement avec les en-têtes Accept d’octets ou les types d'$format

Retours

Promise<ArrayBuffer>

getBranch(string, string, string, GitVersionDescriptor)

Récupérer des statistiques sur une branche unique.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

name

string

Nom de la branche.

project

string

ID de projet ou nom du projet

baseVersionDescriptor

GitVersionDescriptor

Identifie la validation ou la branche à utiliser comme base.

Retours

Promise<GitBranchStats>

getBranches(string, string, GitVersionDescriptor)

Récupérer des statistiques sur toutes les branches d’un référentiel.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

baseVersionDescriptor

GitVersionDescriptor

Identifie la validation ou la branche à utiliser comme base.

Retours

Promise<GitBranchStats[]>

getBranchStatsBatch(GitQueryBranchStatsCriteria, string, string)

Récupérer des statistiques pour plusieurs validations

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

Paramètres

searchCriteria

GitQueryBranchStatsCriteria

Validation de base et liste des validations cibles à comparer.

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

Retours

Promise<GitBranchStats[]>

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

Récupérez les modifications pour une validation particulière.

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

Paramètres

commitId

string

ID de la validation.

repositoryId

string

Id ou nom convivial du référentiel. Pour utiliser le nom convivial, projectId doit également être spécifié.

project

string

ID de projet ou nom du projet

top

number

Nombre maximal de modifications à retourner.

skip

number

Nombre de modifications à ignorer.

Retours

Promise<GitCommitChanges>

getCherryPick(string, number, string)

Récupérez des informations sur une opération de sélection de cerise par id de sélection de cerise.

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

Paramètres

project

string

ID de projet ou nom du projet

cherryPickId

number

ID de la sélection de cerise.

repositoryId

string

ID du référentiel.

Retours

Promise<GitCherryPick>

getCherryPickConflict(string, number, number, string)

Récupérer un conflit pour une sélection de cerises par ID

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

Paramètres

repositoryId

string

cherryPickId

number

conflictId

number

project

string

ID de projet ou nom du projet

Retours

Promise<GitConflict>

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

Récupérer tous les conflits pour une sélection de cerises

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

Paramètres

repositoryId

string

cherryPickId

number

project

string

ID de projet ou nom du projet

continuationToken

string

top

number

excludeResolved

boolean

onlyResolved

boolean

includeObsolete

boolean

Retours

Promise<PagedList<GitConflict>>

getCherryPickForRefName(string, string, string)

Récupérez des informations sur une opération de sélection de cerise pour une branche spécifique. Cette opération est coûteuse en raison de la structure d’objets sous-jacente. Cette API examine uniquement les 1 000 opérations de sélection de cerise les plus récentes.

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

Paramètres

project

string

ID de projet ou nom du projet

repositoryId

string

ID du référentiel.

refName

string

GitAsyncRefOperationParameters generatedRefName utilisé pour l’opération de sélection de cerises.

Retours

Promise<GitCherryPick>

getCherryPickRelationships(string, string, string, boolean)

En fonction d’un commitId, retourne une liste de validations qui se trouvent dans la même famille de sélection de cerises.

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

Paramètres

repositoryNameOrId

string

commitId

string

project

string

ID de projet ou nom du projet

includeLinks

boolean

Retours

Promise<GitCommitRef[]>

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

Récupérez un commentaire associé à un thread spécifique dans une demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

threadId

number

ID du thread dans lequel se trouve le commentaire souhaité.

commentId

number

ID du commentaire.

project

string

ID de projet ou nom du projet

Retours

Promise<Comment>

getComments(string, number, number, string)

Récupérez tous les commentaires associés à un thread spécifique dans une demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

threadId

number

ID du thread.

project

string

ID de projet ou nom du projet

Retours

Promise<Comment[]>

getCommit(string, string, string, number)

Récupérez une validation particulière.

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

Paramètres

commitId

string

ID de la validation.

repositoryId

string

Id ou nom convivial du référentiel. Pour utiliser le nom convivial, projectId doit également être spécifié.

project

string

ID de projet ou nom du projet

changeCount

number

Nombre de modifications à inclure dans le résultat.

Retours

Promise<GitCommit>

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

Recherchez la validation commune la plus proche (la base de fusion) entre les validations de base et de cible et obtenez les différences entre les validations de base et cible ou les validations communes et cibles.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

diffCommonCommit

boolean

Si la valeur est true, différences entre les validations courantes et cibles. Si la valeur est false, différences entre les validations de base et de cible.

top

number

Nombre maximal de modifications à retourner. La valeur par défaut est 100.

skip

number

Nombre de modifications à ignorer

baseVersionDescriptor

GitBaseVersionDescriptor

Descripteur pour la validation de base.

targetVersionDescriptor

GitTargetVersionDescriptor

Descripteur pour la validation cible.

Retours

Promise<GitCommitDiffs>

getCommits(string, GitQueryCommitsCriteria, string)

Récupérer des validations Git pour un projet

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

Paramètres

repositoryId

string

Id ou nom convivial du référentiel. Pour utiliser le nom convivial, projectId doit également être spécifié.

searchCriteria

GitQueryCommitsCriteria

project

string

ID de projet ou nom du projet

Retours

Promise<GitCommitRef[]>

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

Récupérer des validations Git pour un projet correspondant aux critères de recherche

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

Paramètres

searchCriteria

GitQueryCommitsCriteria

Options de recherche

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

skip

number

Nombre de validations à ignorer. La valeur ne peut pas dépasser 3 000 000.

top

number

Nombre maximal de validations à retourner. La valeur ne peut pas dépasser 50 000.

includeStatuses

boolean

True pour inclure des informations d’état de validation supplémentaires.

Retours

Promise<GitCommitRef[]>

getDeletedRepositories(string)

Récupérez les dépôts Git supprimés.

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

Paramètres

project

string

ID de projet ou nom du projet

Retours

Promise<GitDeletedRepository[]>

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

État d’activation GET pour les dépôts du projet.

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

Paramètres

projectIds

string[]

Null par défaut pour tous les projets dans l’hôte, liste de l’état des dépôts du projet à retourner

billingDate

Date

Les valeurs UTC attendues, Null par défaut utcNow(), peuvent être fournies pour un point dans le temps

skip

number

Ignorez les lignes X du jeu de résultats pour simuler la pagination.

take

number

Retournez les lignes Y du jeu de résultats pour simuler la pagination.

Retours

Promise<AdvSecEnablementStatus[]>

getEnableOnCreateHost(boolean)

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

Paramètres

enableOnCreateHost

boolean

Retours

Promise<boolean>

getEnableOnCreateProject(string)

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

Paramètres

enableOnCreateProjectId

string

Retours

Promise<boolean>

getEstimatedBillableCommittersRepo(string, string)

Obtenez les commiteurs facturables estimés pour un dépôt au cours des 90 derniers jours.

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

Paramètres

project

string

ID de projet ou nom du projet

repositoryId

string

Retours

Promise<BillableCommitter[]>

getEstimatedBillablePushersOrg()

Obtenez les pushers facturables estimés pour une organisation pendant les 90 derniers jours.

function getEstimatedBillablePushersOrg(): Promise<BillablePusher[]>

Retours

Promise<BillablePusher[]>

getEstimatedBillablePushersProject(string)

Obtenez les pushers facturables estimés pour un projet pendant les 90 derniers jours.

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

Paramètres

project

string

ID de projet ou nom du projet

Retours

Promise<BillablePusher[]>

getFileDiffs(FileDiffsCriteria, string, string)

Obtenir les différences de fichier pour chacun des fichiers spécifiés

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

Paramètres

fileDiffsCriteria

FileDiffsCriteria

Liste des objets de paramètres de fichier

project

string

ID de projet ou nom du projet

repositoryId

string

Nom ou ID du référentiel

Retours

Promise<FileDiff[]>

getForks(string, string, string, boolean)

Récupérez toutes les duplications d’un référentiel dans la collection.

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

Paramètres

repositoryNameOrId

string

Nom ou ID du référentiel.

collectionId

string

ID de collection de projets d’équipe.

project

string

ID de projet ou nom du projet

includeLinks

boolean

True pour inclure des liens.

Retours

Promise<GitRepositoryRef[]>

getForkSyncRequest(string, number, string, boolean)

Obtenez les détails d’une opération de synchronisation de fourche spécifique.

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

Paramètres

repositoryNameOrId

string

Nom ou ID du référentiel.

forkSyncOperationId

number

OperationId de la demande de synchronisation.

project

string

ID de projet ou nom du projet

includeLinks

boolean

True pour inclure des liens.

Retours

Promise<GitForkSyncRequest>

getForkSyncRequests(string, string, boolean, boolean)

Récupérez toutes les opérations de synchronisation de fourche demandées sur ce référentiel.

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

Paramètres

repositoryNameOrId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

includeAbandoned

boolean

True pour inclure les demandes abandonnées.

includeLinks

boolean

True pour inclure des liens.

Retours

Promise<GitForkSyncRequest[]>

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

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.

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>

Paramètres

repositoryId

string

Nom ou ID du référentiel.

path

string

Chemin d’accès de l’élément.

project

string

ID de projet ou nom du projet

scopePath

string

Étendue du chemin d’accès. La valeur par défaut est Null.

recursionLevel

VersionControlRecursionType

Niveau de récursivité de cette requête. La valeur par défaut est « none », aucune récursivité.

includeContentMetadata

boolean

Définissez la valeur true pour inclure les métadonnées de contenu. La valeur par défaut est false.

latestProcessedChange

boolean

Définissez la valeur true pour inclure les dernières modifications. La valeur par défaut est false.

download

boolean

Définissez la valeur true pour télécharger la réponse en tant que fichier. La valeur par défaut est false.

versionDescriptor

GitVersionDescriptor

Descripteur de version. La branche par défaut du référentiel est la branche par défaut.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

resolveHfs

boolean

Définissez la valeur true pour résoudre les fichiers de pointeur GIT HFS pour retourner le contenu réel à partir de Git HFS. La valeur par défaut est true.

sanitize

boolean

Définissez la valeur true pour nettoyer un fichier svg et le renvoyer en tant qu’image. Utile uniquement si demandé pour le fichier svg. La valeur par défaut est false.

Retours

Promise<GitItem>

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

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.

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>

Paramètres

repositoryId

string

Nom ou ID du référentiel.

path

string

Chemin d’accès de l’élément.

project

string

ID de projet ou nom du projet

scopePath

string

Étendue du chemin d’accès. La valeur par défaut est Null.

recursionLevel

VersionControlRecursionType

Niveau de récursivité de cette requête. La valeur par défaut est « none », aucune récursivité.

includeContentMetadata

boolean

Définissez la valeur true pour inclure les métadonnées de contenu. La valeur par défaut est false.

latestProcessedChange

boolean

Définissez la valeur true pour inclure les dernières modifications. La valeur par défaut est false.

download

boolean

Définissez la valeur true pour télécharger la réponse en tant que fichier. La valeur par défaut est false.

versionDescriptor

GitVersionDescriptor

Descripteur de version. La branche par défaut du référentiel est la branche par défaut.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

resolveHfs

boolean

Définissez la valeur true pour résoudre les fichiers de pointeur GIT HFS pour retourner le contenu réel à partir de Git HFS. La valeur par défaut est true.

sanitize

boolean

Définissez la valeur true pour nettoyer un fichier svg et le renvoyer en tant qu’image. Utile uniquement si demandé pour le fichier svg. La valeur par défaut est false.

Retours

Promise<ArrayBuffer>

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

Obtenir les métadonnées et/ou le contenu d’un élément pour une collection d’éléments. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

scopePath

string

Étendue du chemin d’accès. La valeur par défaut est Null.

recursionLevel

VersionControlRecursionType

Niveau de récursivité de cette requête. La valeur par défaut est « none », aucune récursivité.

includeContentMetadata

boolean

Définissez la valeur true pour inclure les métadonnées de contenu. La valeur par défaut est false.

latestProcessedChange

boolean

Définissez la valeur true pour inclure les dernières modifications. La valeur par défaut est false.

download

boolean

Définissez la valeur true pour télécharger la réponse en tant que fichier. La valeur par défaut est false.

includeLinks

boolean

Définissez la valeur true pour inclure des liens vers des éléments. La valeur par défaut est false.

versionDescriptor

GitVersionDescriptor

Descripteur de version. La branche par défaut du référentiel est la branche par défaut.

zipForUnix

boolean

Défini sur true pour conserver les autorisations de fichier pour les systèmes UNIX (et POSIX), tels que les exécutables et les liens symboliques

Retours

Promise<GitItem[]>

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

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.

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>

Paramètres

repositoryId

string

Nom ou ID du référentiel.

path

string

Chemin d’accès de l’élément.

project

string

ID de projet ou nom du projet

scopePath

string

Étendue du chemin d’accès. La valeur par défaut est Null.

recursionLevel

VersionControlRecursionType

Niveau de récursivité de cette requête. La valeur par défaut est « none », aucune récursivité.

includeContentMetadata

boolean

Définissez la valeur true pour inclure les métadonnées de contenu. La valeur par défaut est false.

latestProcessedChange

boolean

Définissez la valeur true pour inclure les dernières modifications. La valeur par défaut est false.

download

boolean

Définissez la valeur true pour télécharger la réponse en tant que fichier. La valeur par défaut est false.

versionDescriptor

GitVersionDescriptor

Descripteur de version. La branche par défaut du référentiel est la branche par défaut.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

resolveHfs

boolean

Définissez la valeur true pour résoudre les fichiers de pointeur GIT HFS pour retourner le contenu réel à partir de Git HFS. La valeur par défaut est true.

sanitize

boolean

Définissez la valeur true pour nettoyer un fichier svg et le renvoyer en tant qu’image. Utile uniquement si demandé pour le fichier svg. La valeur par défaut est false.

Retours

Promise<string>

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

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.

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>

Paramètres

repositoryId

string

Nom ou ID du référentiel.

path

string

Chemin d’accès de l’élément.

project

string

ID de projet ou nom du projet

scopePath

string

Étendue du chemin d’accès. La valeur par défaut est Null.

recursionLevel

VersionControlRecursionType

Niveau de récursivité de cette requête. La valeur par défaut est « none », aucune récursivité.

includeContentMetadata

boolean

Définissez la valeur true pour inclure les métadonnées de contenu. La valeur par défaut est false.

latestProcessedChange

boolean

Définissez la valeur true pour inclure les dernières modifications. La valeur par défaut est false.

download

boolean

Définissez la valeur true pour télécharger la réponse en tant que fichier. La valeur par défaut est false.

versionDescriptor

GitVersionDescriptor

Descripteur de version. La branche par défaut du référentiel est la branche par défaut.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

resolveHfs

boolean

Définissez la valeur true pour résoudre les fichiers de pointeur GIT HFS pour retourner le contenu réel à partir de Git HFS. La valeur par défaut est true.

sanitize

boolean

Définissez la valeur true pour nettoyer un fichier svg et le renvoyer en tant qu’image. Utile uniquement si demandé pour le fichier svg. La valeur par défaut est false.

Retours

Promise<ArrayBuffer>

getImportRequest(string, string, number)

Récupérer une demande d’importation particulière.

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

Paramètres

project

string

ID de projet ou nom du projet

repositoryId

string

Nom ou ID du référentiel.

importRequestId

number

Identificateur unique de la demande d’importation.

Retours

Promise<GitImportRequest>

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

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.

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>

Paramètres

repositoryId

string

Nom ou ID du référentiel.

path

string

Chemin d’accès de l’élément.

project

string

ID de projet ou nom du projet

scopePath

string

Étendue du chemin d’accès. La valeur par défaut est Null.

recursionLevel

VersionControlRecursionType

Niveau de récursivité de cette requête. La valeur par défaut est « none », aucune récursivité.

includeContentMetadata

boolean

Définissez la valeur true pour inclure les métadonnées de contenu. La valeur par défaut est false.

latestProcessedChange

boolean

Définissez la valeur true pour inclure les dernières modifications. La valeur par défaut est false.

download

boolean

Définissez la valeur true pour télécharger la réponse en tant que fichier. La valeur par défaut est false.

versionDescriptor

GitVersionDescriptor

Descripteur de version. La branche par défaut du référentiel est la branche par défaut.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

resolveLfs

boolean

Définissez la valeur true pour résoudre les fichiers de pointeur Git LFS pour retourner le contenu réel à partir de Git LFS. La valeur par défaut est false.

sanitize

boolean

Définissez la valeur true pour nettoyer un fichier svg et le renvoyer en tant qu’image. Utile uniquement si demandé pour le fichier svg. La valeur par défaut est false.

Retours

Promise<GitItem>

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

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.

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>

Paramètres

repositoryId

string

Nom ou ID du référentiel.

path

string

Chemin d’accès de l’élément.

project

string

ID de projet ou nom du projet

scopePath

string

Étendue du chemin d’accès. La valeur par défaut est Null.

recursionLevel

VersionControlRecursionType

Niveau de récursivité de cette requête. La valeur par défaut est « none », aucune récursivité.

includeContentMetadata

boolean

Définissez la valeur true pour inclure les métadonnées de contenu. La valeur par défaut est false.

latestProcessedChange

boolean

Définissez la valeur true pour inclure les dernières modifications. La valeur par défaut est false.

download

boolean

Définissez la valeur true pour télécharger la réponse en tant que fichier. La valeur par défaut est false.

versionDescriptor

GitVersionDescriptor

Descripteur de version. La branche par défaut du référentiel est la branche par défaut.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

resolveLfs

boolean

Définissez la valeur true pour résoudre les fichiers de pointeur Git LFS pour retourner le contenu réel à partir de Git LFS. La valeur par défaut est false.

sanitize

boolean

Définissez la valeur true pour nettoyer un fichier svg et le renvoyer en tant qu’image. Utile uniquement si demandé pour le fichier svg. La valeur par défaut est false.

Retours

Promise<ArrayBuffer>

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

Obtenir les métadonnées et/ou le contenu d’un élément pour une collection d’éléments. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé qui est toujours retourné en tant que téléchargement.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

scopePath

string

Étendue du chemin d’accès. La valeur par défaut est Null.

recursionLevel

VersionControlRecursionType

Niveau de récursivité de cette requête. La valeur par défaut est « none », aucune récursivité.

includeContentMetadata

boolean

Définissez la valeur true pour inclure les métadonnées de contenu. La valeur par défaut est false.

latestProcessedChange

boolean

Définissez la valeur true pour inclure les dernières modifications. La valeur par défaut est false.

download

boolean

Définissez la valeur true pour télécharger la réponse en tant que fichier. La valeur par défaut est false.

includeLinks

boolean

Définissez la valeur true pour inclure des liens vers des éléments. La valeur par défaut est false.

versionDescriptor

GitVersionDescriptor

Descripteur de version. La branche par défaut du référentiel est la branche par défaut.

zipForUnix

boolean

Défini sur true pour conserver les autorisations de fichier pour les systèmes UNIX (et POSIX), tels que les exécutables et les liens symboliques

Retours

Promise<GitItem[]>

getItemsBatch(GitItemRequestData, string, string)

Publier pour récupérer un lot de création d’un ensemble d’éléments dans un dépôt/projet en fonction d’une liste de chemins d’accès ou d’un long chemin d’accès

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

Paramètres

requestData

GitItemRequestData

Attributs de données de requête : ItemDescriptors, IncludeContentMetadata, LatestProcessedChange, IncludeLinks. ItemDescriptors : Collection d’éléments à extraire, y compris le chemin, la version et le niveau de récursivité. IncludeContentMetadata : indique s’il faut inclure des métadonnées pour tous les éléments LatestProcessedChange : indique s’il faut inclure une ref superficielle pour valider cette dernière modification de chaque élément. IncludeLinks : indique s’il faut inclure le champ _links sur les références superficielles.

repositoryId

string

Nom ou ID du référentiel

project

string

ID de projet ou nom du projet

Retours

Promise<GitItem[][]>

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

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.

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>

Paramètres

repositoryId

string

Nom ou ID du référentiel.

path

string

Chemin d’accès de l’élément.

project

string

ID de projet ou nom du projet

scopePath

string

Étendue du chemin d’accès. La valeur par défaut est Null.

recursionLevel

VersionControlRecursionType

Niveau de récursivité de cette requête. La valeur par défaut est « none », aucune récursivité.

includeContentMetadata

boolean

Définissez la valeur true pour inclure les métadonnées de contenu. La valeur par défaut est false.

latestProcessedChange

boolean

Définissez la valeur true pour inclure les dernières modifications. La valeur par défaut est false.

download

boolean

Définissez la valeur true pour télécharger la réponse en tant que fichier. La valeur par défaut est false.

versionDescriptor

GitVersionDescriptor

Descripteur de version. La branche par défaut du référentiel est la branche par défaut.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

resolveLfs

boolean

Définissez la valeur true pour résoudre les fichiers de pointeur Git LFS pour retourner le contenu réel à partir de Git LFS. La valeur par défaut est false.

sanitize

boolean

Définissez la valeur true pour nettoyer un fichier svg et le renvoyer en tant qu’image. Utile uniquement si demandé pour le fichier svg. La valeur par défaut est false.

Retours

Promise<string>

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

Obtenir les métadonnées et/ou le contenu de l’élément pour un seul élément. Le paramètre de téléchargement consiste à indiquer si le contenu doit être disponible en tant que téléchargement ou simplement envoyé en tant que flux dans la réponse. Ne s’applique pas au contenu compressé, qui est toujours retourné en tant que téléchargement.

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>

Paramètres

repositoryId

string

Nom ou ID du référentiel.

path

string

Chemin d’accès de l’élément.

project

string

ID de projet ou nom du projet

scopePath

string

Étendue du chemin d’accès. La valeur par défaut est Null.

recursionLevel

VersionControlRecursionType

Niveau de récursivité de cette requête. La valeur par défaut est « none », aucune récursivité.

includeContentMetadata

boolean

Définissez la valeur true pour inclure les métadonnées de contenu. La valeur par défaut est false.

latestProcessedChange

boolean

Définissez la valeur true pour inclure les dernières modifications. La valeur par défaut est false.

download

boolean

Définissez la valeur true pour télécharger la réponse en tant que fichier. La valeur par défaut est false.

versionDescriptor

GitVersionDescriptor

Descripteur de version. La branche par défaut du référentiel est la branche par défaut.

includeContent

boolean

Définissez la valeur true pour inclure le contenu de l’élément lors de la demande de json. La valeur par défaut est false.

resolveLfs

boolean

Définissez la valeur true pour résoudre les fichiers de pointeur Git LFS pour retourner le contenu réel à partir de Git LFS. La valeur par défaut est false.

sanitize

boolean

Définissez la valeur true pour nettoyer un fichier svg et le renvoyer en tant qu’image. Utile uniquement si demandé pour le fichier svg. La valeur par défaut est false.

Retours

Promise<ArrayBuffer>

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

Obtenez des avis pour un commentaire.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

threadId

number

ID du thread qui contient le commentaire.

commentId

number

ID du commentaire.

project

string

ID de projet ou nom du projet

Retours

Promise<IdentityRef[]>

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

Recherchez les bases de fusion de deux validations, éventuellement entre les fourches. Si otherRepositoryId n’est pas spécifié, les bases de fusion sont calculées uniquement dans le contexte du repositoryNameOrId local.

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

Paramètres

repositoryNameOrId

string

ID ou nom du référentiel local.

commitId

string

Tout d’abord, la pointe de la branche cible de la fusion potentielle.

otherCommitId

string

Autre validation, généralement la pointe de la branche source de la fusion potentielle.

project

string

ID de projet ou nom du projet

otherCollectionId

string

ID de collection où se trouve otherCommitId.

otherRepositoryId

string

ID de référentiel où se trouve otherCommitId.

Retours

Promise<GitCommitRef[]>

getMergeRequest(string, string, number, boolean)

Obtenez les détails d’une opération de fusion spécifique.

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

Paramètres

project

string

ID de projet ou nom du projet

repositoryNameOrId

string

Nom ou ID du référentiel.

mergeOperationId

number

OperationId de la demande de fusion.

includeLinks

boolean

True pour inclure des liens

Retours

Promise<GitMerge>

getPermission(string, string, string)

État de l’autorisation de sécurité avancée GET.

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

Paramètres

projectName

string

repositoryId

string

L’utilisateur du référentiel tente d’accéder à

permission

string

L’autorisation demandée doit être « viewAlert » « dismissAlert » « manage » « viewEnablement » ou « repoRead »

Retours

Promise<boolean>

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

Récupérez une demande de tirage( pull request).

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage à récupérer.

project

string

ID de projet ou nom du projet

maxCommentLength

number

Non utilisé.

skip

number

Non utilisé.

top

number

Non utilisé.

includeCommits

boolean

Si la valeur est true, la demande de tirage est retournée avec les validations associées.

includeWorkItemRefs

boolean

Si la valeur est true, la demande de tirage est retournée avec les références d’élément de travail associées.

Retours

Promise<GitPullRequest>

getPullRequestById(number, string)

Récupérez une demande de tirage( pull request).

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

Paramètres

pullRequestId

number

ID de la demande de tirage à récupérer.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequest>

getPullRequestCommits(string, number, string)

Obtenez les validations pour la demande de tirage spécifiée.

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

Paramètres

repositoryId

string

ID ou nom du référentiel.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<PagedList<GitCommitRef>>

getPullRequestConflict(string, number, number, string)

Récupérer un conflit pour une demande de tirage par ID

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

Paramètres

repositoryId

string

pullRequestId

number

conflictId

number

project

string

ID de projet ou nom du projet

Retours

Promise<GitConflict>

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

Récupérer tous les conflits pour une demande de tirage

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

Paramètres

repositoryId

string

Référentiel de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

skip

number

Conflits à ignorer.

top

number

Conflits à retourner après l’ignorer.

includeObsolete

boolean

Inclut des conflits obsolètes.

excludeResolved

boolean

Exclut les conflits déjà résolus.

onlyResolved

boolean

Retourne uniquement les conflits résolus.

Retours

Promise<GitConflict[]>

getPullRequestIteration(string, number, number, string)

Obtenez l’itération spécifiée pour une demande de tirage.

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

Paramètres

repositoryId

string

ID ou nom du référentiel.

pullRequestId

number

ID de la demande de tirage.

iterationId

number

ID de l’itération de demande de tirage à retourner.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequestIteration>

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

Récupérez les modifications apportées dans une demande de tirage entre deux itérations.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

iterationId

number

ID de l’itération de demande de tirage. <br /> Itération 1 est le chef de la branche source au moment où la demande de tirage est créée et les itérations suivantes sont créées lorsqu’il y a des push vers la branche source. Les valeurs autorisées sont comprises entre 1 et l’itération maximale sur cette demande de tirage.

project

string

ID de projet ou nom du projet

top

number

Optionnel. Nombre de modifications à récupérer. La valeur par défaut est 100 et la valeur maximale est 2000.

skip

number

Optionnel. Nombre de modifications à ignorer. Par exemple, pour récupérer les modifications 101-150, définissez les 50 premiers et passez à 100.

compareTo

number

ID de l’itération de demande de tirage à comparer. La valeur par défaut est zéro, ce qui indique que la comparaison est effectuée par rapport à la validation commune entre les branches source et cible

Retours

Promise<GitPullRequestIterationChanges>

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

Obtenez les validations pour l’itération spécifiée d’une demande de tirage.

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

Paramètres

repositoryId

string

ID ou nom du référentiel.

pullRequestId

number

ID de la demande de tirage.

iterationId

number

ID de l’itération à partir de laquelle obtenir les validations.

project

string

ID de projet ou nom du projet

top

number

Nombre maximal de validations à retourner. Le nombre maximal de validations pouvant être retournées par lot est de 500.

skip

number

Nombre de validations à ignorer.

Retours

Promise<GitCommitRef[]>

getPullRequestIterations(string, number, string, boolean)

Obtenez la liste des itérations pour la demande de tirage spécifiée.

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

Paramètres

repositoryId

string

ID ou nom du référentiel.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

includeCommits

boolean

Si la valeur est true, incluez les validations associées à chaque itération dans la réponse.

Retours

Promise<GitPullRequestIteration[]>

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

Obtenez l’état de l’itération de demande de tirage spécifique par ID. L’ID d’état est unique dans la demande de tirage sur toutes les itérations.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

iterationId

number

ID de l’itération de demande de tirage.

statusId

number

ID de l’état de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequestStatus>

getPullRequestIterationStatuses(string, number, number, string)

Obtenez tous les états associés à une itération de demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

iterationId

number

ID de l’itération de demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequestStatus[]>

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

Récupère une étiquette unique (balise) qui a été affectée à une demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

labelIdOrName

string

Nom ou ID de l’étiquette demandée.

project

string

ID de projet ou nom du projet

projectId

string

ID de projet ou nom du projet.

Retours

Promise<WebApiTagDefinition>

getPullRequestLabels(string, number, string, string)

Obtenez toutes les étiquettes (étiquettes) affectées à une demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

projectId

string

ID de projet ou nom du projet.

Retours

Promise<WebApiTagDefinition[]>

getPullRequestProperties(string, number, string)

Obtenir les propriétés externes de la demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<any>

getPullRequestQuery(GitPullRequestQuery, string, string)

Cette API est utilisée pour rechercher les demandes de tirage liées à une validation donnée. Il peut être utilisé pour rechercher la demande de tirage qui a créé une validation de fusion particulière ou pour rechercher toutes les demandes de tirage qui ont jamais fusionné une validation particulière. L’entrée est une liste de requêtes qui contiennent chacune une liste de validations. Pour chaque validation sur laquelle vous effectuez une recherche, vous récupérerez un dictionnaire de validation -> les demandes de tirage.

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

Paramètres

queries

GitPullRequestQuery

Liste des requêtes à effectuer.

repositoryId

string

ID du référentiel.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequestQuery>

getPullRequestReviewer(string, number, string, string)

Récupérer des informations sur un réviseur particulier sur une demande de tirage

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

reviewerId

string

ID du réviseur.

project

string

ID de projet ou nom du projet

Retours

Promise<IdentityRefWithVote>

getPullRequestReviewers(string, number, string)

Récupérer les réviseurs pour une demande de tirage

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<IdentityRefWithVote[]>

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

Récupérez toutes les demandes de tirage correspondant à des critères spécifiés.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

searchCriteria

GitPullRequestSearchCriteria

Les demandes de tirage sont retournées qui correspondent à ces critères de recherche.

project

string

ID de projet ou nom du projet

maxCommentLength

number

Non utilisé.

skip

number

Nombre de demandes de tirage à ignorer. Par exemple, pour récupérer les résultats 101-150, définissez la valeur supérieure à 50 et passez à 100.

top

number

Nombre de demandes de tirage à récupérer.

Retours

Promise<GitPullRequest[]>

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

Récupérez toutes les demandes de tirage correspondant à des critères spécifiés.

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

Paramètres

project

string

ID de projet ou nom du projet

searchCriteria

GitPullRequestSearchCriteria

Les demandes de tirage sont retournées qui correspondent à ces critères de recherche.

maxCommentLength

number

Non utilisé.

skip

number

Nombre de demandes de tirage à ignorer. Par exemple, pour récupérer les résultats 101-150, définissez la valeur supérieure à 50 et passez à 100.

top

number

Nombre de demandes de tirage à récupérer.

Retours

Promise<GitPullRequest[]>

getPullRequestStatus(string, number, number, string)

Obtenez l’état de la demande de tirage spécifique par ID. L’ID d’état est unique dans la demande de tirage sur toutes les itérations.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

statusId

number

ID de l’état de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequestStatus>

getPullRequestStatuses(string, number, string)

Obtenez tous les états associés à une demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequestStatus[]>

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

Récupérez un thread dans une demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

threadId

number

ID du thread.

project

string

ID de projet ou nom du projet

iteration

number

Si elle est spécifiée, la position du thread est suivie à l’aide de cette itération comme côté droit du diff.

baseIteration

number

Si elle est spécifiée, la position du thread est suivie à l’aide de cette itération comme côté gauche du diff.

Retours

Promise<GitPullRequestCommentThread>

getPullRequestWorkItemRefs(string, number, string)

Récupérez une liste d’éléments de travail associés à une demande de tirage.

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

Paramètres

repositoryId

string

ID ou nom du référentiel.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<ResourceRef[]>

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

Récupère un push particulier.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

pushId

number

ID du push.

project

string

ID de projet ou nom du projet

includeCommits

number

Nombre de validations à inclure dans le résultat.

includeRefUpdates

boolean

Si la valeur est true, incluez la liste des références qui ont été mises à jour par le push.

Retours

Promise<GitPush>

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

Récupérez une liste de validations associées à un push particulier.

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

Paramètres

repositoryId

string

Id ou nom convivial du référentiel. Pour utiliser le nom convivial, projectId doit également être spécifié.

pushId

number

ID du push.

project

string

ID de projet ou nom du projet

top

number

Nombre maximal de validations à retourner (« obtenir les validations x principales »).

skip

number

Nombre de validations à ignorer.

includeLinks

boolean

Définissez la valeur false pour éviter d’inclure des liens d’URL REST pour les ressources. La valeur par défaut est true.

Retours

Promise<GitCommitRef[]>

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

Récupère les envois push associés au référentiel spécifié.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

skip

number

Nombre d’envois (push) à ignorer.

top

number

Nombre d’envois (push) à retourner.

searchCriteria

GitPushSearchCriteria

Attributs des critères de recherche : fromDate, toDate, pusherId, refName, includeRefUpdates ou includeLinks. fromDate : date de début à partir de laquelle effectuer une recherche. toDate : date de fin à laquelle effectuer une recherche. pusherId : identité de la personne qui a envoyé le push. refName : nom de branche à prendre en compte. includeRefUpdates : si la valeur est true, incluez la liste des références qui ont été mises à jour par l’envoi push. includeLinks : indique s’il faut inclure le champ _links sur les références superficielles.

Retours

Promise<GitPush[]>

getRecycleBinRepositories(string)

Récupérez les dépôts Git supprimés de manière réversible à partir de la corbeille.

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

Paramètres

project

string

ID de projet ou nom du projet

Retours

Promise<GitDeletedRepository[]>

getRefFavorite(string, number)

Obtient le favori refs pour un ID favori.

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

Paramètres

project

string

ID de projet ou nom du projet

favoriteId

number

ID du favori ref demandé.

Retours

Promise<GitRefFavorite>

getRefFavorites(string, string, string)

Obtient les favoris refs pour un dépôt et une identité.

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

Paramètres

project

string

ID de projet ou nom du projet

repositoryId

string

ID du référentiel.

identityId

string

ID de l’identité dont les favoris doivent être récupérés. Si la valeur est Null, l’identité demandée est utilisée.

Retours

Promise<GitRefFavorite[]>

getRefFavoritesForProject(string, string)

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

Paramètres

project

string

ID de projet ou nom du projet

identityId

string

Retours

Promise<GitRefFavorite[]>

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

Interroge le référentiel fourni pour ses références et les retourne.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

filter

string

[facultatif] Filtre à appliquer aux références (commence par).

includeLinks

boolean

[facultatif] Spécifie si referenceLinks doit être inclus dans le résultat. la valeur par défaut est false.

includeStatuses

boolean

[facultatif] Inclut jusqu’aux 1 000 premiers états de validation pour chaque référence. La valeur par défaut est false.

includeMyBranches

boolean

[facultatif] Inclut uniquement les branches que l’utilisateur possède, les branches favorites de l’utilisateur et la branche par défaut. La valeur par défaut est false. Impossible de combiner le paramètre de filtre.

latestStatusesOnly

boolean

[facultatif] True pour inclure uniquement l’état de validation de conseil pour chaque référence. Cette option nécessite que les includeStatuses soient vraies. La valeur par défaut est false.

peelTags

boolean

[facultatif] Les balises annotées remplissent la propriété PeeledObjectId. la valeur par défaut est false.

filterContains

string

[facultatif] Filtre à appliquer aux références (contient).

Retours

Promise<PagedList<GitRef>>

getRepositories(string, boolean, boolean, boolean)

Récupérer des référentiels Git.

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

Paramètres

project

string

ID de projet ou nom du projet

includeLinks

boolean

[facultatif] True pour inclure des liens de référence. La valeur par défaut est false.

includeAllUrls

boolean

[facultatif] True pour inclure toutes les URL distantes. La valeur par défaut est false.

includeHidden

boolean

[facultatif] True pour inclure les référentiels masqués. La valeur par défaut est false.

Retours

Promise<GitRepository[]>

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

Récupérer des référentiels Git avec un filtre par nom et pagination.

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

Paramètres

projectId

string

ID ou nom du projet d’équipe.

includeLinks

boolean

[facultatif] True pour inclure des liens de référence. La valeur par défaut est false.

includeAllUrls

boolean

[facultatif] True pour inclure toutes les URL distantes. La valeur par défaut est false.

includeHidden

boolean

[facultatif] True pour inclure les référentiels masqués. La valeur par défaut est false.

filterContains

string

[facultatif] Filtre à appliquer aux références (contient).

top

number

[facultatif] Nombre maximal de référentiels à retourner. Elle ne peut pas être supérieure à 500. S’il n’est pas fourni mais que continuationToken est, la valeur par défaut est 100.

continuationToken

string

Jeton de continuation utilisé pour la pagination.

Retours

Promise<PagedList<GitRepository>>

getRepository(string, string)

Récupérez un dépôt Git.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

Retours

Promise<GitRepository>

getRepositoryWithParent(string, boolean, string)

Récupérez un dépôt Git.

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

Paramètres

repositoryId

string

Nom ou ID du référentiel.

includeParent

boolean

True pour inclure le référentiel parent. Disponible uniquement dans les appels authentifiés.

project

string

ID de projet ou nom du projet

Retours

Promise<GitRepository>

getRevert(string, number, string)

Récupérez des informations sur une opération de restauration en utilisant l’ID de restauration.

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

Paramètres

project

string

ID de projet ou nom du projet

revertId

number

ID de l’opération de restauration.

repositoryId

string

ID du référentiel.

Retours

Promise<GitRevert>

getRevertConflict(string, number, number, string)

Récupérer un conflit pour un rétablissement par ID

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

Paramètres

repositoryId

string

revertId

number

conflictId

number

project

string

ID de projet ou nom du projet

Retours

Promise<GitConflict>

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

Récupérer tous les conflits pour un rétablissement

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

Paramètres

repositoryId

string

revertId

number

project

string

ID de projet ou nom du projet

continuationToken

string

top

number

excludeResolved

boolean

onlyResolved

boolean

includeObsolete

boolean

Retours

Promise<PagedList<GitConflict>>

getRevertForRefName(string, string, string)

Récupérez des informations sur une opération de restauration pour une branche spécifique.

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

Paramètres

project

string

ID de projet ou nom du projet

repositoryId

string

ID du référentiel.

refName

string

GitAsyncRefOperationParameters generatedRefName utilisé pour l’opération de restauration.

Retours

Promise<GitRevert>

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

Obtenez les états associés à la validation Git.

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

Paramètres

commitId

string

ID de la validation Git.

repositoryId

string

ID du référentiel.

project

string

ID de projet ou nom du projet

top

number

Optionnel. Nombre d’états à récupérer. La valeur par défaut est 1 000.

skip

number

Optionnel. Nombre d’états à ignorer. La valeur par défaut est 0. Par exemple, pour récupérer les résultats 101-150, définissez la valeur supérieure à 50 et passez à 100.

latestOnly

boolean

L’indicateur indique s’il faut obtenir uniquement les derniers états regroupés par Context.Name et Context.Genre.

Retours

Promise<GitStatus[]>

getSuggestions(string, string, boolean)

Récupérez une suggestion de demande de tirage (pull request) pour un dépôt ou un projet d’équipe particulier.

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

Paramètres

repositoryId

string

ID du dépôt Git.

project

string

ID de projet ou nom du projet

preferCompareBranch

boolean

Si la valeur est true, préférez la branche de comparaison à la branche par défaut comme branche cible pour les demandes de tirage.

Retours

Promise<GitSuggestion[]>

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

Récupérez tous les threads dans une demande de tirage.

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

Paramètres

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

iteration

number

Si elle est spécifiée, les positions de thread sont suivies à l’aide de cette itération comme côté droit du différentiel.

baseIteration

number

Si elle est spécifiée, les positions de thread sont suivies à l’aide de cette itération comme côté gauche du diff.

Retours

Promise<GitPullRequestCommentThread[]>

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

Le point de terminaison Tree retourne la collection d’objets sous l’arborescence spécifiée. Les arborescences sont des dossiers dans un dépôt Git.

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

Paramètres

repositoryId

string

ID du référentiel.

sha1

string

Hachage SHA1 de l’objet tree.

project

string

ID de projet ou nom du projet

projectId

string

ID de projet.

recursive

boolean

Recherchez de manière récursive. Inclure des arbres sous cet arbre. La valeur par défaut est false.

fileName

string

Nom à utiliser si un fichier .zip est retourné. La valeur par défaut est l’ID d’objet.

Retours

Promise<GitTreeRef>

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

Le point de terminaison Tree retourne la collection d’objets sous l’arborescence spécifiée. Les arborescences sont des dossiers dans un dépôt Git.

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

Paramètres

repositoryId

string

ID du référentiel.

sha1

string

Hachage SHA1 de l’objet tree.

project

string

ID de projet ou nom du projet

projectId

string

ID de projet.

recursive

boolean

Recherchez de manière récursive. Inclure des arbres sous cet arbre. La valeur par défaut est false.

fileName

string

Nom à utiliser si un fichier .zip est retourné. La valeur par défaut est l’ID d’objet.

Retours

Promise<ArrayBuffer>

queryImportRequests(string, string, boolean)

Récupérez les demandes d’importation d’un référentiel.

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

Paramètres

project

string

ID de projet ou nom du projet

repositoryId

string

Nom ou ID du référentiel.

includeAbandoned

boolean

True pour inclure les demandes d’importation abandonnées dans les résultats.

Retours

Promise<GitImportRequest[]>

restoreRepositoryFromRecycleBin(GitRecycleBinRepositoryDetails, string, string)

Récupérez un dépôt Git supprimé de manière réversible. Les dépôts récemment supprimés passent à un état de suppression réversible pendant un certain temps avant qu’ils ne soient supprimés en dur et deviennent irrécupérables.

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

Paramètres

repositoryDetails

GitRecycleBinRepositoryDetails

project

string

ID de projet ou nom du projet

repositoryId

string

ID du référentiel.

Retours

Promise<GitRepository>

setEnableOnCreateHost(boolean)

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

Paramètres

enableOnCreateHost

boolean

Retours

Promise<void>

setEnableOnCreateProject(string, boolean)

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

Paramètres

enableOnCreateProjectId

string

enableOnStatus

boolean

Retours

Promise<void>

sharePullRequest(ShareNotificationContext, string, number, string)

Envoie une notification par e-mail concernant une demande de tirage spécifique à un ensemble de destinataires

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

Paramètres

userMessage

ShareNotificationContext

repositoryId

string

ID du dépôt Git.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<void>

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

Mettre à jour la résolution des conflits de fusion

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

Paramètres

conflict

GitConflict

repositoryId

string

cherryPickId

number

conflictId

number

project

string

ID de projet ou nom du projet

Retours

Promise<GitConflict>

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

Mettre à jour plusieurs résolutions de conflit de fusion

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

Paramètres

conflictUpdates

GitConflict[]

repositoryId

string

cherryPickId

number

project

string

ID de projet ou nom du projet

Retours

Promise<GitConflictUpdateResult[]>

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

Mettez à jour un commentaire associé à un thread spécifique dans une demande de tirage.

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

Paramètres

comment

Comment

Contenu de commentaire à mettre à jour. Les commentaires peuvent comporter jusqu’à 150 000 caractères.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

threadId

number

ID du thread dans lequel se trouve le commentaire souhaité.

commentId

number

ID du commentaire à mettre à jour.

project

string

ID de projet ou nom du projet

Retours

Promise<Comment>

updateEnablementStatus(AdvSecEnablementUpdate[])

État de l’activation POST pour les référentiels.

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

Paramètres

enablementUpdates

AdvSecEnablementUpdate[]

Retours

Promise<void>

updateImportRequest(GitImportRequest, string, string, number)

Réessayez ou abandonnez une demande d’importation ayant échoué.

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

Paramètres

importRequestToUpdate

GitImportRequest

Version mise à jour de la demande d’importation. Actuellement, la seule modification autorisée consiste à définir l’état sur File d’attente ou Abandonné.

project

string

ID de projet ou nom du projet

repositoryId

string

Nom ou ID du référentiel.

importRequestId

number

Identificateur unique de la demande d’importation à mettre à jour.

Retours

Promise<GitImportRequest>

updatePullRequest(GitPullRequest, string, number, string)

Mettre à jour une demande de tirage

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

Paramètres

gitPullRequestToUpdate

GitPullRequest

Contenu de la demande de tirage qui doit être mis à jour.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage à jour.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequest>

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

Mettre à jour la résolution des conflits de fusion

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

Paramètres

conflict

GitConflict

repositoryId

string

pullRequestId

number

conflictId

number

project

string

ID de projet ou nom du projet

Retours

Promise<GitConflict>

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

Mettre à jour plusieurs résolutions de conflit de fusion

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

Paramètres

conflictUpdates

GitConflict[]

repositoryId

string

pullRequestId

number

project

string

ID de projet ou nom du projet

Retours

Promise<GitConflictUpdateResult[]>

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

Mettez à jour la collection d’états d’itération des demandes de tirage. Le seul type d’opération pris en charge est remove.

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

Paramètres

patchDocument

JsonPatchDocument

Opérations à appliquer aux états des demandes de tirage au format patch JSON.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

iterationId

number

ID de l’itération de demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<void>

updatePullRequestProperties(JsonPatchDocument, string, number, string)

Créez ou mettez à jour des propriétés externes de demande de tirage. L’opération de correctif peut être add, replace ou remove. Pour add opération, le chemin d’accès peut être vide. Si le chemin d’accès est vide, la valeur doit être une liste de paires clé-valeur. Pour replace opération, le chemin d’accès ne peut pas être vide. Si le chemin d’accès n’existe pas, la propriété est ajoutée à la collection. Pour remove opération, le chemin d’accès ne peut pas être vide. Si le chemin n’existe pas, aucune action n’est effectuée.

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

Paramètres

patchDocument

JsonPatchDocument

Propriétés à ajouter, remplacer ou supprimer au format patch JSON.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<any>

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

Modifiez une entrée de réviseur. Ces champs sont correctives : isFlagged, hasDeclined

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

Paramètres

reviewer

IdentityRefWithVote

Données du réviseur.<br />Si l’ID du réviseur est inclus ici, il doit correspondre au paramètre reviewerID.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

reviewerId

string

ID du réviseur.

project

string

ID de projet ou nom du projet

Retours

Promise<IdentityRefWithVote>

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

Réinitialisez les votes de plusieurs réviseurs sur une demande de tirage. REMARQUE : ce point de terminaison prend uniquement en charge la mise à jour des votes, mais ne prend pas en charge la mise à jour des réviseurs requis (utiliser la stratégie) ou les noms d’affichage.

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

Paramètres

patchVotes

IdentityRefWithVote[]

ID des réviseurs dont les votes seront réinitialisés à zéro

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage

project

string

ID de projet ou nom du projet

Retours

Promise<void>

updatePullRequestStatuses(JsonPatchDocument, string, number, string)

Mettez à jour la collecte des états des demandes de tirage. Le seul type d’opération pris en charge est remove.

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

Paramètres

patchDocument

JsonPatchDocument

Opérations à appliquer aux états des demandes de tirage au format patch JSON.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

project

string

ID de projet ou nom du projet

Retours

Promise<void>

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

Verrouillez ou déverrouillez une branche.

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

Paramètres

newRefInfo

GitRefUpdate

Action de mise à jour ref (verrou/déverrouillage) à effectuer

repositoryId

string

Nom ou ID du référentiel.

filter

string

Nom de la branche à verrouiller/déverrouiller

project

string

ID de projet ou nom du projet

projectId

string

ID ou nom du projet d’équipe. Facultatif si vous spécifiez un ID pour le référentiel.

Retours

Promise<GitRef>

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

Création, mise à jour ou suppression de refs(branches).

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

Paramètres

refUpdates

GitRefUpdate[]

Liste des mises à jour ref à effectuer

repositoryId

string

Nom ou ID du référentiel.

project

string

ID de projet ou nom du projet

projectId

string

ID ou nom du projet d’équipe. Facultatif si vous spécifiez un ID pour le référentiel.

Retours

Promise<GitRefUpdateResult[]>

updateRepository(GitRepository, string, string)

Met à jour le référentiel Git avec un nouveau nom de dépôt ou une nouvelle branche par défaut.

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

Paramètres

newRepositoryInfo

GitRepository

Spécifier un nouveau nom de dépôt ou une nouvelle branche par défaut du référentiel

repositoryId

string

ID du référentiel.

project

string

ID de projet ou nom du projet

Retours

Promise<GitRepository>

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

Mettre à jour la résolution des conflits de fusion

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

Paramètres

conflict

GitConflict

repositoryId

string

revertId

number

conflictId

number

project

string

ID de projet ou nom du projet

Retours

Promise<GitConflict>

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

Mettre à jour plusieurs résolutions de conflit de fusion

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

Paramètres

conflictUpdates

GitConflict[]

repositoryId

string

revertId

number

project

string

ID de projet ou nom du projet

Retours

Promise<GitConflictUpdateResult[]>

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

Mettez à jour un thread dans une demande de tirage.

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

Paramètres

commentThread

GitPullRequestCommentThread

Contenu du thread à mettre à jour.

repositoryId

string

ID de référentiel de la branche cible de la demande de tirage.

pullRequestId

number

ID de la demande de tirage.

threadId

number

ID du thread à mettre à jour.

project

string

ID de projet ou nom du projet

Retours

Promise<GitPullRequestCommentThread>