BuildRestClient class

Referentie

Pakket:: azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends: RestClientBase

Constructors

BuildRestClient(IVssRestClientOptions)

Eigenschappen

RESOURCE_AREA_ID

Methoden

addBuildTag(string, number, string)	Hiermee voegt u een tag toe aan een build.
addBuildTags(string[], string, number)	Hiermee voegt u tags toe aan een build.
addDefinitionTag(string, number, string)	Een tag toevoegen aan een definitie
addDefinitionTags(string[], string, number)	Voegt meerdere tags toe aan een definitie.
addRetentionLeases(NewRetentionLease[], string)	Voegt nieuwe leases toe voor pijplijnuitvoeringen.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Koppelt een artefact aan een build.
createDefinition(BuildDefinition, string, number, number)	Hiermee maakt u een nieuwe definitie.
createFolder(Folder, string, string)	Maakt een nieuwe map.
deleteBuild(string, number)	Hiermee verwijdert u een build.
deleteBuildTag(string, number, string)	Hiermee verwijdert u een tag uit een build. OPMERKING: deze API werkt niet voor tags met speciale tekens. Als u tags met speciale tekens wilt verwijderen, gebruikt u in plaats daarvan de PATCH-methode (in 6.0+)
deleteDefinition(string, number)	Hiermee verwijdert u een definitie en alle bijbehorende builds.
deleteDefinitionTag(string, number, string)	Hiermee verwijdert u een tag uit een definitie. OPMERKING: deze API werkt niet voor tags met speciale tekens. Als u tags met speciale tekens wilt verwijderen, gebruikt u in plaats daarvan de PATCH-methode (in 6.0+)
deleteFolder(string, string)	Hiermee verwijdert u een definitiemap. Definities en de bijbehorende builds worden ook verwijderd.
deleteRetentionLeasesById(string, number[])	Hiermee verwijdert u specifieke retentieleases.
deleteTag(string, string)	Hiermee verwijdert u een tag uit builds, definities en uit het tagarchief
deleteTemplate(string, string)	Hiermee verwijdert u een sjabloon voor een builddefinitie.
getArtifact(string, number, string)	Hiermee haalt u een specifiek artefact voor een build op.
getArtifactContentZip(string, number, string)	Hiermee haalt u een specifiek artefact voor een build op.
getArtifacts(string, number)	Hiermee haalt u alle artefacten voor een build op.
getAttachment(string, number, string, string, string, string)	Hiermee haalt u een specifieke bijlage op.
getAttachments(string, number, string)	Hiermee haalt u de lijst met bijlagen van een specifiek type op die zijn gekoppeld aan een build.
getBadge(string, number, string)	Hiermee haalt u een badge op die de status van de meest recente build voor een definitie aangeeft. Houd er rekening mee dat deze API is afgeschaft. Geef de voorkeur aan StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Hiermee haalt u een build op
getBuildBadge(string, string, string, string)	Hiermee haalt u een badge op die de status van de meest recente build voor de opgegeven vertakking aangeeft.
getBuildBadgeData(string, string, string, string)	Hiermee haalt u een badge op die de status van de meest recente build voor de opgegeven vertakking aangeeft.
getBuildChanges(string, number, string, number, boolean)	Hiermee haalt u de wijzigingen op die zijn gekoppeld aan een build
getBuildController(number)	Hiermee haalt u een controller op
getBuildControllers(string)	Hiermee wordt de controller opgehaald, optioneel gefilterd op naam
getBuildGeneralSettings(string)	Hiermee haalt u de algemene instellingen voor de pijplijn op.
getBuildLog(string, number, number, number, number)	Hiermee haalt u een afzonderlijk logboekbestand voor een build op.
getBuildLogLines(string, number, number, number, number)	Hiermee haalt u een afzonderlijk logboekbestand voor een build op.
getBuildLogs(string, number)	Hiermee haalt u de logboeken voor een build op.
getBuildLogsZip(string, number)	Hiermee haalt u de logboeken voor een build op.
getBuildLogZip(string, number, number, number, number)	Hiermee haalt u een afzonderlijk logboekbestand voor een build op.
getBuildOptionDefinitions(string)	Hiermee haalt u alle opties voor builddefinities op die door het systeem worden ondersteund.
getBuildProperties(string, number, string[])	Hiermee haalt u eigenschappen voor een build op.
getBuildReport(string, number, string)	Hiermee haalt u een buildrapport op.
getBuildReportHtmlContent(string, number, string)	Hiermee haalt u een buildrapport op.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Hiermee haalt u een lijst met builds op.
getBuildSettings(string)	Hiermee haalt u de build-instellingen op.
getBuildTags(string, number)	Hiermee haalt u de tags voor een build op.
getBuildTimeline(string, number, string, number, string)	Hiermee haalt u details voor een build op
getBuildWorkItemsRefs(string, number, number)	Hiermee haalt u de werkitems op die zijn gekoppeld aan een build. Alleen werkitems in hetzelfde project worden geretourneerd.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Hiermee haalt u de werkitems op die zijn gekoppeld aan een build, gefilterd op specifieke doorvoeringen.
getChangesBetweenBuilds(string, number, number, number)	Hiermee haalt u de wijzigingen op die zijn aangebracht in de opslagplaats tussen twee opgegeven builds.
getDefinition(string, number, number, Date, string[], boolean)	Haalt een definitie op, optioneel bij een specifieke revisie.
getDefinitionMetrics(string, number, Date)	Hiermee worden metrische gegevens voor een definitie gemaakt.
getDefinitionProperties(string, number, string[])	Hiermee haalt u eigenschappen voor een definitie op.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Hiermee haalt u alle revisies van een definitie op.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Hiermee haalt u een lijst met definities op.
getDefinitionTags(string, number, number)	Hiermee haalt u de tags voor een definitie op.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Converteert een definitie naar YAML, optioneel bij een specifieke revisie.
getFile(string, number, string, string, string)	Hiermee haalt u een bestand op uit de build.
getFileContents(string, string, string, string, string, string)	Hiermee haalt u de inhoud van een bestand op in de opgegeven broncodeopslagplaats.
getFolders(string, string, FolderQueryOrder)	Hiermee haalt u een lijst met mappen met builddefinities op.
getLatestBuild(string, string, string)	Hiermee haalt u de nieuwste build voor een definitie op, optioneel gericht op een specifieke vertakking.
getPathContents(string, string, string, string, string, string)	Hiermee haalt u de inhoud van een map op in de opgegeven broncodeopslagplaats.
getProjectMetrics(string, string, Date)	Hiermee worden metrische gegevens voor een project gemaakt.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Hiermee haalt u een pull-aanvraagobject op van de bronprovider.
getResourceUsage()	Hiermee haalt u informatie op over buildresources in het systeem.
getRetentionHistory(number)	Retourneert de retentiegeschiedenis voor de projectverzameling. Dit omvat pijplijnen met aangepaste bewaarregels die kunnen voorkomen dat de retentietaak deze opschont, uitvoeringen per pijplijn met retentietype, bestanden die zijn gekoppeld aan pijplijnen die eigendom zijn van de verzameling met het retentietype en het aantal bestanden per pijplijn.
getRetentionLease(string, number)	Retourneert de details van de retentielease met een lease-id.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Retourneert alle leases die overeenkomen met de opgegeven MinimalRetentionLeases
getRetentionLeasesByOwnerId(string, string, number, number)	Retourneert alle leases die eigendom zijn van de opgegeven entiteit, optioneel binnen het bereik van één pijplijndefinitie en uitvoeren.
getRetentionLeasesByUserId(string, string, number, number)	Retourneert alle leases die eigendom zijn van de opgegeven gebruiker, optioneel beperkt tot één pijplijndefinitie en worden uitgevoerd.
getRetentionLeasesForBuild(string, number)	Hiermee haalt u alle retentieleases op die van toepassing zijn op een specifieke build.
getRetentionSettings(string)	Hiermee haalt u de retentie-instellingen van het project op.
getStatusBadge(string, string, string, string, string, string, string)	<p>Haalt de buildstatus voor een definitie op, optioneel gericht op een specifieke vertakking, fase, taak en configuratie.< /p><p>Als er meer dan één zijn, is het vereist om een stageName-waarde door te geven bij het opgeven van een jobName, en dezelfde regel is dan van toepassing op beide als het doorgeven van een configuratieparameter.< /P>
getTags(string)	Hiermee haalt u een lijst op met alle buildtags in het project.
getTemplate(string, string)	Hiermee haalt u een specifieke builddefinitiesjabloon op.
getTemplates(string)	Hiermee haalt u alle definitiesjablonen op.
getWorkItemsBetweenBuilds(string, number, number, number)	Hiermee haalt u alle werkitems tussen twee builds op.
listBranches(string, string, string, string, string)	Hiermee haalt u een lijst met vertakkingen op voor de opgegeven broncodeopslagplaats.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Hiermee haalt u een lijst met broncodeopslagplaatsen op.
listSourceProviders(string)	Een lijst met bronproviders en hun mogelijkheden ophalen.
listWebhooks(string, string, string, string)	Hiermee haalt u een lijst op met webhooks die zijn geïnstalleerd in de opgegeven broncodeopslagplaats.
queueBuild(Build, string, boolean, string, number, number)	Een build in de wachtrij plaatsen
restoreDefinition(string, number, boolean)	Een verwijderde definitie herstellen
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Hiermee worden de webhooks voor de opgegeven triggers in de opgegeven broncodeopslagplaats opnieuw gemaakt.
saveTemplate(BuildDefinitionTemplate, string, string)	Updates een bestaande sjabloon voor builddefinities.
updateBuild(Build, string, number, boolean)	Updates een build.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Updates algemene instellingen voor pijplijnen.
updateBuildProperties(JsonPatchDocument, string, number)	Updates eigenschappen voor een build.
updateBuilds(Build[], string)	Updates meerdere builds.
updateBuildSettings(BuildSettings, string)	Updates de build-instellingen.
updateBuildTags(UpdateTagParameters, string, number)	Hiermee voegt u tags toe aan of verwijdert u deze uit een build.
updateDefinition(BuildDefinition, string, number, number, number)	Updates een bestaande builddefinitie. Om deze bewerking te laten slagen, moet de waarde van de eigenschap 'Revisie' van de aanvraagbody overeenkomen met de bestaande builddefinities. Het is raadzaam dat u de bestaande builddefinitie verkrijgt met behulp van GET, de builddefinitie indien nodig wijzigt en vervolgens de gewijzigde definitie verzendt met PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	Updates eigenschappen voor een definitie.
updateDefinitionTags(UpdateTagParameters, string, number)	Hiermee voegt u tags toe aan of verwijdert u deze uit een definitie.
updateFolder(Folder, string, string)	een bestaande map Updates op een bestaand pad
updateRetentionLease(RetentionLeaseUpdate, string, number)	Updates de duur of de status van de pijplijnbeveiliging van een retentielease.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Updates de retentie-instellingen van het project.
updateStage(UpdateStageParameters, number, string, string)	Een buildfase bijwerken

