BuildRestClient class

Référence

Paquet:: azure-devops-extension-api

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

Extends: RestClientBase

Constructeurs

BuildRestClient(IVssRestClientOptions)

Propriétés

RESOURCE_AREA_ID

Méthodes

addBuildTag(string, number, string)	Ajoute une balise à une build.
addBuildTags(string[], string, number)	Ajoute des balises à une build.
addDefinitionTag(string, number, string)	Ajoute une balise à une définition
addDefinitionTags(string[], string, number)	Ajoute plusieurs balises à une définition.
addRetentionLeases(NewRetentionLease[], string)	Ajoute de nouveaux baux pour les exécutions de pipeline.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Associe un artefact à une build.
createDefinition(BuildDefinition, string, number, number)	Crée une nouvelle définition.
createFolder(Folder, string, string)	Crée un dossier.
deleteBuild(string, number)	Supprime une build.
deleteBuildTag(string, number, string)	Supprime une balise d’une build. REMARQUE : Cette API ne fonctionne pas pour les balises avec des caractères spéciaux. Pour supprimer des balises avec des caractères spéciaux, utilisez plutôt la méthode PATCH (dans 6.0+)
deleteDefinition(string, number)	Supprime une définition et toutes les builds associées.
deleteDefinitionTag(string, number, string)	Supprime une balise d’une définition. REMARQUE : Cette API ne fonctionne pas pour les balises avec des caractères spéciaux. Pour supprimer des balises avec des caractères spéciaux, utilisez plutôt la méthode PATCH (dans 6.0+)
deleteFolder(string, string)	Supprime un dossier de définition. Les définitions et leurs builds correspondantes seront également supprimées.
deleteRetentionLeasesById(string, number[])	Supprime des baux de rétention spécifiques.
deleteTag(string, string)	Supprime une balise des builds, définitions et du magasin de balises
deleteTemplate(string, string)	Supprime un modèle de définition de build.
getArtifact(string, number, string)	Obtient un artefact spécifique pour une build.
getArtifactContentZip(string, number, string)	Obtient un artefact spécifique pour une build.
getArtifacts(string, number)	Obtient tous les artefacts d’une build.
getAttachment(string, number, string, string, string, string)	Obtient une pièce jointe spécifique.
getAttachments(string, number, string)	Obtient la liste des pièces jointes d’un type spécifique qui sont associées à une build.
getBadge(string, number, string)	Obtient un badge qui indique le status de la build la plus récente pour une définition. Notez que cette API est déconseillée. Préférez StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Obtient une build
getBuildBadge(string, string, string, string)	Obtient un badge qui indique le status de la build la plus récente pour la branche spécifiée.
getBuildBadgeData(string, string, string, string)	Obtient un badge qui indique le status de la build la plus récente pour la branche spécifiée.
getBuildChanges(string, number, string, number, boolean)	Obtient les modifications associées à une build
getBuildController(number)	Obtient un contrôleur
getBuildControllers(string)	Obtient le contrôleur, éventuellement filtré par nom
getBuildGeneralSettings(string)	Obtient les paramètres généraux du pipeline.
getBuildLog(string, number, number, number, number)	Obtient un fichier journal individuel pour une build.
getBuildLogLines(string, number, number, number, number)	Obtient un fichier journal individuel pour une build.
getBuildLogs(string, number)	Obtient les journaux d’activité d’une build.
getBuildLogsZip(string, number)	Obtient les journaux d’activité d’une build.
getBuildLogZip(string, number, number, number, number)	Obtient un fichier journal individuel pour une build.
getBuildOptionDefinitions(string)	Obtient toutes les options de définition de build prises en charge par le système.
getBuildProperties(string, number, string[])	Obtient les propriétés d’une build.
getBuildReport(string, number, string)	Obtient un rapport de build.
getBuildReportHtmlContent(string, number, string)	Obtient un rapport de build.
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.
getBuildSettings(string)	Obtient les paramètres de build.
getBuildTags(string, number)	Obtient les balises d’une build.
getBuildTimeline(string, number, string, number, string)	Obtient les détails d’une build
getBuildWorkItemsRefs(string, number, number)	Obtient les éléments de travail associés à une build. Seuls les éléments de travail du même projet sont retournés.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Obtient les éléments de travail associés à une build, filtrés selon des validations spécifiques.
getChangesBetweenBuilds(string, number, number, number)	Obtient les modifications apportées au dépôt entre deux builds données.
getDefinition(string, number, number, Date, string[], boolean)	Obtient une définition, éventuellement à une révision spécifique.
getDefinitionMetrics(string, number, Date)	Obtient les métriques de build pour une définition.
getDefinitionProperties(string, number, string[])	Obtient les propriétés d’une définition.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Obtient toutes les révisions d’une définition.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Obtient une liste de définitions.
getDefinitionTags(string, number, number)	Obtient les balises d’une définition.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Convertit une définition en YAML, éventuellement à une révision spécifique.
getFile(string, number, string, string, string)	Obtient un fichier de la build.
getFileContents(string, string, string, string, string, string)	Obtient le contenu d’un fichier dans le référentiel de code source donné.
getFolders(string, string, FolderQueryOrder)	Obtient une liste de dossiers de définition de build.
getLatestBuild(string, string, string)	Obtient la dernière build d’une définition, éventuellement étendue à une branche spécifique.
getPathContents(string, string, string, string, string, string)	Obtient le contenu d’un répertoire dans le référentiel de code source donné.
getProjectMetrics(string, string, Date)	Obtient les métriques de build pour un projet.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Obtient un objet de demande de tirage du fournisseur source.
getResourceUsage()	Obtient des informations sur les ressources de build dans le système.
getRetentionHistory(number)	Retourne l’historique de rétention de la collection de projets. Cela inclut les pipelines qui ont des règles de rétention personnalisées qui peuvent empêcher le travail de rétention de les nettoyer, les exécutions par pipeline avec le type de rétention, les fichiers associés aux pipelines appartenant à la collection avec le type de rétention et le nombre de fichiers par pipeline.
getRetentionLease(string, number)	Retourne les détails du bail de rétention en fonction d’un ID de bail.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Retourne tous les baux correspondant à la valeur MinimaleRetentionLeases spécifiée
getRetentionLeasesByOwnerId(string, string, number, number)	Retourne tous les baux appartenant à l’entité spécifiée, éventuellement limités à une définition de pipeline unique et exécutés.
getRetentionLeasesByUserId(string, string, number, number)	Retourne tous les baux appartenant à l’utilisateur spécifié, éventuellement limités à une définition de pipeline unique et exécutés.
getRetentionLeasesForBuild(string, number)	Obtient tous les baux de rétention qui s’appliquent à une build spécifique.
getRetentionSettings(string)	Obtient les paramètres de rétention du projet.
getStatusBadge(string, string, string, string, string, string, string)	<p>Obtient le status de build pour une définition, éventuellement étendue à une branche, une étape, un travail et une configuration spécifiques.< /p><p p>S’il y en a plusieurs, 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 ensuite aux deux lors du passage d’un paramètre de configuration.< /P>
getTags(string)	Obtient la liste de toutes les balises de build dans le projet.
getTemplate(string, string)	Obtient un modèle de définition de build spécifique.
getTemplates(string)	Obtient tous les modèles de définition.
getWorkItemsBetweenBuilds(string, number, number, number)	Obtient tous les éléments de travail entre deux builds.
listBranches(string, string, string, string, string)	Obtient une liste de branches pour le référentiel de code source donné.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Obtient une liste de référentiels de code source.
listSourceProviders(string)	Obtenez la liste des fournisseurs sources et leurs fonctionnalités.
listWebhooks(string, string, string, string)	Obtient la liste des webhooks installés dans le référentiel de code source donné.
queueBuild(Build, string, boolean, string, number, number)	Met en file d’attente une build
restoreDefinition(string, number, boolean)	Restaure une définition supprimée
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Recrée les webhooks pour les déclencheurs spécifiés dans le référentiel de code source donné.
saveTemplate(BuildDefinitionTemplate, string, string)	Mises à jour un modèle de définition de build existant.
updateBuild(Build, string, number, boolean)	Mises à jour une build.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Mises à jour paramètres généraux du pipeline.
updateBuildProperties(JsonPatchDocument, string, number)	Mises à jour propriétés d’une build.
updateBuilds(Build[], string)	Mises à jour plusieurs builds.
updateBuildSettings(BuildSettings, string)	Mises à jour les paramètres de build.
updateBuildTags(UpdateTagParameters, string, number)	Ajoute/supprime des étiquettes d’une build.
updateDefinition(BuildDefinition, string, number, number, number)	Mises à 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.
updateDefinitionProperties(JsonPatchDocument, string, number)	Mises à jour propriétés d’une définition.
updateDefinitionTags(UpdateTagParameters, string, number)	Ajoute/supprime des balises d’une définition.
updateFolder(Folder, string, string)	Mises à jour un dossier existant au chemin d’accès existant donné
updateRetentionLease(RetentionLeaseUpdate, string, number)	Mises à jour la durée ou la protection du pipeline status d’un bail de rétention.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Mises à jour les paramètres de rétention du projet.
updateStage(UpdateStageParameters, number, string, string)	Mettre à jour une phase de génération

