BuildRestClient class
Classe de base qui doit être utilisée (dérivée de) pour effectuer des requêtes à des API REST VSS
- Extends
Constructeurs
| Build |
Propriétés
| RESOURCE_AREA_ID |
Méthodes
| add |
Ajoute un tag à une construction. |
| add |
Ajoute des tags à une construction. |
| add |
Ajoute une balise à une définition |
| add |
Ajoute plusieurs tags à une définition. |
| add |
Ajoute de nouveaux baux pour les trajets de pipelines. |
| authorize |
|
| authorize |
|
| create |
Associe un artefact à une construction. |
| create |
Crée une définition. |
| create |
Crée un dossier. |
| delete |
Supprime une build. |
| delete |
Ça supprime un tag d’une construction. REMARQUE : Cette API ne fonctionnera pas pour les tags avec des caractères spéciaux. Pour supprimer les balises avec des caractères spéciaux, utilisez plutôt la méthode PATCH (dans la version 6.0+) |
| delete |
Supprime une définition et toutes les builds associées. |
| delete |
Supprime un tag d’une définition. REMARQUE : Cette API ne fonctionnera pas pour les tags avec des caractères spéciaux. Pour supprimer les balises avec des caractères spéciaux, utilisez plutôt la méthode PATCH (dans la version 6.0+) |
| delete |
Supprime un dossier de définition. Les définitions et leurs constructions correspondantes seront également supprimées. |
| delete |
Cela supprime certains baux de rétention. |
| delete |
Supprime un tag des builds, des définitions et du magasin de tags |
| delete |
Supprime un modèle de définition de build. |
| get |
Obtient un artefact spécifique pour une construction. |
| get |
Obtient un artefact spécifique pour une construction. |
| get |
Ça obtient tous les artefacts pour une construction. |
| get |
Prend un attachement spécifique. |
| get |
Obtient la liste des accessoires d’un type spécifique associés à une construction. |
| get |
Obtient un badge qui indique le statut de la dernière version pour une définition. Notez que cette API est dépréciée. Je préfère StatusBadgeController.ObtientStatutBadge. |
| get |
Obtient une build |
| get |
Obtient un badge qui indique le statut de la dernière version pour la branche spécifiée. |
| get |
Obtient un badge qui indique le statut de la dernière version pour la branche spécifiée. |
| get |
Obtient les changements associés à une construction |
| get |
Prend un contrôleur |
| get |
Obtient le contrôleur, éventuellement filtré par nom |
| get |
Ça obtient les réglages généraux du pipeline. |
| get |
Obtient un fichier journal individuel pour une compilation. |
| get |
Obtient un fichier journal individuel pour une compilation. |
| get |
Il obtient les journaux pour une construction. |
| get |
Il obtient les journaux pour une construction. |
| get |
Obtient un fichier journal individuel pour une compilation. |
| get |
Toutes les options de définition de build prises en charge par le système. |
| get |
Obtient des propriétés pour une construction. |
| get |
Il reçoit un rapport de build. |
| get |
Il reçoit un rapport de build. |
| get |
Obtient une liste de builds. |
| get |
Ça obtient les paramètres de construction. |
| get |
Obtient la chronologie la plus récente d’une build filtrée à une étape spécifique. |
| get |
Obtient la chronologie d’une build filtrée à une étape spécifique. |
| get |
Ça obtient les tags pour une construction. |
| get |
Obtient les détails d’une construction |
| get |
Obtient les objets de travail associés à une construction. Seuls les objets du même projet sont retournés. |
| get |
Obtient les éléments de travail associés à une construction, filtrés en commits spécifiques. |
| get |
Obtient les modifications apportées au dépôt entre deux builds donnés. |
| get |
Obtient une définition, éventuellement à une révision spécifique. |
| get |
Ça obtient des métriques de build pour une définition. |
| get |
Obtient des propriétés pour une définition. |
| get |
|
| get |
Obtient toutes les révisions d’une définition. |
| get |
Obtient une liste de définitions. |
| get |
Il obtient les tags pour une définition. |
| get |
Convertit une définition en YAML, optionnellement à une révision spécifique. |
| get |
Il obtient un fichier de la compilation. |
| get |
Obtient le contenu d’un fichier dans le dépôt de code source donné. |
| get |
Obtient une liste des dossiers de définition de build. |
| get |
Obtient la dernière build d’une définition, éventuellement délimitée à une branche spécifique. |
| get |
Obtient le contenu d’un répertoire dans le dépôt de code source donné. |
| get |
Obtient les métriques de build pour un projet. |
| get |
|
| get |
Obtient un objet pull request du fournisseur source. |
| get |
Obtient des informations sur les ressources de construction dans le système. |
| get |
Retourne l’historique de conservation de la collection du projet. Cela inclut les pipelines ayant des règles de rétention personnalisées pouvant empêcher la tâche de rétention de les nettoyer, les exécutions par pipeline avec type de rétention, les fichiers associés aux pipelines appartenant à la collection avec type de rétention, et le nombre de fichiers par pipeline. |
| get |
Retourne les détails du bail de conservation avec un identifiant de location. |
| get |
Restitue tous les baux correspondant aux baux MinimumRetentionBahns spécifiés |
| get |
Retourne tous les baux détenus par l’entité spécifiée, optionnellement limités à une seule définition et exécution de pipeline. |
| get |
Renvoie tous les baux détenus par l’utilisateur spécifié, optionnellement divisés sur une seule définition et exécution du pipeline. |
| get |
Obtient tous les baux de rétention qui s’appliquent à un bâtiment spécifique. |
| get |
Obtient les paramètres de rétention du projet. |
| get |
<p>Obtient le statut de compilation pour une définition, optionnellement portée à une branche, une étape, un travail et une configuration spécifiques.</p><p>S’il y en a plus d’un, il est nécessaire de passer une valeur stageName lors de la spécification d’un jobName, et la même règle s’applique alors aux deux si on passe un paramètre de configuration.</p> |
| get |
Obtient une liste de toutes les balises de construction du projet. |
| get |
Obtient un modèle de définition de build spécifique. |
| get |
Obtient tous les modèles de définition. |
| get |
Ça obtient tous les objets de travail entre deux builds. |
| list |
Obtient une liste de branches pour le dépôt de code source donné. |
| list |
Obtient une liste des dépôts du code source. |
| list |
Obtenez une liste des fournisseurs de sources et de leurs capacités. |
| list |
Obtient une liste de webhooks installés dans le référentiel de code source donné. |
| queue |
Met en file d’attente une build |
| restore |
Restaure une définition supprimée |
| restore |
Recrée les webhooks pour les déclencheurs spécifiés dans le dépôt de code source donné. |
| save |
Met à jour un modèle de définition de build existant. |
| update |
Met à jour une build. |
| update |
Mise à jour des paramètres généraux du pipeline. |
| update |
Met à jour les propriétés d’une configuration. |
| update |
Met à jour plusieurs builds. |
| update |
Met à jour les paramètres de configuration. |
| update |
Ajoute/Supprime des tags d’une construction. |
| update |
Met à jour une définition de build existante. Pour que cette opération réussisse, la valeur de la propriété « Revision » du corps de la demande doit correspondre à celle de la définition de build existante. Il est recommandé d’obtenir la définition de build existante à l’aide de GET, de modifier la définition de build si nécessaire, puis d’envoyer la définition modifiée avec PUT. |
| update |
Met à jour les propriétés pour une définition. |
| update |
Ajoute/Supprime des tags d’une définition. |
| update |
Met à jour un dossier existant au chemin existant donné |
| update |
Met à jour la durée ou l’état de protection du pipeline d’un bail de conservation. |
| update |
Met à jour les paramètres de rétention du projet. |
| update |
Mettre à jour une phase de génération |
Détails du constructeur
BuildRestClient(IVssRestClientOptions)
Détails de la propriété
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: "965220d5-5bb9-42cf-8d67-9b146df2a5a4" = "965220d5-5bb9-42cf-8d67-9b146df2a5a4"
Valeur de propriété
"965220d5-5bb9-42cf-8d67-9b146df2a5a4"
Détails de la méthode
addBuildTag(string, number, string)
Ajoute un tag à une construction.
function addBuildTag(project: string, buildId: number, tag: string): Promise<string[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- tag
-
string
Le tag à ajouter.
Retours
Promise<string[]>
addBuildTags(string[], string, number)
Ajoute des tags à une construction.
function addBuildTags(tags: string[], project: string, buildId: number): Promise<string[]>
Paramètres
- tags
-
string[]
Les tags à ajouter. Le corps de la demande est composé directement à partir des tags listés.
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
Retours
Promise<string[]>
addDefinitionTag(string, number, string)
Ajoute une balise à une définition
function addDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
- tag
-
string
Le tag à ajouter.
Retours
Promise<string[]>
addDefinitionTags(string[], string, number)
Ajoute plusieurs tags à une définition.
function addDefinitionTags(tags: string[], project: string, definitionId: number): Promise<string[]>
Paramètres
- tags
-
string[]
Les tags à ajouter.
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
Retours
Promise<string[]>
addRetentionLeases(NewRetentionLease[], string)
Ajoute de nouveaux baux pour les trajets de pipelines.
function addRetentionLeases(newLeases: NewRetentionLease[], project: string): Promise<RetentionLease[]>
Paramètres
- newLeases
- project
-
string
ID de projet ou nom du projet
Retours
Promise<RetentionLease[]>
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
function authorizeDefinitionResources(resources: DefinitionResourceReference[], project: string, definitionId: number): Promise<DefinitionResourceReference[]>
Paramètres
- resources
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
Retours
Promise<DefinitionResourceReference[]>
authorizeProjectResources(DefinitionResourceReference[], string)
function authorizeProjectResources(resources: DefinitionResourceReference[], project: string): Promise<DefinitionResourceReference[]>
Paramètres
- resources
- project
-
string
ID de projet ou nom du projet
Retours
Promise<DefinitionResourceReference[]>
createArtifact(BuildArtifact, string, number)
Associe un artefact à une construction.
function createArtifact(artifact: BuildArtifact, project: string, buildId: number): Promise<BuildArtifact>
Paramètres
- artifact
- BuildArtifact
L’artefact.
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
Retours
Promise<BuildArtifact>
createDefinition(BuildDefinition, string, number, number)
Crée une définition.
function createDefinition(definition: BuildDefinition, project: string, definitionToCloneId?: number, definitionToCloneRevision?: number): Promise<BuildDefinition>
Paramètres
- definition
- BuildDefinition
Définition.
- project
-
string
ID de projet ou nom du projet
- definitionToCloneId
-
number
- definitionToCloneRevision
-
number
Retours
Promise<BuildDefinition>
createFolder(Folder, string, string)
deleteBuild(string, number)
Supprime une build.
function deleteBuild(project: string, buildId: number): Promise<void>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
Retours
Promise<void>
deleteBuildTag(string, number, string)
Ça supprime un tag d’une construction. REMARQUE : Cette API ne fonctionnera pas pour les tags avec des caractères spéciaux. Pour supprimer les balises avec des caractères spéciaux, utilisez plutôt la méthode PATCH (dans la version 6.0+)
function deleteBuildTag(project: string, buildId: number, tag: string): Promise<string[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- tag
-
string
L’étiquette à retirer.
Retours
Promise<string[]>
deleteDefinition(string, number)
Supprime une définition et toutes les builds associées.
function deleteDefinition(project: string, definitionId: number): Promise<void>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
Retours
Promise<void>
deleteDefinitionTag(string, number, string)
Supprime un tag d’une définition. REMARQUE : Cette API ne fonctionnera pas pour les tags avec des caractères spéciaux. Pour supprimer les balises avec des caractères spéciaux, utilisez plutôt la méthode PATCH (dans la version 6.0+)
function deleteDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
- tag
-
string
L’étiquette à retirer.
Retours
Promise<string[]>
deleteFolder(string, string)
Supprime un dossier de définition. Les définitions et leurs constructions correspondantes seront également supprimées.
function deleteFolder(project: string, path: string): Promise<void>
Paramètres
- project
-
string
ID de projet ou nom du projet
- path
-
string
Chemin d’accès complet au dossier.
Retours
Promise<void>
deleteRetentionLeasesById(string, number[])
Cela supprime certains baux de rétention.
function deleteRetentionLeasesById(project: string, ids: number[]): Promise<void>
Paramètres
- project
-
string
ID de projet ou nom du projet
- ids
-
number[]
Retours
Promise<void>
deleteTag(string, string)
Supprime un tag des builds, des définitions et du magasin de tags
function deleteTag(project: string, tag: string): Promise<string[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- tag
-
string
L’étiquette à retirer.
Retours
Promise<string[]>
deleteTemplate(string, string)
Supprime un modèle de définition de build.
function deleteTemplate(project: string, templateId: string): Promise<void>
Paramètres
- project
-
string
ID de projet ou nom du projet
- templateId
-
string
ID du modèle.
Retours
Promise<void>
getArtifact(string, number, string)
Obtient un artefact spécifique pour une construction.
function getArtifact(project: string, buildId: number, artifactName: string): Promise<BuildArtifact>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- artifactName
-
string
Nom de l’artefact.
Retours
Promise<BuildArtifact>
getArtifactContentZip(string, number, string)
Obtient un artefact spécifique pour une construction.
function getArtifactContentZip(project: string, buildId: number, artifactName: string): Promise<ArrayBuffer>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- artifactName
-
string
Nom de l’artefact.
Retours
Promise<ArrayBuffer>
getArtifacts(string, number)
Ça obtient tous les artefacts pour une construction.
function getArtifacts(project: string, buildId: number): Promise<BuildArtifact[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
Retours
Promise<BuildArtifact[]>
getAttachment(string, number, string, string, string, string)
Prend un attachement spécifique.
function getAttachment(project: string, buildId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- timelineId
-
string
ID de la chronologie.
- recordId
-
string
L’ID de l’enregistrement de la chronologie.
- type
-
string
Type de la pièce jointe.
- name
-
string
Nom de fichier de la pièce jointe
Retours
Promise<ArrayBuffer>
getAttachments(string, number, string)
Obtient la liste des accessoires d’un type spécifique associés à une construction.
function getAttachments(project: string, buildId: number, type: string): Promise<Attachment[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- type
-
string
Type de pièce jointe.
Retours
Promise<Attachment[]>
getBadge(string, number, string)
Obtient un badge qui indique le statut de la dernière version pour une définition. Notez que cette API est dépréciée. Je préfère StatusBadgeController.ObtientStatutBadge.
function getBadge(project: string, definitionId: number, branchName?: string): Promise<string>
Paramètres
- project
-
string
L’identifiant du projet ou son nom.
- definitionId
-
number
ID de la définition.
- branchName
-
string
Nom de la branche.
Retours
Promise<string>
getBuild(string, number, string)
Obtient une build
function getBuild(project: string, buildId: number, propertyFilters?: string): Promise<Build>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
- propertyFilters
-
string
Retours
Promise<Build>
getBuildBadge(string, string, string, string)
Obtient un badge qui indique le statut de la dernière version pour la branche spécifiée.
function getBuildBadge(project: string, repoType: string, repoId?: string, branchName?: string): Promise<BuildBadge>
Paramètres
- project
-
string
ID de projet ou nom du projet
- repoType
-
string
Le type de dépôt.
- repoId
-
string
L’identifiant du dépôt.
- branchName
-
string
Nom de la branche.
Retours
Promise<BuildBadge>
getBuildBadgeData(string, string, string, string)
Obtient un badge qui indique le statut de la dernière version pour la branche spécifiée.
function getBuildBadgeData(project: string, repoType: string, repoId?: string, branchName?: string): Promise<string>
Paramètres
- project
-
string
ID de projet ou nom du projet
- repoType
-
string
Le type de dépôt.
- repoId
-
string
L’identifiant du dépôt.
- branchName
-
string
Nom de la branche.
Retours
Promise<string>
getBuildChanges(string, number, string, number, boolean)
Obtient les changements associés à une construction
function getBuildChanges(project: string, buildId: number, continuationToken?: string, top?: number, includeSourceChange?: boolean): Promise<PagedList<Change>>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
- continuationToken
-
string
- top
-
number
Le nombre maximal de changements à revenir
- includeSourceChange
-
boolean
Retours
getBuildController(number)
Prend un contrôleur
function getBuildController(controllerId: number): Promise<BuildController>
Paramètres
- controllerId
-
number
Retours
Promise<BuildController>
getBuildControllers(string)
Obtient le contrôleur, éventuellement filtré par nom
function getBuildControllers(name?: string): Promise<BuildController[]>
Paramètres
- name
-
string
Retours
Promise<BuildController[]>
getBuildGeneralSettings(string)
Ça obtient les réglages généraux du pipeline.
function getBuildGeneralSettings(project: string): Promise<PipelineGeneralSettings>
Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<PipelineGeneralSettings>
getBuildLog(string, number, number, number, number)
Obtient un fichier journal individuel pour une compilation.
function getBuildLog(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- logId
-
number
L’identifiant du fichier journal.
- startLine
-
number
La ligne de départ.
- endLine
-
number
La ligne de fin.
Retours
Promise<string>
getBuildLogLines(string, number, number, number, number)
Obtient un fichier journal individuel pour une compilation.
function getBuildLogLines(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- logId
-
number
L’identifiant du fichier journal.
- startLine
-
number
La ligne de départ.
- endLine
-
number
La ligne de fin.
Retours
Promise<string[]>
getBuildLogs(string, number)
Il obtient les journaux pour une construction.
function getBuildLogs(project: string, buildId: number): Promise<BuildLog[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
Retours
Promise<BuildLog[]>
getBuildLogsZip(string, number)
Il obtient les journaux pour une construction.
function getBuildLogsZip(project: string, buildId: number): Promise<ArrayBuffer>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
Retours
Promise<ArrayBuffer>
getBuildLogZip(string, number, number, number, number)
Obtient un fichier journal individuel pour une compilation.
function getBuildLogZip(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<ArrayBuffer>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- logId
-
number
L’identifiant du fichier journal.
- startLine
-
number
La ligne de départ.
- endLine
-
number
La ligne de fin.
Retours
Promise<ArrayBuffer>
getBuildOptionDefinitions(string)
Toutes les options de définition de build prises en charge par le système.
function getBuildOptionDefinitions(project?: string): Promise<BuildOptionDefinition[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<BuildOptionDefinition[]>
getBuildProperties(string, number, string[])
Obtient des propriétés pour une construction.
function getBuildProperties(project: string, buildId: number, filter?: string[]): Promise<any>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- filter
-
string[]
Une liste délimitée par des virgules des propriétés. Si spécifié, filtrez ces propriétés spécifiques.
Retours
Promise<any>
getBuildReport(string, number, string)
Il reçoit un rapport de build.
function getBuildReport(project: string, buildId: number, type?: string): Promise<BuildReportMetadata>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- type
-
string
Retours
Promise<BuildReportMetadata>
getBuildReportHtmlContent(string, number, string)
Il reçoit un rapport de build.
function getBuildReportHtmlContent(project: string, buildId: number, type?: string): Promise<any>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- type
-
string
Retours
Promise<any>
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)
Obtient une liste de builds.
function getBuilds(project: string, definitions?: number[], queues?: number[], buildNumber?: string, minTime?: Date, maxTime?: Date, requestedFor?: string, reasonFilter?: BuildReason, statusFilter?: BuildStatus, resultFilter?: BuildResult, tagFilters?: string[], properties?: string[], top?: number, continuationToken?: string, maxBuildsPerDefinition?: number, deletedFilter?: QueryDeletedOption, queryOrder?: BuildQueryOrder, branchName?: string, buildIds?: number[], repositoryId?: string, repositoryType?: string): Promise<PagedList<Build>>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitions
-
number[]
Liste délimitée par des virgules d’ID de définition. Si ce paramètre est spécifié, les filtres à générer pour ces définitions.
- queues
-
number[]
Liste délimitée par des virgules d’ID de file d’attente. Si elle est spécifiée, filtre les builds qui s’exécutaient sur ces files d’attente.
- buildNumber
-
string
Si elle est spécifiée, filtre les builds qui correspondent à ce numéro de build. Ajoutez * pour effectuer une recherche de préfixe.
- minTime
-
Date
Si elle est spécifiée, filtre les builds qui ont terminé/démarré/mis en file d’attente après cette date en fonction de l’objet queryOrder spécifié.
- maxTime
-
Date
Si elle est spécifiée, filtre les builds qui ont terminé/démarré/mis en file d’attente avant cette date en fonction de l’objet queryOrder spécifié.
- requestedFor
-
string
Si elle est spécifiée, filtre les builds demandées pour l’utilisateur spécifié.
- reasonFilter
- BuildReason
Si elle est spécifiée, filtre les builds qui correspondent à cette raison.
- statusFilter
- BuildStatus
Si elle est spécifiée, filtre les builds qui correspondent à cet état.
- resultFilter
- BuildResult
Si elle est spécifiée, filtre les builds correspondant à ce résultat.
- tagFilters
-
string[]
Liste délimitée par des virgules de balises. Si elle est spécifiée, filtre les builds qui ont les balises spécifiées.
- properties
-
string[]
Liste délimitée par des virgules de propriétés à récupérer.
- top
-
number
Nombre maximal de builds à retourner.
- continuationToken
-
string
Jeton de continuation, retourné par un appel précédent à cette méthode, qui peut être utilisé pour retourner le jeu de builds suivant.
- maxBuildsPerDefinition
-
number
Nombre maximal de builds à retourner par définition.
- deletedFilter
- QueryDeletedOption
Indique s’il faut exclure, inclure ou retourner uniquement des builds supprimées.
- queryOrder
- BuildQueryOrder
Ordre dans lequel les builds doivent être retournées.
- branchName
-
string
Si elle est spécifiée, filtre les builds qui ont généré des branches qui ont généré cette branche.
- buildIds
-
number[]
Liste délimitée par des virgules qui spécifie les ID des builds à récupérer.
- repositoryId
-
string
Si elle est spécifiée, filtre les builds générées à partir de ce référentiel.
- repositoryType
-
string
Si elle est spécifiée, filtre les builds générées à partir de référentiels de ce type.
Retours
getBuildSettings(string)
Ça obtient les paramètres de construction.
function getBuildSettings(project?: string): Promise<BuildSettings>
Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<BuildSettings>
getBuildStageLatestTimeline(string, number, string, number, string)
Obtient la chronologie la plus récente d’une build filtrée à une étape spécifique.
function getBuildStageLatestTimeline(project: string, buildId: number, stageName: string, changeId?: number, planId?: string): Promise<Timeline>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- stageName
-
string
Nom de la phase à filtrer.
- changeId
-
number
ID de modification par lequel filtrer.
- planId
-
string
ID du plan.
Retours
Promise<Timeline>
getBuildStageTimeline(string, number, string, string, number, string)
Obtient la chronologie d’une build filtrée à une étape spécifique.
function getBuildStageTimeline(project: string, buildId: number, timelineId: string, stageName: string, changeId?: number, planId?: string): Promise<Timeline>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- timelineId
-
string
ID de la chronologie.
- stageName
-
string
Nom de la phase à filtrer.
- changeId
-
number
ID de modification par lequel filtrer.
- planId
-
string
ID du plan.
Retours
Promise<Timeline>
getBuildTags(string, number)
Ça obtient les tags pour une construction.
function getBuildTags(project: string, buildId: number): Promise<string[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
Retours
Promise<string[]>
getBuildTimeline(string, number, string, number, string)
Obtient les détails d’une construction
function getBuildTimeline(project: string, buildId: number, timelineId?: string, changeId?: number, planId?: string): Promise<Timeline>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
- timelineId
-
string
- changeId
-
number
- planId
-
string
Retours
Promise<Timeline>
getBuildWorkItemsRefs(string, number, number)
Obtient les objets de travail associés à une construction. Seuls les objets du même projet sont retournés.
function getBuildWorkItemsRefs(project: string, buildId: number, top?: number): Promise<ResourceRef[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- top
-
number
Le nombre maximal d’articles de travail à remettre.
Retours
Promise<ResourceRef[]>
getBuildWorkItemsRefsFromCommits(string[], string, number, number)
Obtient les éléments de travail associés à une construction, filtrés en commits spécifiques.
function getBuildWorkItemsRefsFromCommits(commitIds: string[], project: string, buildId: number, top?: number): Promise<ResourceRef[]>
Paramètres
- commitIds
-
string[]
Une liste délimitée par des virgules des identifiants de commit.
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- top
-
number
Le nombre maximal d’éléments de travail à retourner, ou le nombre de commits à considérer si aucun ID de commit n’est spécifié.
Retours
Promise<ResourceRef[]>
getChangesBetweenBuilds(string, number, number, number)
Obtient les modifications apportées au dépôt entre deux builds donnés.
function getChangesBetweenBuilds(project: string, fromBuildId?: number, toBuildId?: number, top?: number): Promise<Change[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- fromBuildId
-
number
L’ID de la première version.
- toBuildId
-
number
L’ID de la dernière version.
- top
-
number
Nombre maximal de modifications à retourner.
Retours
Promise<Change[]>
getDefinition(string, number, number, Date, string[], boolean)
Obtient une définition, éventuellement à une révision spécifique.
function getDefinition(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<BuildDefinition>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
- revision
-
number
Numéro de révision à récupérer. Si ce n’est pas spécifié, la dernière version est retournée.
- minMetricsTime
-
Date
Si elle est spécifiée, indique la date à partir de laquelle les métriques doivent être incluses.
- propertyFilters
-
string[]
Liste délimitée par des virgules de propriétés à inclure dans les résultats.
- includeLatestBuilds
-
boolean
Retours
Promise<BuildDefinition>
getDefinitionMetrics(string, number, Date)
Ça obtient des métriques de build pour une définition.
function getDefinitionMetrics(project: string, definitionId: number, minMetricsTime?: Date): Promise<BuildMetric[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
- minMetricsTime
-
Date
La date à partir de laquelle calculer les métriques.
Retours
Promise<BuildMetric[]>
getDefinitionProperties(string, number, string[])
Obtient des propriétés pour une définition.
function getDefinitionProperties(project: string, definitionId: number, filter?: string[]): Promise<any>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
- filter
-
string[]
Une liste délimitée par des virgules des propriétés. Si spécifié, filtrez ces propriétés spécifiques.
Retours
Promise<any>
getDefinitionResources(string, number)
function getDefinitionResources(project: string, definitionId: number): Promise<DefinitionResourceReference[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
Retours
Promise<DefinitionResourceReference[]>
getDefinitionRevisions(string, number)
Obtient toutes les révisions d’une définition.
function getDefinitionRevisions(project: string, definitionId: number): Promise<BuildDefinitionRevision[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
Retours
Promise<BuildDefinitionRevision[]>
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)
Obtient une liste de définitions.
function getDefinitions(project: string, name?: string, repositoryId?: string, repositoryType?: string, queryOrder?: DefinitionQueryOrder, top?: number, continuationToken?: string, minMetricsTime?: Date, definitionIds?: number[], path?: string, builtAfter?: Date, notBuiltAfter?: Date, includeAllProperties?: boolean, includeLatestBuilds?: boolean, taskIdFilter?: string, processType?: number, yamlFilename?: string): Promise<PagedList<BuildDefinitionReference>>
Paramètres
- project
-
string
ID de projet ou nom du projet
- name
-
string
Si spécifié, filtre les définitions dont les noms correspondent à ce modèle.
- repositoryId
-
string
ID de référentiel. Si elle est spécifiée, filtre les définitions qui utilisent ce référentiel.
- repositoryType
-
string
Si elle est spécifiée, filtre les définitions qui ont un référentiel de ce type.
- queryOrder
- DefinitionQueryOrder
Indique l’ordre dans lequel les définitions doivent être retournées.
- top
-
number
Nombre maximal de définitions à retourner.
- continuationToken
-
string
Jeton de continuation, retourné par un appel précédent à cette méthode, qui peut être utilisé pour retourner le jeu de définitions suivant.
- minMetricsTime
-
Date
Si elle est spécifiée, indique la date à partir de laquelle les métriques doivent être incluses.
- definitionIds
-
number[]
Liste délimitée par des virgules qui spécifie les ID des définitions à récupérer.
- path
-
string
Si elle est spécifiée, filtre les définitions sous ce dossier.
- builtAfter
-
Date
Si elle est spécifiée, filtre les définitions qui ont des builds après cette date.
- notBuiltAfter
-
Date
Si elle est spécifiée, filtre les définitions qui n’ont pas de builds après cette date.
- includeAllProperties
-
boolean
Indique si les définitions complètes doivent être retournées. Par défaut, les représentations superficielles des définitions sont retournées.
- includeLatestBuilds
-
boolean
Indique s’il faut retourner les builds les plus récentes et les plus récentes pour cette définition.
- taskIdFilter
-
string
Si elle est spécifiée, filtre les définitions qui utilisent la tâche spécifiée.
- processType
-
number
Si elle est spécifiée, filtre les définitions avec le type de processus donné.
- yamlFilename
-
string
Si elle est spécifiée, filtre les définitions YAML qui correspondent au nom de fichier donné. Pour utiliser ce filtre includeAllProperties, la valeur true doit être définie
Retours
Promise<PagedList<BuildDefinitionReference>>
getDefinitionTags(string, number, number)
Il obtient les tags pour une définition.
function getDefinitionTags(project: string, definitionId: number, revision?: number): Promise<string[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
- revision
-
number
Numéro de révision de définition. Si ce n’est pas spécifié, utilise la dernière révision de la définition.
Retours
Promise<string[]>
getDefinitionYaml(string, number, number, Date, string[], boolean)
Convertit une définition en YAML, optionnellement à une révision spécifique.
function getDefinitionYaml(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<YamlBuild>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
- revision
-
number
Numéro de révision à récupérer. Si ce n’est pas spécifié, la dernière version est retournée.
- minMetricsTime
-
Date
Si elle est spécifiée, indique la date à partir de laquelle les métriques doivent être incluses.
- propertyFilters
-
string[]
Liste délimitée par des virgules de propriétés à inclure dans les résultats.
- includeLatestBuilds
-
boolean
Retours
Promise<YamlBuild>
getFile(string, number, string, string, string)
Il obtient un fichier de la compilation.
function getFile(project: string, buildId: number, artifactName: string, fileId: string, fileName: string): Promise<ArrayBuffer>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
- artifactName
-
string
Nom de l’artefact.
- fileId
-
string
La clé principale du fichier.
- fileName
-
string
Le nom auquel le fichier sera défini.
Retours
Promise<ArrayBuffer>
getFileContents(string, string, string, string, string, string)
Obtient le contenu d’un fichier dans le dépôt de code source donné.
function getFileContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<string>
Paramètres
- project
-
string
ID de projet ou nom du projet
- providerName
-
string
Nom du fournisseur source.
- serviceEndpointId
-
string
Si elle est spécifiée, l’ID du point de terminaison de service à interroger. Ne peut être omis que pour les fournisseurs qui n’utilisent pas de points de terminaison de service, par exemple TFVC ou TFGit.
- repository
-
string
Si spécifié, l’identifiant spécifique au fournisseur ou le nom du dépôt pour obtenir les branches. Ne peut être omis que pour les fournisseurs qui ne prennent pas en charge plusieurs référentiels.
- commitOrBranch
-
string
L’identifiant du commit ou de la branche à partir duquel le contenu d’un fichier est récupéré.
- path
-
string
Le chemin vers le fichier à récupérer, par rapport à la racine du dépôt.
Retours
Promise<string>
getFolders(string, string, FolderQueryOrder)
Obtient une liste des dossiers de définition de build.
function getFolders(project: string, path?: string, queryOrder?: FolderQueryOrder): Promise<Folder[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- path
-
string
Le chemin par lequel commencer.
- queryOrder
- FolderQueryOrder
L’ordre dans lequel les dossiers doivent être retournés.
Retours
Promise<Folder[]>
getLatestBuild(string, string, string)
Obtient la dernière build d’une définition, éventuellement délimitée à une branche spécifique.
function getLatestBuild(project: string, definition: string, branchName?: string): Promise<Build>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definition
-
string
nom de définition avec un chemin de dossier de début facultatif ou l’ID de définition
- branchName
-
string
paramètre facultatif qui indique la branche spécifique à utiliser. Si elle n’est pas spécifiée, la branche par défaut est utilisée.
Retours
Promise<Build>
getPathContents(string, string, string, string, string, string)
Obtient le contenu d’un répertoire dans le dépôt de code source donné.
function getPathContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<SourceRepositoryItem[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- providerName
-
string
Nom du fournisseur source.
- serviceEndpointId
-
string
Si elle est spécifiée, l’ID du point de terminaison de service à interroger. Ne peut être omis que pour les fournisseurs qui n’utilisent pas de points de terminaison de service, par exemple TFVC ou TFGit.
- repository
-
string
Si spécifié, l’identifiant spécifique au fournisseur ou le nom du dépôt pour obtenir les branches. Ne peut être omis que pour les fournisseurs qui ne prennent pas en charge plusieurs référentiels.
- commitOrBranch
-
string
L’identifiant du commit ou de la branche à partir duquel le contenu d’un fichier est récupéré.
- path
-
string
Le contenu du chemin à lister, par rapport à la racine du dépôt.
Retours
Promise<SourceRepositoryItem[]>
getProjectMetrics(string, string, Date)
Obtient les métriques de build pour un projet.
function getProjectMetrics(project: string, metricAggregationType?: string, minMetricsTime?: Date): Promise<BuildMetric[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- metricAggregationType
-
string
Le type d’agrégation à utiliser (horaire, quotidien).
- minMetricsTime
-
Date
La date à partir de laquelle calculer les métriques.
Retours
Promise<BuildMetric[]>
getProjectResources(string, string, string)
function getProjectResources(project: string, type?: string, id?: string): Promise<DefinitionResourceReference[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- type
-
string
- id
-
string
Retours
Promise<DefinitionResourceReference[]>
getPullRequest(string, string, string, string, string)
Obtient un objet pull request du fournisseur source.
function getPullRequest(project: string, providerName: string, pullRequestId: string, repositoryId?: string, serviceEndpointId?: string): Promise<PullRequest>
Paramètres
- project
-
string
ID de projet ou nom du projet
- providerName
-
string
Nom du fournisseur source.
- pullRequestId
-
string
Identifiant spécifique au fournisseur de la pull request.
- repositoryId
-
string
Identifiant spécifique au fournisseur ou nom du dépôt contenant la pull request.
- serviceEndpointId
-
string
Si elle est spécifiée, l’ID du point de terminaison de service à interroger. Ne peut être omis que pour les fournisseurs qui n’utilisent pas de points de terminaison de service, par exemple TFVC ou TFGit.
Retours
Promise<PullRequest>
getResourceUsage()
Obtient des informations sur les ressources de construction dans le système.
function getResourceUsage(): Promise<BuildResourceUsage>
Retours
Promise<BuildResourceUsage>
getRetentionHistory(number)
Retourne l’historique de conservation de la collection du projet. Cela inclut les pipelines ayant des règles de rétention personnalisées pouvant empêcher la tâche de rétention de les nettoyer, les exécutions par pipeline avec type de rétention, les fichiers associés aux pipelines appartenant à la collection avec type de rétention, et le nombre de fichiers par pipeline.
function getRetentionHistory(daysToLookback?: number): Promise<BuildRetentionHistory>
Paramètres
- daysToLookback
-
number
Retours
Promise<BuildRetentionHistory>
getRetentionLease(string, number)
Retourne les détails du bail de conservation avec un identifiant de location.
function getRetentionLease(project: string, leaseId: number): Promise<RetentionLease>
Paramètres
- project
-
string
ID de projet ou nom du projet
- leaseId
-
number
Retours
Promise<RetentionLease>
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])
Restitue tous les baux correspondant aux baux MinimumRetentionBahns spécifiés
function getRetentionLeasesByMinimalRetentionLeases(project: string, leasesToFetch: MinimalRetentionLease[]): Promise<RetentionLease[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- leasesToFetch
Liste des bailles MinimumRetentionBahn sérialisés en JSON, séparés par '|'
Retours
Promise<RetentionLease[]>
getRetentionLeasesByOwnerId(string, string, number, number)
Retourne tous les baux détenus par l’entité spécifiée, optionnellement limités à une seule définition et exécution de pipeline.
function getRetentionLeasesByOwnerId(project: string, ownerId?: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- ownerId
-
string
- definitionId
-
number
Un paramètre optionnel pour limiter la recherche à une définition spécifique du pipeline.
- runId
-
number
Un paramètre optionnel pour limiter la recherche à une seule exécution de pipeline. Nécessite définitionId.
Retours
Promise<RetentionLease[]>
getRetentionLeasesByUserId(string, string, number, number)
Renvoie tous les baux détenus par l’utilisateur spécifié, optionnellement divisés sur une seule définition et exécution du pipeline.
function getRetentionLeasesByUserId(project: string, userOwnerId: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- userOwnerId
-
string
L’identifiant utilisateur à rechercher.
- definitionId
-
number
Un paramètre optionnel pour limiter la recherche à une définition spécifique du pipeline.
- runId
-
number
Un paramètre optionnel pour limiter la recherche à une seule exécution de pipeline. Nécessite définitionId.
Retours
Promise<RetentionLease[]>
getRetentionLeasesForBuild(string, number)
Obtient tous les baux de rétention qui s’appliquent à un bâtiment spécifique.
function getRetentionLeasesForBuild(project: string, buildId: number): Promise<RetentionLease[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
Retours
Promise<RetentionLease[]>
getRetentionSettings(string)
Obtient les paramètres de rétention du projet.
function getRetentionSettings(project: string): Promise<ProjectRetentionSetting>
Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<ProjectRetentionSetting>
getStatusBadge(string, string, string, string, string, string, string)
<p>Obtient le statut de compilation pour une définition, optionnellement portée à une branche, une étape, un travail et une configuration spécifiques.</p><p>S’il y en a plus d’un, il est nécessaire de passer une valeur stageName lors de la spécification d’un jobName, et la même règle s’applique alors aux deux si on passe un paramètre de configuration.</p>
function getStatusBadge(project: string, definition: string, branchName?: string, stageName?: string, jobName?: string, configuration?: string, label?: string): Promise<string>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definition
-
string
Soit le nom de la définition avec le chemin optionnel du dossier en tête, soit l’id de définition.
- branchName
-
string
Ne considère que la version la plus récente pour cette branche. Si elle n’est pas spécifiée, la branche par défaut est utilisée.
- stageName
-
string
Utilisez cette étape dans le pipeline pour afficher le statut.
- jobName
-
string
Utilisez ce travail à une étape du pipeline pour afficher le statut.
- configuration
-
string
Utilisez cette configuration de travail pour afficher l’état
- label
-
string
Remplace le texte par défaut sur le côté gauche du badge.
Retours
Promise<string>
getTags(string)
Obtient une liste de toutes les balises de construction du projet.
function getTags(project: string): Promise<string[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<string[]>
getTemplate(string, string)
Obtient un modèle de définition de build spécifique.
function getTemplate(project: string, templateId: string): Promise<BuildDefinitionTemplate>
Paramètres
- project
-
string
ID de projet ou nom du projet
- templateId
-
string
ID du modèle demandé.
Retours
Promise<BuildDefinitionTemplate>
getTemplates(string)
Obtient tous les modèles de définition.
function getTemplates(project: string): Promise<BuildDefinitionTemplate[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<BuildDefinitionTemplate[]>
getWorkItemsBetweenBuilds(string, number, number, number)
Ça obtient tous les objets de travail entre deux builds.
function getWorkItemsBetweenBuilds(project: string, fromBuildId: number, toBuildId: number, top?: number): Promise<ResourceRef[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- fromBuildId
-
number
L’ID de la première version.
- toBuildId
-
number
L’ID de la dernière version.
- top
-
number
Le nombre maximal d’articles de travail à remettre.
Retours
Promise<ResourceRef[]>
listBranches(string, string, string, string, string)
Obtient une liste de branches pour le dépôt de code source donné.
function listBranches(project: string, providerName: string, serviceEndpointId?: string, repository?: string, branchName?: string): Promise<string[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- providerName
-
string
Nom du fournisseur source.
- serviceEndpointId
-
string
Si elle est spécifiée, l’ID du point de terminaison de service à interroger. Ne peut être omis que pour les fournisseurs qui n’utilisent pas de points de terminaison de service, par exemple TFVC ou TFGit.
- repository
-
string
L’identifiant spécifique au fournisseur ou le nom du dépôt pour obtenir les branches. Ne peut être omis que pour les fournisseurs qui ne prennent pas en charge plusieurs référentiels.
- branchName
-
string
Si cela est fourni, le nom de la branche à vérifier précisément.
Retours
Promise<string[]>
listRepositories(string, string, string, string, ResultSet, boolean, string)
Obtient une liste des dépôts du code source.
function listRepositories(project: string, providerName: string, serviceEndpointId?: string, repository?: string, resultSet?: ResultSet, pageResults?: boolean, continuationToken?: string): Promise<SourceRepositories>
Paramètres
- project
-
string
ID de projet ou nom du projet
- providerName
-
string
Nom du fournisseur source.
- serviceEndpointId
-
string
Si elle est spécifiée, l’ID du point de terminaison de service à interroger. Ne peut être omis que pour les fournisseurs qui n’utilisent pas de points de terminaison de service, par exemple TFVC ou TFGit.
- repository
-
string
Si spécifié, l’identifiant spécifique au fournisseur ou le nom d’un seul dépôt à obtenir.
- resultSet
- ResultSet
« top » pour les dépôts les plus pertinents pour le point de terminaison. Si elle n’est pas fixée, tous les dépôts sont retournés. Ignoré si « dépôt » est défini.
- pageResults
-
boolean
Si elle est réglée sur true, cela limitera l’ensemble des résultats et renverra un jeton de continuation pour poursuivre la requête.
- continuationToken
-
string
Lorsque la pagination résulte, il s’agit d’un jeton de continuation, retourné par un appel précédent à cette méthode, qui peut être utilisé pour retourner l’ensemble suivant de dépôts.
Retours
Promise<SourceRepositories>
listSourceProviders(string)
Obtenez une liste des fournisseurs de sources et de leurs capacités.
function listSourceProviders(project: string): Promise<SourceProviderAttributes[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
Retours
Promise<SourceProviderAttributes[]>
listWebhooks(string, string, string, string)
Obtient une liste de webhooks installés dans le référentiel de code source donné.
function listWebhooks(project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<RepositoryWebhook[]>
Paramètres
- project
-
string
ID de projet ou nom du projet
- providerName
-
string
Nom du fournisseur source.
- serviceEndpointId
-
string
Si elle est spécifiée, l’ID du point de terminaison de service à interroger. Ne peut être omis que pour les fournisseurs qui n’utilisent pas de points de terminaison de service, par exemple TFVC ou TFGit.
- repository
-
string
S’il est spécifié, l’identificateur spécifique au fournisseur ou le nom du référentiel pour obtenir des webhooks. Ne peut être omis que pour les fournisseurs qui ne prennent pas en charge plusieurs référentiels.
Retours
Promise<RepositoryWebhook[]>
queueBuild(Build, string, boolean, string, number, number)
Met en file d’attente une build
function queueBuild(build: Build, project: string, ignoreWarnings?: boolean, checkInTicket?: string, sourceBuildId?: number, definitionId?: number): Promise<Build>
Paramètres
- build
- Build
- project
-
string
ID de projet ou nom du projet
- ignoreWarnings
-
boolean
- checkInTicket
-
string
- sourceBuildId
-
number
- definitionId
-
number
ID de définition facultatif pour mettre en file d’attente une build sans corps. Ignoré s’il existe un corps valide
Retours
Promise<Build>
restoreDefinition(string, number, boolean)
Restaure une définition supprimée
function restoreDefinition(project: string, definitionId: number, deleted: boolean): Promise<BuildDefinition>
Paramètres
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
Identificateur de la définition à restaurer.
- deleted
-
boolean
Lorsque la valeur est false, restaure une définition supprimée.
Retours
Promise<BuildDefinition>
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)
Recrée les webhooks pour les déclencheurs spécifiés dans le dépôt de code source donné.
function restoreWebhooks(triggerTypes: DefinitionTriggerType[], project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<void>
Paramètres
- triggerTypes
Les types de déclencheurs pour restaurer les webhooks.
- project
-
string
ID de projet ou nom du projet
- providerName
-
string
Nom du fournisseur source.
- serviceEndpointId
-
string
Si elle est spécifiée, l’ID du point de terminaison de service à interroger. Ne peut être omis que pour les fournisseurs qui n’utilisent pas de points de terminaison de service, par exemple TFVC ou TFGit.
- repository
-
string
S’il est spécifié, l’identificateur spécifique au fournisseur ou le nom du référentiel pour obtenir des webhooks. Ne peut être omis que pour les fournisseurs qui ne prennent pas en charge plusieurs référentiels.
Retours
Promise<void>
saveTemplate(BuildDefinitionTemplate, string, string)
Met à jour un modèle de définition de build existant.
function saveTemplate(template: BuildDefinitionTemplate, project: string, templateId: string): Promise<BuildDefinitionTemplate>
Paramètres
- template
- BuildDefinitionTemplate
La nouvelle version du modèle.
- project
-
string
ID de projet ou nom du projet
- templateId
-
string
ID du modèle.
Retours
Promise<BuildDefinitionTemplate>
updateBuild(Build, string, number, boolean)
updateBuildGeneralSettings(PipelineGeneralSettings, string)
Mise à jour des paramètres généraux du pipeline.
function updateBuildGeneralSettings(newSettings: PipelineGeneralSettings, project: string): Promise<PipelineGeneralSettings>
Paramètres
- newSettings
- PipelineGeneralSettings
- project
-
string
ID de projet ou nom du projet
Retours
Promise<PipelineGeneralSettings>
updateBuildProperties(JsonPatchDocument, string, number)
Met à jour les propriétés d’une configuration.
function updateBuildProperties(document: JsonPatchDocument, project: string, buildId: number): Promise<any>
Paramètres
- document
- JsonPatchDocument
Un document json-patch décrivant les propriétés à mettre à jour.
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
Retours
Promise<any>
updateBuilds(Build[], string)
updateBuildSettings(BuildSettings, string)
Met à jour les paramètres de configuration.
function updateBuildSettings(settings: BuildSettings, project?: string): Promise<BuildSettings>
Paramètres
- settings
- BuildSettings
Les nouveaux réglages.
- project
-
string
ID de projet ou nom du projet
Retours
Promise<BuildSettings>
updateBuildTags(UpdateTagParameters, string, number)
Ajoute/Supprime des tags d’une construction.
function updateBuildTags(updateParameters: UpdateTagParameters, project: string, buildId: number): Promise<string[]>
Paramètres
- updateParameters
- UpdateTagParameters
Les tags à ajouter/retirer.
- project
-
string
ID de projet ou nom du projet
- buildId
-
number
ID de la build.
Retours
Promise<string[]>
updateDefinition(BuildDefinition, string, number, number, number, boolean)
Met à jour une définition de build existante. Pour que cette opération réussisse, la valeur de la propriété « Revision » du corps de la demande doit correspondre à celle de la définition de build existante. Il est recommandé d’obtenir la définition de build existante à l’aide de GET, de modifier la définition de build si nécessaire, puis d’envoyer la définition modifiée avec PUT.
function updateDefinition(definition: BuildDefinition, project: string, definitionId: number, secretsSourceDefinitionId?: number, secretsSourceDefinitionRevision?: number, cancelPausedBuilds?: boolean): Promise<BuildDefinition>
Paramètres
- definition
- BuildDefinition
La nouvelle version de la définition. Sa propriété « Révision » doit correspondre à la définition existante pour que la mise à jour soit acceptée.
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
- secretsSourceDefinitionId
-
number
ID facultatif de la définition à utiliser comme source pour les secrets.
- secretsSourceDefinitionRevision
-
number
Révision facultative de la définition de la source de secrets.
- cancelPausedBuilds
-
boolean
Si la valeur est true, annule les builds suspendues lorsque le pipeline est activé à partir d’un état suspendu ou désactivé.
Retours
Promise<BuildDefinition>
updateDefinitionProperties(JsonPatchDocument, string, number)
Met à jour les propriétés pour une définition.
function updateDefinitionProperties(document: JsonPatchDocument, project: string, definitionId: number): Promise<any>
Paramètres
- document
- JsonPatchDocument
Un document json-patch décrivant les propriétés à mettre à jour.
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
Retours
Promise<any>
updateDefinitionTags(UpdateTagParameters, string, number)
Ajoute/Supprime des tags d’une définition.
function updateDefinitionTags(updateParameters: UpdateTagParameters, project: string, definitionId: number): Promise<string[]>
Paramètres
- updateParameters
- UpdateTagParameters
Les tags à ajouter/retirer.
- project
-
string
ID de projet ou nom du projet
- definitionId
-
number
ID de la définition.
Retours
Promise<string[]>
updateFolder(Folder, string, string)
Met à jour un dossier existant au chemin existant donné
function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>
Paramètres
- folder
- Folder
La nouvelle version du dossier.
- project
-
string
ID de projet ou nom du projet
- path
-
string
Chemin d’accès complet au dossier.
Retours
Promise<Folder>
updateRetentionLease(RetentionLeaseUpdate, string, number)
Met à jour la durée ou l’état de protection du pipeline d’un bail de conservation.
function updateRetentionLease(leaseUpdate: RetentionLeaseUpdate, project: string, leaseId: number): Promise<RetentionLease>
Paramètres
- leaseUpdate
- RetentionLeaseUpdate
Les nouvelles données pour le bail de conservation.
- project
-
string
ID de projet ou nom du projet
- leaseId
-
number
L’ID du bail à mettre à jour.
Retours
Promise<RetentionLease>
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)
Met à jour les paramètres de rétention du projet.
function updateRetentionSettings(updateModel: UpdateProjectRetentionSettingModel, project: string): Promise<ProjectRetentionSetting>
Paramètres
- updateModel
- UpdateProjectRetentionSettingModel
- project
-
string
ID de projet ou nom du projet
Retours
Promise<ProjectRetentionSetting>
updateStage(UpdateStageParameters, number, string, string)
Mettre à jour une phase de génération
function updateStage(updateParameters: UpdateStageParameters, buildId: number, stageRefName: string, project?: string): Promise<void>
Paramètres
- updateParameters
- UpdateStageParameters
- buildId
-
number
- stageRefName
-
string
- project
-
string
ID de projet ou nom du projet
Retours
Promise<void>