Constructordetails

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parameters

options: IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

addBuildTag(string, number, string)

Hiermee voegt u een tag toe aan een build.

function addBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

tag: string

De tag die u wilt toevoegen.

Retouren

Promise<string[]>

addBuildTags(string[], string, number)

Hiermee voegt u tags toe aan een build.

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

Parameters

tags: string[]

De tags die u wilt toevoegen. De aanvraagbody is rechtstreeks samengesteld op basis van vermelde tags.

project: string

Project-id of projectnaam

buildId: number

De id van de build.

Retouren

Promise<string[]>

addDefinitionTag(string, number, string)

Een tag toevoegen aan een definitie

function addDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>

Parameters

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

tag: string

De tag die u wilt toevoegen.

Retouren

Promise<string[]>

addDefinitionTags(string[], string, number)

Voegt meerdere tags toe aan een definitie.

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

Parameters

tags: string[]

De tags die u wilt toevoegen.

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

Retouren

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Voegt nieuwe leases toe voor pijplijnuitvoeringen.

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

Parameters

newLeases: NewRetentionLease[]

project: string

Project-id of projectnaam

Retouren

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

function authorizeDefinitionResources(resources: DefinitionResourceReference[], project: string, definitionId: number): Promise<DefinitionResourceReference[]>

Parameters

resources: DefinitionResourceReference[]

project: string

Project-id of projectnaam

definitionId: number

Retouren

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

function authorizeProjectResources(resources: DefinitionResourceReference[], project: string): Promise<DefinitionResourceReference[]>

Parameters

resources: DefinitionResourceReference[]

project: string

Project-id of projectnaam

Retouren

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Koppelt een artefact aan een build.

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

Parameters

artifact: BuildArtifact

Het artefact.

project: string

Project-id of projectnaam

buildId: number

De id van de build.

Retouren

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Hiermee maakt u een nieuwe definitie.

function createDefinition(definition: BuildDefinition, project: string, definitionToCloneId?: number, definitionToCloneRevision?: number): Promise<BuildDefinition>