Détails du constructeur

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(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

addBuildTag(string, number, string)

Ajoute une balise à une build.

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

Balise à ajouter.

Retours

Promise<string[]>

addBuildTags(string[], string, number)

Ajoute des balises à une build.

function addBuildTags(tags: string[], project: string, buildId: number): Promise<string[]>

Paramètres

tags: string[]

Balises à ajouter. Le corps de la requête est composé directement à partir des balises répertoriées.

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

Balise à ajouter.

Retours

Promise<string[]>

addDefinitionTags(string[], string, number)

Ajoute plusieurs balises à une définition.

function addDefinitionTags(tags: string[], project: string, definitionId: number): Promise<string[]>

Paramètres

tags: string[]

Balises à 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 exécutions de pipeline.

function addRetentionLeases(newLeases: NewRetentionLease[], project: string): Promise<RetentionLease[]>

Paramètres

newLeases: NewRetentionLease[]

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: DefinitionResourceReference[]

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: DefinitionResourceReference[]

project: string

ID de projet ou nom du projet

Retours

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Associe un artefact à une build.

function createArtifact(artifact: BuildArtifact, project: string, buildId: number): Promise<BuildArtifact>

Paramètres

artifact: BuildArtifact

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

Crée un dossier.

function createFolder(folder: Folder, project: string, path: string): Promise<Folder>

Paramètres

folder: Folder

Dossier.

project: string

ID de projet ou nom du projet

path: string

Chemin d’accès complet du dossier.

Retours

Promise<Folder>

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)