Parameters

definition: BuildDefinition

De definitie.

project: string

Project-id of projectnaam

definitionToCloneId: number

definitionToCloneRevision: number

Retouren

Promise<BuildDefinition>

createFolder(Folder, string, string)

Maakt een nieuwe map.

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

Parameters

folder: Folder

De map.

project: string

Project-id of projectnaam

path: string

Het volledige pad van de map.

Retouren

Promise<Folder>

deleteBuild(string, number)

Hiermee verwijdert u een build.

function deleteBuild(project: string, buildId: number): Promise<void>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

Retouren

Promise<void>

deleteBuildTag(string, number, string)

Hiermee verwijdert u een tag uit een build. OPMERKING: deze API werkt niet voor tags met speciale tekens. Als u tags met speciale tekens wilt verwijderen, gebruikt u in plaats daarvan de PATCH-methode (in 6.0+)

function deleteBuildTag(project: string, buildId: number, tag: string): Promise<string[]>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

tag: string

De tag die u wilt verwijderen.

Retouren

Promise<string[]>

deleteDefinition(string, number)

Hiermee verwijdert u een definitie en alle bijbehorende builds.

function deleteDefinition(project: string, definitionId: number): Promise<void>

Parameters

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

Retouren

Promise<void>

deleteDefinitionTag(string, number, string)

Hiermee verwijdert u een tag uit een definitie. OPMERKING: deze API werkt niet voor tags met speciale tekens. Als u tags met speciale tekens wilt verwijderen, gebruikt u in plaats daarvan de PATCH-methode (in 6.0+)

function deleteDefinitionTag(project: string, definitionId: number, tag: string): Promise<string[]>

Parameters

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

tag: string

De tag die u wilt verwijderen.

Retouren

Promise<string[]>

deleteFolder(string, string)

Hiermee verwijdert u een definitiemap. Definities en de bijbehorende builds worden ook verwijderd.

function deleteFolder(project: string, path: string): Promise<void>

Parameters

project: string

Project-id of projectnaam

path: string

Het volledige pad naar de map.

Retouren

Promise<void>

deleteRetentionLeasesById(string, number[])

Hiermee verwijdert u specifieke retentieleases.

function deleteRetentionLeasesById(project: string, ids: number[]): Promise<void>

Parameters

project: string

Project-id of projectnaam

ids: number[]

Retouren

Promise<void>

deleteTag(string, string)

Hiermee verwijdert u een tag uit builds, definities en uit het tagarchief

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

Parameters

project: string

Project-id of projectnaam

tag: string

De tag die u wilt verwijderen.

Retouren

Promise<string[]>

deleteTemplate(string, string)

Hiermee verwijdert u een sjabloon voor een builddefinitie.

function deleteTemplate(project: string, templateId: string): Promise<void>

Parameters

project: string

Project-id of projectnaam

templateId: string

De id van de sjabloon.

Retouren

Promise<void>

getArtifact(string, number, string)

Hiermee haalt u een specifiek artefact voor een build op.

function getArtifact(project: string, buildId: number, artifactName: string): Promise<BuildArtifact>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

artifactName: string

De naam van het artefact.

Retouren

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Hiermee haalt u een specifiek artefact voor een build op.

function getArtifactContentZip(project: string, buildId: number, artifactName: string): Promise<ArrayBuffer>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

artifactName: string

De naam van het artefact.

Retouren

Promise<ArrayBuffer>

getArtifacts(string, number)

Hiermee haalt u alle artefacten voor een build op.

function getArtifacts(project: string, buildId: number): Promise<BuildArtifact[]>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

Retouren

Promise<BuildArtifact[]>

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

Hiermee haalt u een specifieke bijlage op.