Supprime une balise d’une build. REMARQUE : Cette API ne fonctionne pas pour les balises avec des caractères spéciaux. Pour supprimer des balises avec des caractères spéciaux, utilisez plutôt la méthode PATCH (dans 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

Balise à supprimer.

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 une balise d’une définition. REMARQUE : Cette API ne fonctionne pas pour les balises avec des caractères spéciaux. Pour supprimer des balises avec des caractères spéciaux, utilisez plutôt la méthode PATCH (dans 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

Balise à supprimer.

Retours

Promise<string[]>

deleteFolder(string, string)

Supprime un dossier de définition. Les définitions et leurs builds 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[])

Supprime des baux de rétention spécifiques.

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 une balise des builds, définitions et du magasin de balises

function deleteTag(project: string, tag: string): Promise<string[]>

Paramètres

project: string

ID de projet ou nom du projet

tag: string

Balise à supprimer.

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

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

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)

Obtient tous les artefacts d’une build.

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)

Obtient une pièce jointe 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 du chronologie.

recordId: string

ID de l’enregistrement chronologie.

type: string

Type de la pièce jointe.

name: string

Nom de la pièce jointe.

Retours

Promise<ArrayBuffer>

getAttachments(string, number, string)

Obtient la liste des pièces jointes d’un type spécifique qui sont associées à une build.

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 status de la build la plus récente pour une définition. Notez que cette API est déconseillée. Préférez StatusBadgeController.GetStatusBadge.

function getBadge(project: string, definitionId: number, branchName?: string): Promise<string>

Paramètres

project: string

ID ou nom du projet.

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 status de la build la plus récente 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

Type de dépôt.

repoId: string

ID du dépôt.

branchName: string

Nom de la branche.

Retours

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Obtient un badge qui indique le status de la build la plus récente 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

Type de dépôt.

repoId: string

ID du dépôt.

branchName: string

Nom de la branche.

Retours

Promise<string>

getBuildChanges(string, number, string, number, boolean)

Obtient les modifications associées à une build

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

Nombre maximal de modifications à retourner

includeSourceChange: boolean

Retours

Promise<PagedList<Change>>

getBuildController(number)

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

Obtient les paramètres 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 build.

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

ID du fichier journal.

startLine: number

Ligne de début.

endLine: number

Ligne de fin.

Retours

Promise<string>

getBuildLogLines(string, number, number, number, number)

Obtient un fichier journal individuel pour une build.

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

ID du fichier journal.

startLine: number

Ligne de début.

endLine: number

Ligne de fin.

Retours

Promise<string[]>

getBuildLogs(string, number)

Obtient les journaux d’activité d’une build.

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)

Obtient les journaux d’activité d’une build.

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

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

ID du fichier journal.

startLine: number

Ligne de début.

endLine: number

Ligne de fin.

Retours

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Obtient 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 les propriétés d’une build.

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

Liste de propriétés délimitées par des virgules. S’il est spécifié, filtre ces propriétés spécifiques.

Retours

Promise<any>

getBuildReport(string, number, string)

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

Obtient 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. S’il est spécifié, filtre les builds pour ces définitions.

queues: number[]

Liste délimitée par des virgules d’ID de file d’attente. S’il est spécifié, filtre les builds qui se sont exécutées sur ces files d’attente.

buildNumber: string

S’il est spécifié, filtre les builds qui correspondent à ce numéro de build. Ajoutez * pour effectuer une recherche de préfixe.

minTime: Date

Si spécifié, filtre les builds qui se sont terminées/démarrées/mises en file d’attente après cette date en fonction de l’objet queryOrder spécifié.

maxTime: Date

S’il est spécifié, filtre les builds qui se sont terminées/démarrées/mises en file d’attente avant cette date en fonction de l’ordre de requête spécifié.

requestedFor: string

S’il est spécifié, 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

S’il est spécifié, filtre les builds qui correspondent à cette status.

resultFilter: BuildResult

S’il est spécifié, filtre les builds qui correspondent à ce résultat.

tagFilters: string[]

Liste de balises délimitées par des virgules. S’il est spécifié, 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 renvoyer uniquement les builds supprimées.

queryOrder: BuildQueryOrder

Ordre dans lequel les builds doivent être retournées.

branchName: string

Si spécifié, filtre pour les builds qui ont généré les 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

S’il est spécifié, filtre les builds créées à partir de ce dépôt.

repositoryType: string

S’il est spécifié, filtre les builds qui sont générées à partir de référentiels de ce type.

Retours

Promise<PagedList<Build>>

getBuildSettings(string)

Obtient les paramètres de build.

function getBuildSettings(project?: string): Promise<BuildSettings>

Paramètres

project: string

ID de projet ou nom du projet

Retours

Promise<BuildSettings>

getBuildTags(string, number)

Obtient les balises d’une build.

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 build

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 éléments de travail associés à une build. Seuls les éléments de travail 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

Nombre maximal d’éléments de travail à retourner.

Retours

Promise<ResourceRef[]>

getBuildWorkItemsRefsFromCommits(string[], string, number, number)

Obtient les éléments de travail associés à une build, filtrés selon des validations spécifiques.

function getBuildWorkItemsRefsFromCommits(commitIds: string[], project: string, buildId: number, top?: number): Promise<ResourceRef[]>

Paramètres

commitIds: string[]

Liste délimitée par des virgules d’ID de validation.

project: string

ID de projet ou nom du projet

buildId: number

ID de la build.

top: number

Nombre maximal d’éléments de travail à retourner ou nombre de commits à prendre en compte si aucun ID de validation 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ées.

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

ID de la première build.

toBuildId: number

ID de la dernière build.

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 version la plus récente 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 des propriétés à inclure dans les résultats.