function getAttachment(project: string, buildId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

timelineId: string

De id van de tijdlijn.

recordId: string

De id van de tijdlijnrecord.

type: string

Het type bijlage.

name: string

De naam van de bijlage.

Retouren

Promise<ArrayBuffer>

getAttachments(string, number, string)

Hiermee haalt u de lijst met bijlagen van een specifiek type op die zijn gekoppeld aan een build.

function getAttachments(project: string, buildId: number, type: string): Promise<Attachment[]>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

type: string

Het type bijlage.

Retouren

Promise<Attachment[]>

getBadge(string, number, string)

Hiermee haalt u een badge op die de status van de meest recente build voor een definitie aangeeft. Houd er rekening mee dat deze API is afgeschaft. Geef de voorkeur aan StatusBadgeController.GetStatusBadge.

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

Parameters

project: string

De project-id of -naam.

definitionId: number

De id van de definitie.

branchName: string

De naam van de vertakking.

Retouren

Promise<string>

getBuild(string, number, string)

Hiermee haalt u een build op

function getBuild(project: string, buildId: number, propertyFilters?: string): Promise<Build>

Parameters

project: string

Project-id of projectnaam

buildId: number

propertyFilters: string

Retouren

Promise<Build>

getBuildBadge(string, string, string, string)

Hiermee haalt u een badge op die de status van de meest recente build voor de opgegeven vertakking aangeeft.

function getBuildBadge(project: string, repoType: string, repoId?: string, branchName?: string): Promise<BuildBadge>

Parameters

project: string

Project-id of projectnaam

repoType: string

Het type opslagplaats.

repoId: string

De opslagplaats-id.

branchName: string

De naam van de vertakking.

Retouren

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Hiermee haalt u een badge op die de status van de meest recente build voor de opgegeven vertakking aangeeft.

function getBuildBadgeData(project: string, repoType: string, repoId?: string, branchName?: string): Promise<string>

Parameters

project: string

Project-id of projectnaam

repoType: string

Het type opslagplaats.

repoId: string

De opslagplaats-id.

branchName: string

De naam van de vertakking.

Retouren

Promise<string>

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

Hiermee haalt u de wijzigingen op die zijn gekoppeld aan een build

function getBuildChanges(project: string, buildId: number, continuationToken?: string, top?: number, includeSourceChange?: boolean): Promise<PagedList<Change>>

Parameters

project: string

Project-id of projectnaam

buildId: number

continuationToken: string

top: number

Het maximum aantal wijzigingen dat moet worden geretourneerd

includeSourceChange: boolean

Retouren

Promise<PagedList<Change>>

getBuildController(number)

Hiermee haalt u een controller op

function getBuildController(controllerId: number): Promise<BuildController>

Parameters

controllerId: number

Retouren

Promise<BuildController>

getBuildControllers(string)

Hiermee wordt de controller opgehaald, optioneel gefilterd op naam

function getBuildControllers(name?: string): Promise<BuildController[]>

Parameters

name: string

Retouren

Promise<BuildController[]>

getBuildGeneralSettings(string)

Hiermee haalt u de algemene instellingen voor de pijplijn op.

function getBuildGeneralSettings(project: string): Promise<PipelineGeneralSettings>

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<PipelineGeneralSettings>

getBuildLog(string, number, number, number, number)

Hiermee haalt u een afzonderlijk logboekbestand voor een build op.

function getBuildLog(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

logId: number

De id van het logboekbestand.

startLine: number

De beginregel.

endLine: number

De eindlijn.

Retouren

Promise<string>

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

Hiermee haalt u een afzonderlijk logboekbestand voor een build op.

function getBuildLogLines(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<string[]>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

logId: number

De id van het logboekbestand.

startLine: number

De beginregel.

endLine: number

De eindlijn.

Retouren

Promise<string[]>

getBuildLogs(string, number)

Hiermee haalt u de logboeken voor een build op.

function getBuildLogs(project: string, buildId: number): Promise<BuildLog[]>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

Retouren

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Hiermee haalt u de logboeken voor een build op.

function getBuildLogsZip(project: string, buildId: number): Promise<ArrayBuffer>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

Retouren

Promise<ArrayBuffer>

getBuildLogZip(string, number, number, number, number)

Hiermee haalt u een afzonderlijk logboekbestand voor een build op.

function getBuildLogZip(project: string, buildId: number, logId: number, startLine?: number, endLine?: number): Promise<ArrayBuffer>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

logId: number

De id van het logboekbestand.

startLine: number

De beginregel.

endLine: number

De eindlijn.

Retouren

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Hiermee haalt u alle opties voor builddefinities op die door het systeem worden ondersteund.

function getBuildOptionDefinitions(project?: string): Promise<BuildOptionDefinition[]>

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Hiermee haalt u eigenschappen voor een build op.

function getBuildProperties(project: string, buildId: number, filter?: string[]): Promise<any>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

filter: string[]

Een door komma's gescheiden lijst met eigenschappen. Indien opgegeven, filtert u op deze specifieke eigenschappen.

Retouren

Promise<any>

getBuildReport(string, number, string)

Hiermee haalt u een buildrapport op.

function getBuildReport(project: string, buildId: number, type?: string): Promise<BuildReportMetadata>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

type: string

Retouren

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Hiermee haalt u een buildrapport op.

function getBuildReportHtmlContent(project: string, buildId: number, type?: string): Promise<any>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

type: string

Retouren

Promise<any>

getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)

Hiermee haalt u een lijst met builds op.

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

Parameters

project: string

Project-id of projectnaam

definitions: number[]

Een door komma's gescheiden lijst met definitie-id's. Indien opgegeven, filtert u op builds voor deze definities.

queues: number[]

Een door komma's gescheiden lijst met wachtrij-id's. Indien opgegeven, filtert u op builds die zijn uitgevoerd op basis van deze wachtrijen.

buildNumber: string

Indien opgegeven, filtert u op builds die overeenkomen met dit buildnummer. Voeg * toe om een zoekactie voor het voorvoegsel uit te voeren.

minTime: Date

Indien opgegeven, filtert u op builds die na deze datum zijn voltooid/gestart/in de wachtrij zijn geplaatst op basis van de opgegeven queryOrder.

maxTime: Date

Indien opgegeven, filtert u op builds die vóór deze datum zijn voltooid/gestart/in de wachtrij zijn geplaatst op basis van de opgegeven queryOrder.

requestedFor: string

Indien opgegeven, filters voor builds die zijn aangevraagd voor de opgegeven gebruiker.

reasonFilter: BuildReason

Indien opgegeven, filtert u op builds die overeenkomen met deze reden.

statusFilter: BuildStatus

Indien opgegeven, filtert u op builds die overeenkomen met deze status.

resultFilter: BuildResult

Indien opgegeven, filtert u op builds die overeenkomen met dit resultaat.

tagFilters: string[]

Een door komma's gescheiden lijst met tags. Indien opgegeven, filtert u op builds met de opgegeven tags.

properties: string[]

Een door komma's gescheiden lijst met eigenschappen die moeten worden opgehaald.

top: number

Het maximum aantal builds dat moet worden geretourneerd.

continuationToken: string

Een vervolgtoken, geretourneerd door een eerdere aanroep van deze methode, dat kan worden gebruikt om de volgende set builds te retourneren.

maxBuildsPerDefinition: number

Het maximum aantal builds dat per definitie moet worden geretourneerd.

deletedFilter: QueryDeletedOption

Hiermee wordt aangegeven of verwijderde builds moeten worden uitgesloten, opgenomen of alleen moeten worden geretourneerd.

queryOrder: BuildQueryOrder

De volgorde waarin builds moeten worden geretourneerd.

branchName: string

Indien opgegeven, filtert u op builds die vertakkingen hebben gebouwd waarmee deze vertakking is gebouwd.

buildIds: number[]

Een door komma's gescheiden lijst met de id's van builds die moeten worden opgehaald.

repositoryId: string

Indien opgegeven, filtert u op builds die zijn gebouwd op basis van deze opslagplaats.

repositoryType: string

Indien opgegeven, filtert u op builds die zijn gebouwd op basis van opslagplaatsen van dit type.

Retouren

Promise<PagedList<Build>>

getBuildSettings(string)

Hiermee haalt u de build-instellingen op.

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

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<BuildSettings>

getBuildTags(string, number)

Hiermee haalt u de tags voor een build op.

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

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

Retouren

Promise<string[]>

getBuildTimeline(string, number, string, number, string)

Hiermee haalt u details voor een build op

function getBuildTimeline(project: string, buildId: number, timelineId?: string, changeId?: number, planId?: string): Promise<Timeline>

Parameters

project: string

Project-id of projectnaam

buildId: number

timelineId: string

changeId: number

planId: string

Retouren

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Hiermee haalt u de werkitems op die zijn gekoppeld aan een build. Alleen werkitems in hetzelfde project worden geretourneerd.

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

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

top: number

Het maximum aantal werkitems dat moet worden geretourneerd.

Retouren

Promise<ResourceRef[]>

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

Hiermee haalt u de werkitems op die zijn gekoppeld aan een build, gefilterd op specifieke doorvoeringen.

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

Parameters

commitIds: string[]

Een door komma's gescheiden lijst met doorvoer-id's.

project: string

Project-id of projectnaam

buildId: number

De id van de build.

top: number

Het maximum aantal werkitems dat moet worden geretourneerd, of het aantal doorvoeringen dat moet worden overwogen als er geen doorvoer-id's zijn opgegeven.

Retouren

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Hiermee haalt u de wijzigingen op die zijn aangebracht in de opslagplaats tussen twee opgegeven builds.

function getChangesBetweenBuilds(project: string, fromBuildId?: number, toBuildId?: number, top?: number): Promise<Change[]>

Parameters

project: string

Project-id of projectnaam

fromBuildId: number

De id van de eerste build.

toBuildId: number

De id van de laatste build.

top: number

Het maximum aantal wijzigingen dat moet worden geretourneerd.

Retouren

Promise<Change[]>

getDefinition(string, number, number, Date, string[], boolean)

Haalt een definitie op, optioneel bij een specifieke revisie.

function getDefinition(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<BuildDefinition>

Parameters

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

revision: number

Het revisienummer dat moet worden opgehaald. Als dit niet is opgegeven, wordt de nieuwste versie geretourneerd.

minMetricsTime: Date

Indien opgegeven, geeft de datum aan vanaf welke metrische gegevens moeten worden opgenomen.

propertyFilters: string[]

Een door komma's gescheiden lijst met eigenschappen die moeten worden opgenomen in de resultaten.

includeLatestBuilds: boolean

Retouren

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Hiermee worden metrische gegevens voor een definitie gemaakt.

function getDefinitionMetrics(project: string, definitionId: number, minMetricsTime?: Date): Promise<BuildMetric[]>

Parameters

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

minMetricsTime: Date

De datum vanaf waarvan metrische gegevens moeten worden berekend.

Retouren

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Hiermee haalt u eigenschappen voor een definitie op.

function getDefinitionProperties(project: string, definitionId: number, filter?: string[]): Promise<any>

Parameters

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

filter: string[]

Een door komma's gescheiden lijst met eigenschappen. Indien opgegeven, filtert u op deze specifieke eigenschappen.

Retouren

Promise<any>

getDefinitionResources(string, number)

function getDefinitionResources(project: string, definitionId: number): Promise<DefinitionResourceReference[]>

Parameters

project: string

Project-id of projectnaam

definitionId: number

Retouren

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Hiermee haalt u alle revisies van een definitie op.

function getDefinitionRevisions(project: string, definitionId: number): Promise<BuildDefinitionRevision[]>

Parameters

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

Retouren

Promise<BuildDefinitionRevision[]>

getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)

Hiermee haalt u een lijst met definities op.

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

Parameters

project: string

Project-id of projectnaam

name: string

Indien opgegeven, filtert u op definities waarvan de namen overeenkomen met dit patroon.

repositoryId: string

Een opslagplaats-id. Indien opgegeven, filtert u op definities die gebruikmaken van deze opslagplaats.

repositoryType: string

Indien opgegeven, filtert u op definities met een opslagplaats van dit type.

queryOrder: DefinitionQueryOrder

Geeft de volgorde aan waarin definities moeten worden geretourneerd.

top: number

Het maximum aantal definities dat moet worden geretourneerd.

continuationToken: string

Een vervolgtoken, geretourneerd door een eerdere aanroep van deze methode, dat kan worden gebruikt om de volgende set definities te retourneren.

minMetricsTime: Date

Indien opgegeven, geeft de datum aan vanaf welke metrische gegevens moeten worden opgenomen.

definitionIds: number[]

Een door komma's gescheiden lijst met de id's van definities die moeten worden opgehaald.

path: string

Indien opgegeven, filtert u op definities in deze map.

builtAfter: Date

Indien opgegeven, filtert u op definities met builds na deze datum.

notBuiltAfter: Date

Indien opgegeven, filtert u op definities die na deze datum geen builds hebben.

includeAllProperties: boolean

Geeft aan of de volledige definities moeten worden geretourneerd. Standaard worden ondiepe weergaven van de definities geretourneerd.

includeLatestBuilds: boolean

Geeft aan of de meest recente en meest recente voltooide builds voor deze definitie moeten worden geretourneerd.

taskIdFilter: string

Indien opgegeven, filtert u op definities die gebruikmaken van de opgegeven taak.

processType: number

Indien opgegeven, filtert u op definities met het opgegeven procestype.

yamlFilename: string

Indien opgegeven, filtert u op YAML-definities die overeenkomen met de opgegeven bestandsnaam. Als u dit filter wilt gebruiken, moet includeAllProperties worden ingesteld op true

Retouren

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Hiermee haalt u de tags voor een definitie op.

function getDefinitionTags(project: string, definitionId: number, revision?: number): Promise<string[]>

Parameters

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

revision: number

Het revisienummer van de definitie. Als dit niet is opgegeven, wordt de meest recente revisie van de definitie gebruikt.

Retouren

Promise<string[]>

getDefinitionYaml(string, number, number, Date, string[], boolean)

Converteert een definitie naar YAML, optioneel bij een specifieke revisie.

function getDefinitionYaml(project: string, definitionId: number, revision?: number, minMetricsTime?: Date, propertyFilters?: string[], includeLatestBuilds?: boolean): Promise<YamlBuild>

Parameters

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

revision: number

Het revisienummer dat moet worden opgehaald. Als dit niet is opgegeven, wordt de nieuwste versie geretourneerd.

minMetricsTime: Date

Indien opgegeven, geeft de datum aan vanaf welke metrische gegevens moeten worden opgenomen.

propertyFilters: string[]

Een door komma's gescheiden lijst met eigenschappen die moeten worden opgenomen in de resultaten.

includeLatestBuilds: boolean

Retouren

Promise<YamlBuild>

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

Hiermee haalt u een bestand op uit de build.

function getFile(project: string, buildId: number, artifactName: string, fileId: string, fileName: string): Promise<ArrayBuffer>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

artifactName: string

De naam van het artefact.

fileId: string

De primaire sleutel voor het bestand.

fileName: string

De naam waarop het bestand wordt ingesteld.

Retouren

Promise<ArrayBuffer>

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

Hiermee haalt u de inhoud van een bestand op in de opgegeven broncodeopslagplaats.

function getFileContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<string>

Parameters

project: string

Project-id of projectnaam

providerName: string

De naam van de bronprovider.

serviceEndpointId: string

Indien opgegeven, de id van het service-eindpunt dat moet worden opgevraagd. Kan alleen worden weggelaten voor providers die geen service-eindpunten gebruiken, bijvoorbeeld TFVC of TFGit.

repository: string

Indien opgegeven, de leverancierspecifieke id of de naam van de opslagplaats om vertakkingen op te halen. Kan alleen worden weggelaten voor providers die geen ondersteuning bieden voor meerdere opslagplaatsen.

commitOrBranch: string

De id van de doorvoering of vertakking waaruit de inhoud van een bestand wordt opgehaald.

path: string

Het pad naar het bestand dat moet worden opgehaald, ten opzichte van de hoofdmap van de opslagplaats.

Retouren

Promise<string>

getFolders(string, string, FolderQueryOrder)

Hiermee haalt u een lijst met mappen met builddefinities op.

function getFolders(project: string, path?: string, queryOrder?: FolderQueryOrder): Promise<Folder[]>

Parameters

project: string

Project-id of projectnaam

path: string

Het pad waarmee u moet beginnen.

queryOrder: FolderQueryOrder

De volgorde waarin mappen moeten worden geretourneerd.

Retouren

Promise<Folder[]>

getLatestBuild(string, string, string)

Hiermee haalt u de nieuwste build voor een definitie op, optioneel gericht op een specifieke vertakking.

function getLatestBuild(project: string, definition: string, branchName?: string): Promise<Build>

Parameters

project: string

Project-id of projectnaam

definition: string

definitienaam met optioneel pad naar de voorloopmap of de definitie-id

branchName: string

optionele parameter die de specifieke vertakking aangeeft die moet worden gebruikt. Als u niet opgeeft, wordt de standaardbranch gebruikt.

Retouren

Promise<Build>

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

Hiermee haalt u de inhoud van een map op in de opgegeven broncodeopslagplaats.

function getPathContents(project: string, providerName: string, serviceEndpointId?: string, repository?: string, commitOrBranch?: string, path?: string): Promise<SourceRepositoryItem[]>

Parameters

project: string

Project-id of projectnaam

providerName: string

De naam van de bronprovider.

serviceEndpointId: string

Indien opgegeven, de id van het service-eindpunt dat moet worden opgevraagd. Kan alleen worden weggelaten voor providers die geen service-eindpunten gebruiken, bijvoorbeeld TFVC of TFGit.

repository: string

commitOrBranch: string

De id van de doorvoering of vertakking waaruit de inhoud van een bestand wordt opgehaald.

path: string

Het pad dat moet worden weergegeven, ten opzichte van de hoofdmap van de opslagplaats.

Retouren

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Hiermee worden metrische gegevens voor een project gemaakt.

function getProjectMetrics(project: string, metricAggregationType?: string, minMetricsTime?: Date): Promise<BuildMetric[]>

Parameters

project: string

Project-id of projectnaam

metricAggregationType: string

Het aggregatietype dat moet worden gebruikt (elk uur, dagelijks).

minMetricsTime: Date

De datum vanaf waarvan metrische gegevens moeten worden berekend.

Retouren

Promise<BuildMetric[]>

getProjectResources(string, string, string)

function getProjectResources(project: string, type?: string, id?: string): Promise<DefinitionResourceReference[]>

Parameters

project: string

Project-id of projectnaam

type: string

id: string

Retouren

Promise<DefinitionResourceReference[]>

getPullRequest(string, string, string, string, string)

Hiermee haalt u een pull-aanvraagobject op van de bronprovider.

function getPullRequest(project: string, providerName: string, pullRequestId: string, repositoryId?: string, serviceEndpointId?: string): Promise<PullRequest>

Parameters

project: string

Project-id of projectnaam

providerName: string

De naam van de bronprovider.

pullRequestId: string

Leverancierspecifieke id van de pull-aanvraag.

repositoryId: string

Leverancierspecifieke id of de naam van de opslagplaats die de pull-aanvraag bevat.

serviceEndpointId: string

Indien opgegeven, de id van het service-eindpunt dat moet worden opgevraagd. Kan alleen worden weggelaten voor providers die geen service-eindpunten gebruiken, bijvoorbeeld TFVC of TFGit.

Retouren

Promise<PullRequest>

getResourceUsage()

Hiermee haalt u informatie op over buildresources in het systeem.

function getResourceUsage(): Promise<BuildResourceUsage>

Retouren

Promise<BuildResourceUsage>

getRetentionHistory(number)

Retourneert de retentiegeschiedenis voor de projectverzameling. Dit omvat pijplijnen met aangepaste bewaarregels die kunnen voorkomen dat de retentietaak deze opschont, uitvoeringen per pijplijn met retentietype, bestanden die zijn gekoppeld aan pijplijnen die eigendom zijn van de verzameling met het retentietype en het aantal bestanden per pijplijn.

function getRetentionHistory(daysToLookback?: number): Promise<BuildRetentionHistory>

Parameters

daysToLookback: number

Retouren

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Retourneert de details van de retentielease met een lease-id.

function getRetentionLease(project: string, leaseId: number): Promise<RetentionLease>

Parameters

project: string

Project-id of projectnaam

leaseId: number

Retouren

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Retourneert alle leases die overeenkomen met de opgegeven MinimalRetentionLeases

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

Parameters

project: string

Project-id of projectnaam

leasesToFetch: MinimalRetentionLease[]

Lijst met JSON-geserialiseerde MinimalRetentionLeases, gescheiden door |

Retouren

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Retourneert alle leases die eigendom zijn van de opgegeven entiteit, optioneel binnen het bereik van één pijplijndefinitie en uitvoeren.

function getRetentionLeasesByOwnerId(project: string, ownerId?: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

Parameters

project: string

Project-id of projectnaam

ownerId: string

definitionId: number

Een optionele parameter om de zoekopdracht te beperken tot een specifieke pijplijndefinitie.

runId: number

Een optionele parameter om de zoekopdracht te beperken tot één pijplijnuitvoering. Vereist definitionId.

Retouren

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Retourneert alle leases die eigendom zijn van de opgegeven gebruiker, optioneel beperkt tot één pijplijndefinitie en worden uitgevoerd.

function getRetentionLeasesByUserId(project: string, userOwnerId: string, definitionId?: number, runId?: number): Promise<RetentionLease[]>

Parameters

project: string

Project-id of projectnaam

userOwnerId: string

De gebruikers-id die moet worden gezocht.

definitionId: number

Een optionele parameter om de zoekopdracht te beperken tot een specifieke pijplijndefinitie.

runId: number

Een optionele parameter om de zoekopdracht te beperken tot één pijplijnuitvoering. Vereist definitionId.

Retouren

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Hiermee haalt u alle retentieleases op die van toepassing zijn op een specifieke build.

function getRetentionLeasesForBuild(project: string, buildId: number): Promise<RetentionLease[]>

Parameters

project: string

Project-id of projectnaam

buildId: number

De id van de build.

Retouren

Promise<RetentionLease[]>

getRetentionSettings(string)

Hiermee haalt u de retentie-instellingen van het project op.

function getRetentionSettings(project: string): Promise<ProjectRetentionSetting>

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<ProjectRetentionSetting>

getStatusBadge(string, string, string, string, string, string, string)

<p>Haalt de buildstatus voor een definitie op, optioneel gericht op een specifieke vertakking, fase, taak en configuratie.< /p><p>Als er meer dan één zijn, is het vereist om een stageName-waarde door te geven bij het opgeven van een jobName, en dezelfde regel is dan van toepassing op beide als het doorgeven van een configuratieparameter.< /P>

function getStatusBadge(project: string, definition: string, branchName?: string, stageName?: string, jobName?: string, configuration?: string, label?: string): Promise<string>

Parameters

project: string

Project-id of projectnaam

definition: string

De naam van de definitie met het optionele pad naar de voorloopmap of de definitie-id.

branchName: string

Houd alleen rekening met de meest recente build voor deze vertakking. Als dit niet is opgegeven, wordt de standaardbranch gebruikt.

stageName: string

Gebruik deze fase in de pijplijn om de status weer te geven.

jobName: string

Gebruik deze taak in een fase van de pijplijn om de status weer te geven.

configuration: string

Deze taakconfiguratie gebruiken om de status weer te geven

label: string

Hiermee vervangt u de standaardtekst aan de linkerkant van de badge.

Retouren

Promise<string>

getTags(string)

Hiermee haalt u een lijst op met alle buildtags in het project.

function getTags(project: string): Promise<string[]>

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<string[]>

getTemplate(string, string)

Hiermee haalt u een specifieke builddefinitiesjabloon op.

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

Parameters

project: string

Project-id of projectnaam

templateId: string

De id van de aangevraagde sjabloon.

Retouren

Promise<BuildDefinitionTemplate>

getTemplates(string)

Hiermee haalt u alle definitiesjablonen op.

function getTemplates(project: string): Promise<BuildDefinitionTemplate[]>

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Hiermee haalt u alle werkitems tussen twee builds op.

function getWorkItemsBetweenBuilds(project: string, fromBuildId: number, toBuildId: number, top?: number): Promise<ResourceRef[]>

Parameters

project: string

Project-id of projectnaam

fromBuildId: number

De id van de eerste build.

toBuildId: number

De id van de laatste build.

top: number

Het maximum aantal werkitems dat moet worden geretourneerd.

Retouren

Promise<ResourceRef[]>

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

Hiermee haalt u een lijst met vertakkingen op voor de opgegeven broncodeopslagplaats.

function listBranches(project: string, providerName: string, serviceEndpointId?: string, repository?: string, branchName?: string): Promise<string[]>

Parameters

project: string

Project-id of projectnaam

providerName: string

De naam van de bronprovider.

serviceEndpointId: string

Indien opgegeven, de id van het service-eindpunt dat moet worden opgevraagd. Kan alleen worden weggelaten voor providers die geen service-eindpunten gebruiken, bijvoorbeeld TFVC of TFGit.

repository: string

De leverancierspecifieke id of de naam van de opslagplaats om vertakkingen op te halen. Kan alleen worden weggelaten voor providers die geen ondersteuning bieden voor meerdere opslagplaatsen.

branchName: string

Indien opgegeven, de naam van de vertakking waarop u specifiek wilt controleren.

Retouren

Promise<string[]>

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

Hiermee haalt u een lijst met broncodeopslagplaatsen op.

function listRepositories(project: string, providerName: string, serviceEndpointId?: string, repository?: string, resultSet?: ResultSet, pageResults?: boolean, continuationToken?: string): Promise<SourceRepositories>

Parameters

project: string

Project-id of projectnaam

providerName: string

De naam van de bronprovider.

serviceEndpointId: string

Indien opgegeven, de id van het service-eindpunt dat moet worden opgevraagd. Kan alleen worden weggelaten voor providers die geen service-eindpunten gebruiken, bijvoorbeeld TFVC of TFGit.

repository: string

Indien opgegeven, de leverancierspecifieke id of de naam van één opslagplaats die moet worden opgevraagd.

resultSet: ResultSet

'top' voor de opslagplaatsen die het meest relevant zijn voor het eindpunt. Als dit niet is ingesteld, worden alle opslagplaatsen geretourneerd. Genegeerd als 'opslagplaats' is ingesteld.

pageResults: boolean

Als deze optie is ingesteld op true, wordt de set resultaten beperkt en wordt een vervolgtoken geretourneerd om de query voort te zetten.

continuationToken: string

Wanneer u resultaten wisselt, is dit een vervolgtoken dat wordt geretourneerd door een eerdere aanroep van deze methode, dat kan worden gebruikt om de volgende set opslagplaatsen te retourneren.

Retouren

Promise<SourceRepositories>

listSourceProviders(string)

Een lijst met bronproviders en hun mogelijkheden ophalen.

function listSourceProviders(project: string): Promise<SourceProviderAttributes[]>

Parameters

project: string

Project-id of projectnaam

Retouren

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Hiermee haalt u een lijst op met webhooks die zijn geïnstalleerd in de opgegeven broncodeopslagplaats.

function listWebhooks(project: string, providerName: string, serviceEndpointId?: string, repository?: string): Promise<RepositoryWebhook[]>

Parameters

project: string

Project-id of projectnaam

providerName: string

De naam van de bronprovider.

serviceEndpointId: string

Indien opgegeven, de id van het service-eindpunt dat moet worden opgevraagd. Kan alleen worden weggelaten voor providers die geen service-eindpunten gebruiken, bijvoorbeeld TFVC of TFGit.

repository: string

Indien opgegeven, de leverancierspecifieke id of de naam van de opslagplaats om webhooks op te halen. Kan alleen worden weggelaten voor providers die geen ondersteuning bieden voor meerdere opslagplaatsen.

Retouren

Promise<RepositoryWebhook[]>

queueBuild(Build, string, boolean, string, number, number)

Een build in de wachtrij plaatsen

function queueBuild(build: Build, project: string, ignoreWarnings?: boolean, checkInTicket?: string, sourceBuildId?: number, definitionId?: number): Promise<Build>

Parameters

build: Build

project: string

Project-id of projectnaam

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

Optionele definitie-id voor het in de wachtrij plaatsen van een build zonder hoofdtekst. Genegeerd als er een geldige hoofdtekst is

Retouren

Promise<Build>

restoreDefinition(string, number, boolean)

Een verwijderde definitie herstellen

function restoreDefinition(project: string, definitionId: number, deleted: boolean): Promise<BuildDefinition>

Parameters

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie die moet worden hersteld.

deleted: boolean

Wanneer onwaar, wordt een verwijderde definitie hersteld.

Retouren

Promise<BuildDefinition>

restoreWebhooks(DefinitionTriggerType[], string, string, string, string)

Hiermee worden de webhooks voor de opgegeven triggers in de opgegeven broncodeopslagplaats opnieuw gemaakt.

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

Parameters

triggerTypes: DefinitionTriggerType[]

De typen triggers voor het herstellen van webhooks.

project: string

Project-id of projectnaam

providerName: string

De naam van de bronprovider.

serviceEndpointId: string

Indien opgegeven, de id van het service-eindpunt dat moet worden opgevraagd. Kan alleen worden weggelaten voor providers die geen service-eindpunten gebruiken, bijvoorbeeld TFVC of TFGit.

repository: string

Retouren

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Updates een bestaande sjabloon voor builddefinities.

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

Parameters

template: BuildDefinitionTemplate

De nieuwe versie van de sjabloon.

project: string

Project-id of projectnaam

templateId: string

De id van de sjabloon.

Retouren

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Updates een build.

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

Parameters

build: Build

De build.

project: string

Project-id of projectnaam

buildId: number

De id van de build.

retry: boolean

Retouren

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Updates algemene instellingen voor pijplijnen.

function updateBuildGeneralSettings(newSettings: PipelineGeneralSettings, project: string): Promise<PipelineGeneralSettings>

Parameters

newSettings: PipelineGeneralSettings

project: string

Project-id of projectnaam

Retouren

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Updates eigenschappen voor een build.

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

Parameters

document: JsonPatchDocument

Een json-patchdocument met een beschrijving van de eigenschappen die moeten worden bijgewerkt.

project: string

Project-id of projectnaam

buildId: number

De id van de build.

Retouren

Promise<any>

updateBuilds(Build[], string)

Updates meerdere builds.

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

Parameters

builds: Build[]

De builds die moeten worden bijgewerkt.

project: string

Project-id of projectnaam

Retouren

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Updates de build-instellingen.

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

Parameters

settings: BuildSettings

De nieuwe instellingen.

project: string

Project-id of projectnaam

Retouren

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Hiermee voegt u tags toe aan of verwijdert u deze uit een build.

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

Parameters

updateParameters: UpdateTagParameters

De tags die u wilt toevoegen/verwijderen.

project: string

Project-id of projectnaam

buildId: number

De id van de build.

Retouren

Promise<string[]>

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

Updates een bestaande builddefinitie. Om deze bewerking te laten slagen, moet de waarde van de eigenschap 'Revisie' van de aanvraagbody overeenkomen met de bestaande builddefinities. Het is raadzaam dat u de bestaande builddefinitie verkrijgt met behulp van GET, de builddefinitie indien nodig wijzigt en vervolgens de gewijzigde definitie verzendt met PUT.

function updateDefinition(definition: BuildDefinition, project: string, definitionId: number, secretsSourceDefinitionId?: number, secretsSourceDefinitionRevision?: number): Promise<BuildDefinition>

Parameters

definition: BuildDefinition

De nieuwe versie van de definitie. De eigenschap Revisie moet overeenkomen met de bestaande definitie om de update te kunnen accepteren.

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Retouren

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Updates eigenschappen voor een definitie.

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

Parameters

document: JsonPatchDocument

Een json-patchdocument met een beschrijving van de eigenschappen die moeten worden bijgewerkt.

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

Retouren

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Hiermee voegt u tags toe aan of verwijdert u deze uit een definitie.

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

Parameters

updateParameters: UpdateTagParameters

De tags die u wilt toevoegen/verwijderen.

project: string

Project-id of projectnaam

definitionId: number

De id van de definitie.

Retouren

Promise<string[]>

updateFolder(Folder, string, string)

een bestaande map Updates op een bestaand pad

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

Parameters

folder: Folder

De nieuwe versie van de map.

project: string

Project-id of projectnaam

path: string

Het volledige pad naar de map.

Retouren

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Updates de duur of de status van de pijplijnbeveiliging van een retentielease.

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

Parameters

leaseUpdate: RetentionLeaseUpdate

De nieuwe gegevens voor de retentielease.

project: string

Project-id of projectnaam

leaseId: number

De id van de lease die moet worden bijgewerkt.

Retouren

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Updates de retentie-instellingen van het project.

function updateRetentionSettings(updateModel: UpdateProjectRetentionSettingModel, project: string): Promise<ProjectRetentionSetting>

Parameters

updateModel: UpdateProjectRetentionSettingModel

project: string

Project-id of projectnaam

Retouren

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Een buildfase bijwerken

function updateStage(updateParameters: UpdateStageParameters, buildId: number, stageRefName: string, project?: string): Promise<void>

Parameters

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

Project-id of projectnaam

Retouren

Promise<void>

Delen via

BuildRestClient class

Constructors

Eigenschappen

Methoden

Constructordetails

BuildRestClient(IVssRestClientOptions)

Parameters

Eigenschapdetails

RESOURCE_AREA_ID

Waarde van eigenschap

Methodedetails

addBuildTag(string, number, string)

Parameters

Retouren

addBuildTags(string[], string, number)

Parameters

Retouren

addDefinitionTag(string, number, string)

Parameters

Retouren

addDefinitionTags(string[], string, number)

Parameters

Retouren

addRetentionLeases(NewRetentionLease[], string)

Parameters

Retouren

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parameters

Retouren

authorizeProjectResources(DefinitionResourceReference[], string)

Parameters

Retouren

createArtifact(BuildArtifact, string, number)

Parameters

Retouren

createDefinition(BuildDefinition, string, number, number)

Parameters

Retouren

createFolder(Folder, string, string)

Parameters

Retouren

deleteBuild(string, number)

Parameters

Retouren

deleteBuildTag(string, number, string)

Parameters

Retouren

deleteDefinition(string, number)

Parameters

Retouren

deleteDefinitionTag(string, number, string)

Parameters

Retouren

deleteFolder(string, string)

Parameters

Retouren

deleteRetentionLeasesById(string, number[])

Parameters

Retouren

deleteTag(string, string)

Parameters

Retouren

deleteTemplate(string, string)

Parameters

Retouren

getArtifact(string, number, string)

Parameters

Retouren

getArtifactContentZip(string, number, string)

Parameters

Retouren

getArtifacts(string, number)

Parameters

Retouren

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

Parameters

Retouren

getAttachments(string, number, string)

Parameters