includeLatestBuilds: boolean

Retours

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

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

Date à partir de laquelle calculer les métriques.

Retours

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Obtient les propriétés d’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[]

Liste de propriétés délimitées par des virgules. S’il est spécifié, filtre 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

S’il est spécifié, filtre les définitions dont les noms correspondent à ce modèle.

repositoryId: string

ID de dépôt. S’il est spécifié, filtre les définitions qui utilisent ce référentiel.

repositoryType: string

S’il est spécifié, filtre sur 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 l’ensemble 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

S’il est spécifié, filtre sur les définitions de ce dossier.

builtAfter: Date

S’il est spécifié, filtre les définitions qui ont des builds après cette date.

notBuiltAfter: Date

S’il est spécifié, 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 dernières versions terminées 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

S’il est spécifié, filtre les définitions avec le type de processus donné.

yamlFilename: string

S’il est spécifié, filtre les définitions YAML qui correspondent au nom de fichier donné. Pour utiliser ce filtre, includeAllProperties doit être défini sur true

Retours

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Obtient les balises d’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. S’il 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, éventuellement à 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 version la plus récente 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 des propriétés à inclure dans les résultats.

includeLatestBuilds: boolean

Retours

Promise<YamlBuild>

getFile(string, number, string, string, string)

Obtient un fichier de la build.

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

Clé primaire du fichier.

fileName: string

Nom sur lequel le fichier sera défini.

Retours

Promise<ArrayBuffer>

getFileContents(string, string, string, string, string, string)

Obtient le contenu d’un fichier dans le référentiel 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

S’il est spécifié, 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 dépôt pour obtenir les branches. Ne peut être omis que pour les fournisseurs qui ne prennent pas en charge plusieurs dépôts.

commitOrBranch: string

Identificateur de la validation ou de la branche à partir de laquelle le contenu d’un fichier est récupéré.

path: string

Chemin d’accès au fichier à récupérer, par rapport à la racine du dépôt.

Retours

Promise<string>

getFolders(string, string, FolderQueryOrder)

Obtient une liste de 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

Chemin d’accès à partir de laquelle commencer.

queryOrder: FolderQueryOrder

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 étendue à 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 la définition avec le chemin d’accès du dossier de début facultatif ou l’ID de définition

branchName: string

paramètre facultatif qui indique la branche spécifique à utiliser. S’il n’est pas spécifié, le branche par défaut est utilisé.

Retours

Promise<Build>

getPathContents(string, string, string, string, string, string)

Obtient le contenu d’un répertoire dans le référentiel 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

repository: string

commitOrBranch: string

Identificateur de la validation ou de la branche à partir de laquelle le contenu d’un fichier est récupéré.

path: string

Contenu du chemin d’accès à lister, relatif à 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

Type d’agrégation à utiliser (toutes les heures, tous les jours).

minMetricsTime: Date

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 de demande de tirage 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

ID propre au fournisseur de la demande de tirage.

repositoryId: string

Identificateur spécifique au fournisseur ou nom du dépôt qui contient la demande de tirage.

serviceEndpointId: string

Retours

Promise<PullRequest>

getResourceUsage()

Obtient des informations sur les ressources de build dans le système.

function getResourceUsage(): Promise<BuildResourceUsage>

Retours

Promise<BuildResourceUsage>

getRetentionHistory(number)

Retourne l’historique de rétention de la collection de projets. Cela inclut les pipelines qui ont des règles de rétention personnalisées qui peuvent empêcher le travail de rétention de les nettoyer, les exécutions par pipeline avec le type de rétention, les fichiers associés aux pipelines appartenant à la collection avec le 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 rétention en fonction d’un ID de bail.

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[])

Retourne tous les baux correspondant à la valeur MinimaleRetentionLeases spécifiée

function getRetentionLeasesByMinimalRetentionLeases(project: string, leasesToFetch: MinimalRetentionLease[]): Promise<RetentionLease[]>

Paramètres

project: string

ID de projet ou nom du projet

leasesToFetch: MinimalRetentionLease[]

Liste des MinimalRetentionLeases sérialisés json séparés par « | »

Retours

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Retourne tous les baux appartenant à l’entité spécifiée, éventuellement limités à une définition de pipeline unique et exécutés.

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

Paramètre facultatif pour limiter la recherche à une définition de pipeline spécifique.

runId: number

Paramètre facultatif pour limiter la recherche à une seule exécution de pipeline. Nécessite definitionId.

Retours

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Retourne tous les baux appartenant à l’utilisateur spécifié, éventuellement limités à une définition de pipeline unique et exécutés.

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

ID d’utilisateur à rechercher.

definitionId: number

Paramètre facultatif pour limiter la recherche à une définition de pipeline spécifique.

runId: number

Paramètre facultatif pour limiter la recherche à une seule exécution de pipeline. Nécessite definitionId.

Retours

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Obtient tous les baux de rétention qui s’appliquent à une build 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 status de build pour une définition, éventuellement étendue à une branche, une étape, un travail et une configuration spécifiques.< /p><p p>S’il y en a plusieurs, 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 ensuite aux deux lors du passage d’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 du dossier de début facultatif, soit l’ID de définition.

branchName: string

Considérez uniquement la build la plus récente pour cette branche. S’il n’est pas spécifié, le branche par défaut est utilisé.

stageName: string

Utilisez cette étape dans le pipeline pour afficher le status.

jobName: string

Utilisez ce travail dans une phase du pipeline pour afficher le status.

configuration: string

Utilisez cette configuration de travail pour afficher le status

label: string

Remplace le texte par défaut sur le côté gauche du badge.

Retours

Promise<string>

getTags(string)

Obtient la liste de toutes les balises de build dans le 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)

Obtient tous les éléments 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

ID de la première build.

toBuildId: number

ID de la dernière build.

top: number

Nombre maximal d’éléments de travail à retourner.

Retours

Promise<ResourceRef[]>

listBranches(string, string, string, string, string)

Obtient une liste de branches pour le référentiel 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

repository: string

Identificateur spécifique au fournisseur ou nom du dépôt pour obtenir des branches. Ne peut être omis que pour les fournisseurs qui ne prennent pas en charge plusieurs dépôts.

branchName: string

S’il est fourni, le nom de la branche à case activée spécifiquement.

Retours

Promise<string[]>

listRepositories(string, string, string, string, ResultSet, boolean, string)

Obtient une liste de référentiels de 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

repository: string

S’il est spécifié, l’identificateur spécifique au fournisseur ou le nom d’un dépôt unique à obtenir.

resultSet: ResultSet

« top » pour les dépôts les plus pertinents pour le point de terminaison. S’il n’est pas défini, tous les référentiels sont retournés. Ignoré si ' repository' est défini.

pageResults: boolean

Si la valeur est true, l’ensemble des résultats est limité et retourne un jeton de continuation pour poursuivre la requête.

continuationToken: string

Lors de la pagination des résultats, 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 de référentiels suivant.

Retours

Promise<SourceRepositories>

listSourceProviders(string)

Obtenez la liste des fournisseurs sources et leurs fonctionnalité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 la liste des 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

repository: string

S’il est spécifié, l’identificateur spécifique au fournisseur ou le nom du dépôt pour obtenir les webhooks. Ne peut être omis que pour les fournisseurs qui ne prennent pas en charge plusieurs dépôts.

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 référentiel de code source donné.

function restoreWebhooks(triggerTypes: DefinitionTriggerType[], project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<void>

Paramètres

triggerTypes: DefinitionTriggerType[]

Types de déclencheurs pour 1000 à restaurer.

project: string

ID de projet ou nom du projet

providerName: string

Nom du fournisseur source.

serviceEndpointId: string

repository: string

Retours

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Mises à jour un modèle de définition de build existant.

function saveTemplate(template: BuildDefinitionTemplate, project: string, templateId: string): Promise<BuildDefinitionTemplate>

Paramètres

template: BuildDefinitionTemplate

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)

Mises à jour une build.

function updateBuild(build: Build, project: string, buildId: number, retry?: boolean): Promise<Build>

Paramètres

build: Build

Build.

project: string

ID de projet ou nom du projet

buildId: number

ID de la build.

retry: boolean

Retours

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Mises à jour 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)

Mises à jour propriétés d’une build.

function updateBuildProperties(document: JsonPatchDocument, project: string, buildId: number): Promise<any>

Paramètres

document: JsonPatchDocument

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)

Mises à jour plusieurs builds.

function updateBuilds(builds: Build[], project: string): Promise<Build[]>

Paramètres

builds: Build[]

Builds à mettre à jour.

project: string

ID de projet ou nom du projet

Retours

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Mises à jour les paramètres de build.

function updateBuildSettings(settings: BuildSettings, project?: string): Promise<BuildSettings>

Paramètres

settings: BuildSettings

Les nouveaux paramètres.

project: string

ID de projet ou nom du projet

Retours

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Ajoute/supprime des étiquettes d’une build.

function updateBuildTags(updateParameters: UpdateTagParameters, project: string, buildId: number): Promise<string[]>

Paramètres

updateParameters: UpdateTagParameters

Balises à ajouter/supprimer.

project: string

ID de projet ou nom du projet

buildId: number

ID de la build.

Retours

Promise<string[]>

updateDefinition(BuildDefinition, string, number, number, number)

Mises à 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): Promise<BuildDefinition>

Paramètres

definition: BuildDefinition

Nouvelle version de la définition. Sa propriété « Revision » 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

secretsSourceDefinitionRevision: number

Retours

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Mises à jour propriétés d’une définition.

function updateDefinitionProperties(document: JsonPatchDocument, project: string, definitionId: number): Promise<any>

Paramètres

document: JsonPatchDocument

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 balises d’une définition.

function updateDefinitionTags(updateParameters: UpdateTagParameters, project: string, definitionId: number): Promise<string[]>

Paramètres

updateParameters: UpdateTagParameters

Balises à ajouter/supprimer.

project: string

ID de projet ou nom du projet

definitionId: number

ID de la définition.

Retours

Promise<string[]>

updateFolder(Folder, string, string)

Mises à jour un dossier existant au chemin d’accès existant donné

function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>

Paramètres

folder: Folder

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)

Mises à jour la durée ou la protection du pipeline status d’un bail de rétention.

function updateRetentionLease(leaseUpdate: RetentionLeaseUpdate, project: string, leaseId: number): Promise<RetentionLease>

Paramètres

leaseUpdate: RetentionLeaseUpdate

Nouvelles données pour le bail de rétention.

project: string

ID de projet ou nom du projet

leaseId: number

ID du bail à mettre à jour.

Retours

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

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

Partager via

BuildRestClient class

Constructeurs

Propriétés

Méthodes

Détails du constructeur

BuildRestClient(IVssRestClientOptions)

Paramètres

Détails de la propriété

RESOURCE_AREA_ID

Valeur de propriété

Détails de la méthode

addBuildTag(string, number, string)

Paramètres

Retours

addBuildTags(string[], string, number)

Paramètres

Retours

addDefinitionTag(string, number, string)

Paramètres

Retours

addDefinitionTags(string[], string, number)

Paramètres

Retours

addRetentionLeases(NewRetentionLease[], string)

Paramètres

Retours

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Paramètres

Retours

authorizeProjectResources(DefinitionResourceReference[], string)

Paramètres

Retours

createArtifact(BuildArtifact, string, number)

Paramètres

Retours

createDefinition(BuildDefinition, string, number, number)

Paramètres

Retours

createFolder(Folder, string, string)

Paramètres

Retours

deleteBuild(string, number)

Paramètres

Retours

deleteBuildTag(string, number, string)

Paramètres

Retours

deleteDefinition(string, number)

Paramètres

Retours

deleteDefinitionTag(string, number, string)

Paramètres

Retours

deleteFolder(string, string)

Paramètres

Retours

deleteRetentionLeasesById(string, number[])

Paramètres

Retours

deleteTag(string, string)

Paramètres

Retours

deleteTemplate(string, string)

Paramètres

Retours

getArtifact(string, number, string)

Paramètres

Retours

getArtifactContentZip(string, number, string)

Paramètres

Retours

getArtifacts(string, number)

Paramètres

Retours

getAttachment(string, number, string, string, string, string)

Paramètres

Retours

getAttachments(string, number, string)

Paramètres