BuildRestClient class

Referenz

Paket:: azure-devops-extension-api

Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden

Extends: RestClientBase

Konstruktoren

BuildRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

addBuildTag(string, number, string)	Fügt einem Build ein Tag hinzu.
addBuildTags(string[], string, number)	Fügt einem Build Tags hinzu.
addDefinitionTag(string, number, string)	Fügt einer Definition ein Tag hinzu
addDefinitionTags(string[], string, number)	Fügt einer Definition mehrere Tags hinzu.
addRetentionLeases(NewRetentionLease[], string)	Fügt neue Leases für Pipelineausführungen hinzu.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Ordnet ein Artefakt einem Build zu.
createDefinition(BuildDefinition, string, number, number)	Erstellt eine neue Definition.
createFolder(Folder, string, string)	Erstellt einen neuen Ordner.
deleteBuild(string, number)	Löscht einen Build.
deleteBuildTag(string, number, string)	Entfernt ein Tag aus einem Build. HINWEIS: Diese API funktioniert nicht für Tags mit Sonderzeichen. Um Tags mit Sonderzeichen zu entfernen, verwenden Sie stattdessen die PATCH-Methode (in 6.0 und höher).
deleteDefinition(string, number)	Löscht eine Definition und alle zugeordneten Builds.
deleteDefinitionTag(string, number, string)	Entfernt ein Tag aus einer Definition. HINWEIS: Diese API funktioniert nicht für Tags mit Sonderzeichen. Um Tags mit Sonderzeichen zu entfernen, verwenden Sie stattdessen die PATCH-Methode (in 6.0 und höher).
deleteFolder(string, string)	Löscht einen Definitionsordner. Definitionen und die entsprechenden Builds werden ebenfalls gelöscht.
deleteRetentionLeasesById(string, number[])	Entfernt bestimmte Aufbewahrungsleases.
deleteTag(string, string)	Entfernt ein Tag aus Builds, Definitionen und aus dem Tagspeicher.
deleteTemplate(string, string)	Löscht eine Builddefinitionsvorlage.
getArtifact(string, number, string)	Ruft ein bestimmtes Artefakt für einen Build ab.
getArtifactContentZip(string, number, string)	Ruft ein bestimmtes Artefakt für einen Build ab.
getArtifacts(string, number)	Ruft alle Artefakte für einen Build ab.
getAttachment(string, number, string, string, string, string)	Ruft eine bestimmte Anlage ab.
getAttachments(string, number, string)	Ruft die Liste der Anlagen eines bestimmten Typs ab, die einem Build zugeordnet sind.
getBadge(string, number, string)	Ruft ein Badge ab, das die status des letzten Builds für eine Definition angibt. Beachten Sie, dass diese API veraltet ist. Bevorzugen Sie StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Ruft einen Build ab.
getBuildBadge(string, string, string, string)	Ruft einen Badge ab, der die status des letzten Builds für den angegebenen Branch angibt.
getBuildBadgeData(string, string, string, string)	Ruft einen Badge ab, der die status des letzten Builds für den angegebenen Branch angibt.
getBuildChanges(string, number, string, number, boolean)	Ruft die einem Build zugeordneten Änderungen ab.
getBuildController(number)	Ruft einen Controller ab.
getBuildControllers(string)	Ruft den Controller ab, optional nach Namen gefiltert.
getBuildGeneralSettings(string)	Ruft allgemeine Pipelineeinstellungen ab.
getBuildLog(string, number, number, number, number)	Ruft eine einzelne Protokolldatei für einen Build ab.
getBuildLogLines(string, number, number, number, number)	Ruft eine einzelne Protokolldatei für einen Build ab.
getBuildLogs(string, number)	Ruft die Protokolle für einen Build ab.
getBuildLogsZip(string, number)	Ruft die Protokolle für einen Build ab.
getBuildLogZip(string, number, number, number, number)	Ruft eine einzelne Protokolldatei für einen Build ab.
getBuildOptionDefinitions(string)	Ruft alle Builddefinitionsoptionen ab, die vom System unterstützt werden.
getBuildProperties(string, number, string[])	Ruft Eigenschaften für einen Build ab.
getBuildReport(string, number, string)	Ruft einen Buildbericht ab.
getBuildReportHtmlContent(string, number, string)	Ruft einen Buildbericht ab.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Ruft eine Liste der Builds ab.
getBuildSettings(string)	Ruft die Buildeinstellungen ab.
getBuildTags(string, number)	Ruft die Tags für einen Build ab.
getBuildTimeline(string, number, string, number, string)	Ruft Details für einen Build ab.
getBuildWorkItemsRefs(string, number, number)	Ruft die einem Build zugeordneten Arbeitselemente ab. Es werden nur Arbeitselemente im selben Projekt zurückgegeben.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Ruft die einem Build zugeordneten Arbeitselemente ab, die nach bestimmten Commits gefiltert werden.
getChangesBetweenBuilds(string, number, number, number)	Ruft die Änderungen ab, die zwischen zwei angegebenen Builds am Repository vorgenommen wurden.
getDefinition(string, number, number, Date, string[], boolean)	Ruft eine Definition ab, optional bei einer bestimmten Revision.
getDefinitionMetrics(string, number, Date)	Ruft Buildmetriken für eine Definition ab.
getDefinitionProperties(string, number, string[])	Ruft Eigenschaften für eine Definition ab.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Ruft alle Überarbeitungen einer Definition ab.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Ruft eine Liste von Definitionen ab.
getDefinitionTags(string, number, number)	Ruft die Tags für eine Definition ab.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Konvertiert eine Definition in YAML, optional bei einer bestimmten Revision.
getFile(string, number, string, string, string)	Ruft eine Datei aus dem Build ab.
getFileContents(string, string, string, string, string, string)	Ruft den Inhalt einer Datei im angegebenen Quellcoderepository ab.
getFolders(string, string, FolderQueryOrder)	Ruft eine Liste der Builddefinitionsordner ab.
getLatestBuild(string, string, string)	Ruft den neuesten Build für eine Definition ab, der optional auf einen bestimmten Branch ausgerichtet ist.
getPathContents(string, string, string, string, string, string)	Ruft den Inhalt eines Verzeichnisses im angegebenen Quellcoderepository ab.
getProjectMetrics(string, string, Date)	Ruft Buildmetriken für ein Projekt ab.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Ruft ein Pull Request-Objekt vom Quellanbieter ab.
getResourceUsage()	Ruft Informationen zu Buildressourcen im System ab.
getRetentionHistory(number)	Gibt den Aufbewahrungsverlauf für die Projektauflistung zurück. Dies umfasst Pipelines mit benutzerdefinierten Aufbewahrungsregeln, die möglicherweise verhindern, dass der Aufbewahrungsauftrag sie bereinigen kann, die Ausführung pro Pipeline mit Aufbewahrungstyp, Dateien, die Pipelines zugeordnet sind, die der Sammlung mit aufbewahrungstyp gehören, und die Anzahl der Dateien pro Pipeline.
getRetentionLease(string, number)	Gibt die Details der Aufbewahrungsleasase unter Angabe einer Lease-ID zurück.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Gibt alle Leases zurück, die den angegebenen MinimalRetentionLeases entsprechen.
getRetentionLeasesByOwnerId(string, string, number, number)	Gibt alle Leases im Besitz der angegebenen Entität zurück, die optional auf eine einzelne Pipelinedefinition und ausführung ausgerichtet sind.
getRetentionLeasesByUserId(string, string, number, number)	Gibt alle Leases im Besitz des angegebenen Benutzers zurück, die optional auf eine einzelne Pipelinedefinition und ausführung ausgerichtet sind.
getRetentionLeasesForBuild(string, number)	Ruft alle Aufbewahrungsleases ab, die für einen bestimmten Build gelten.
getRetentionSettings(string)	Ruft die Aufbewahrungseinstellungen des Projekts ab.
getStatusBadge(string, string, string, string, string, string, string)	<p>Ruft die Build-status für eine Definition ab, die optional auf eine bestimmte Verzweigung, Phase, Auftrag und Konfiguration festgelegt ist.< /p><p>Wenn mehrere vorhanden sind, muss beim Angeben eines auftragsName-Werts ein stageName-Wert übergeben werden, und die gleiche Regel gilt dann für beide, wenn ein Konfigurationsparameter übergeben wird.< /P>
getTags(string)	Ruft eine Liste aller Buildtags im Projekt ab.
getTemplate(string, string)	Ruft eine bestimmte Builddefinitionsvorlage ab.
getTemplates(string)	Ruft alle Definitionsvorlagen ab.
getWorkItemsBetweenBuilds(string, number, number, number)	Ruft alle Arbeitselemente zwischen zwei Builds ab.
listBranches(string, string, string, string, string)	Ruft eine Liste von Branches für das angegebene Quellcoderepository ab.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Ruft eine Liste der Quellcoderepositorys ab.
listSourceProviders(string)	Rufen Sie eine Liste der Quellanbieter und deren Funktionen ab.
listWebhooks(string, string, string, string)	Ruft eine Liste der Webhooks ab, die im angegebenen Quellcoderepository installiert sind.
queueBuild(Build, string, boolean, string, number, number)	Ein Build wird in die Warteschlange gestellt.
restoreDefinition(string, number, boolean)	Wiederherstellen einer gelöschten Definition
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Erstellt die Webhooks für die angegebenen Trigger im angegebenen Quellcoderepository neu.
saveTemplate(BuildDefinitionTemplate, string, string)	Updates einer vorhandenen Builddefinitionsvorlage.
updateBuild(Build, string, number, boolean)	Updates einen Build.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Updates allgemeinen Einstellungen für die Pipeline.
updateBuildProperties(JsonPatchDocument, string, number)	Updates Eigenschaften für einen Build.
updateBuilds(Build[], string)	Updates mehrere Builds.
updateBuildSettings(BuildSettings, string)	Updates die Buildeinstellungen aus.
updateBuildTags(UpdateTagParameters, string, number)	Fügt Tags aus einem Build hinzu/entfernt sie.
updateDefinition(BuildDefinition, string, number, number, number)	Updates einer vorhandenen Builddefinition. Damit dieser Vorgang erfolgreich ausgeführt werden kann, muss der Wert der Eigenschaft "Revision" des Anforderungstexts mit dem der vorhandenen Builddefinition übereinstimmen. Es wird empfohlen, die vorhandene Builddefinition mithilfe von GET abzurufen, die Builddefinition nach Bedarf zu ändern und dann die geänderte Definition mit PUT zu übermitteln.
updateDefinitionProperties(JsonPatchDocument, string, number)	Updates Eigenschaften für eine Definition.
updateDefinitionTags(UpdateTagParameters, string, number)	Fügt einer Definition Tags hinzu/entfernt sie.
updateFolder(Folder, string, string)	Updates eines vorhandenen Ordners unter einem vorhandenen Pfad
updateRetentionLease(RetentionLeaseUpdate, string, number)	Updates die Dauer oder den Pipelineschutz status einer Aufbewahrungsleasase.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Updates die Aufbewahrungseinstellungen des Projekts.
updateStage(UpdateStageParameters, number, string, string)	Aktualisieren einer Buildphase

Details zum Konstruktor

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

addBuildTag(string, number, string)

Fügt einem Build ein Tag hinzu.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

tag: string

Das hinzuzufügende Tag.

Gibt zurück

Promise<string[]>

addBuildTags(string[], string, number)

Fügt einem Build Tags hinzu.

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

Parameter

tags: string[]

Die hinzuzufügenden Tags. Anforderungstext wird direkt aus aufgelisteten Tags zusammengesetzt.

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

Gibt zurück

Promise<string[]>

addDefinitionTag(string, number, string)

Fügt einer Definition ein Tag hinzu

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

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

tag: string

Das hinzuzufügende Tag.

Gibt zurück

Promise<string[]>

addDefinitionTags(string[], string, number)

Fügt einer Definition mehrere Tags hinzu.

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

Parameter

tags: string[]

Die hinzuzufügenden Tags.

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

Gibt zurück

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Fügt neue Leases für Pipelineausführungen hinzu.

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

Parameter

newLeases: NewRetentionLease[]

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

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

Parameter

resources: DefinitionResourceReference[]

project: string

Projekt-ID oder Projektname

definitionId: number

Gibt zurück

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

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

Parameter

resources: DefinitionResourceReference[]

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Ordnet ein Artefakt einem Build zu.

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

Parameter

artifact: BuildArtifact

Das Artefakt.

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

Gibt zurück

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Erstellt eine neue Definition.

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

Parameter

definition: BuildDefinition

Die Definition.

project: string

Projekt-ID oder Projektname

definitionToCloneId: number

definitionToCloneRevision: number

Gibt zurück

Promise<BuildDefinition>

createFolder(Folder, string, string)

Erstellt einen neuen Ordner.

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

Parameter

folder: Folder

Der Ordner.

project: string

Projekt-ID oder Projektname

path: string

Der vollständige Pfad des Ordners.

Gibt zurück

Promise<Folder>

deleteBuild(string, number)

Löscht einen Build.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

Gibt zurück

Promise<void>

deleteBuildTag(string, number, string)

Entfernt ein Tag aus einem Build. HINWEIS: Diese API funktioniert nicht für Tags mit Sonderzeichen. Um Tags mit Sonderzeichen zu entfernen, verwenden Sie stattdessen die PATCH-Methode (in 6.0 und höher).

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

tag: string

Das zu entfernende Tag.

Gibt zurück

Promise<string[]>

deleteDefinition(string, number)

Löscht eine Definition und alle zugeordneten Builds.

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

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

Gibt zurück

Promise<void>

deleteDefinitionTag(string, number, string)

Entfernt ein Tag aus einer Definition. HINWEIS: Diese API funktioniert nicht für Tags mit Sonderzeichen. Um Tags mit Sonderzeichen zu entfernen, verwenden Sie stattdessen die PATCH-Methode (in 6.0 und höher).

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

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

tag: string

Das zu entfernende Tag.

Gibt zurück

Promise<string[]>

deleteFolder(string, string)

Löscht einen Definitionsordner. Definitionen und die entsprechenden Builds werden ebenfalls gelöscht.

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

Parameter

project: string

Projekt-ID oder Projektname

path: string

Der vollständige Pfad zum Ordner.

Gibt zurück

Promise<void>

deleteRetentionLeasesById(string, number[])

Entfernt bestimmte Aufbewahrungsleases.

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

Parameter

project: string

Projekt-ID oder Projektname

ids: number[]

Gibt zurück

Promise<void>

deleteTag(string, string)

Entfernt ein Tag aus Builds, Definitionen und aus dem Tagspeicher.

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

Parameter

project: string

Projekt-ID oder Projektname

tag: string

Das zu entfernende Tag.

Gibt zurück

Promise<string[]>

deleteTemplate(string, string)

Löscht eine Builddefinitionsvorlage.

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

Parameter

project: string

Projekt-ID oder Projektname

templateId: string

Die ID der Vorlage.

Gibt zurück

Promise<void>

getArtifact(string, number, string)

Ruft ein bestimmtes Artefakt für einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

artifactName: string

Der Name des Artefakts.

Gibt zurück

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Ruft ein bestimmtes Artefakt für einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

artifactName: string

Der Name des Artefakts.

Gibt zurück

Promise<ArrayBuffer>

getArtifacts(string, number)

Ruft alle Artefakte für einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

Gibt zurück

Promise<BuildArtifact[]>

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

Ruft eine bestimmte Anlage ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

timelineId: string

Die ID des Zeitleiste.

recordId: string

Die ID des Zeitleiste Datensatzes.

type: string

Der Typ der Anlage.

name: string

Der Name der Anlage.

Gibt zurück

Promise<ArrayBuffer>

getAttachments(string, number, string)

Ruft die Liste der Anlagen eines bestimmten Typs ab, die einem Build zugeordnet sind.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

type: string

Der Typ der Anlage.

Gibt zurück

Promise<Attachment[]>

getBadge(string, number, string)

Ruft ein Badge ab, das die status des letzten Builds für eine Definition angibt. Beachten Sie, dass diese API veraltet ist. Bevorzugen Sie StatusBadgeController.GetStatusBadge.

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

Parameter

project: string

Die Projekt-ID oder der Name.

definitionId: number

Die ID der Definition.

branchName: string

Der Name des Branchs.

Gibt zurück

Promise<string>

getBuild(string, number, string)

Ruft einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

propertyFilters: string

Gibt zurück

Promise<Build>

getBuildBadge(string, string, string, string)

Ruft einen Badge ab, der die status des letzten Builds für den angegebenen Branch angibt.

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

Parameter

project: string

Projekt-ID oder Projektname

repoType: string

Der Repositorytyp.

repoId: string

Die Repository-ID.

branchName: string

Der Verzweigungsname.

Gibt zurück

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Ruft einen Badge ab, der die status des letzten Builds für den angegebenen Branch angibt.

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

Parameter

project: string

Projekt-ID oder Projektname

repoType: string

Der Repositorytyp.

repoId: string

Die Repository-ID.

branchName: string

Der Verzweigungsname.

Gibt zurück

Promise<string>

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

Ruft die einem Build zugeordneten Änderungen ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

continuationToken: string

top: number

Die maximale Anzahl der zurückzugebenden Änderungen

includeSourceChange: boolean

Gibt zurück

Promise<PagedList<Change>>

getBuildController(number)

Ruft einen Controller ab.

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

Parameter

controllerId: number

Gibt zurück

Promise<BuildController>

getBuildControllers(string)

Ruft den Controller ab, optional nach Namen gefiltert.

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

Parameter

name: string

Gibt zurück

Promise<BuildController[]>

getBuildGeneralSettings(string)

Ruft allgemeine Pipelineeinstellungen ab.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<PipelineGeneralSettings>

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

Ruft eine einzelne Protokolldatei für einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

logId: number

Die ID der Protokolldatei.

startLine: number

Die Anfangszeile.

endLine: number

Die Endzeile.

Gibt zurück

Promise<string>

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

Ruft eine einzelne Protokolldatei für einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

logId: number

Die ID der Protokolldatei.

startLine: number

Die Anfangszeile.

endLine: number

Die Endzeile.

Gibt zurück

Promise<string[]>

getBuildLogs(string, number)

Ruft die Protokolle für einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

Gibt zurück

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Ruft die Protokolle für einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

Gibt zurück

Promise<ArrayBuffer>

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

Ruft eine einzelne Protokolldatei für einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

logId: number

Die ID der Protokolldatei.

startLine: number

Die Anfangszeile.

endLine: number

Die Endzeile.

Gibt zurück

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Ruft alle Builddefinitionsoptionen ab, die vom System unterstützt werden.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Ruft Eigenschaften für einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

filter: string[]

Eine durch Trennzeichen getrennte Liste von Eigenschaften. Wenn angegeben, filtert nach diesen spezifischen Eigenschaften.

Gibt zurück

Promise<any>

getBuildReport(string, number, string)

Ruft einen Buildbericht ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

type: string

Gibt zurück

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Ruft einen Buildbericht ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

type: string

Gibt zurück

Promise<any>

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

Ruft eine Liste der Builds ab.

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

Parameter

project: string

Projekt-ID oder Projektname

definitions: number[]

Eine durch Trennzeichen getrennte Liste von Definitions-IDs. Wenn angegeben, filtert nach Builds für diese Definitionen.

queues: number[]

Eine durch Trennzeichen getrennte Liste von Warteschlangen-IDs. Wenn angegeben, filtert sie nach Builds, die für diese Warteschlangen ausgeführt wurden.

buildNumber: string

Wenn angegeben, filtert nach Builds, die dieser Buildnummer entsprechen. Fügen Sie * an, um eine Präfixsuche durchzuführen.

minTime: Date

Wenn angegeben, filtert nach Builds, die nach diesem Datum abgeschlossen/gestartet/in die Warteschlange eingereiht wurden, basierend auf dem angegebenen queryOrder-Wert.

maxTime: Date

Wenn angegeben, filtert nach Builds, die vor diesem Datum abgeschlossen/gestartet/in die Warteschlange eingereiht wurden, basierend auf dem angegebenen queryOrder-Wert.

requestedFor: string

Wenn angegeben, filtert nach Builds, die für den angegebenen Benutzer angefordert werden.

reasonFilter: BuildReason

Wenn angegeben, filtert nach Builds, die diesem Grund entsprechen.

statusFilter: BuildStatus

Falls angegeben, filtert sie nach Builds, die diesem status entsprechen.

resultFilter: BuildResult

Wenn angegeben, filtert nach Builds, die diesem Ergebnis entsprechen.

tagFilters: string[]

Eine durch Trennzeichen getrennte Liste von Tags. Falls angegeben, filtert sie nach Builds, die die angegebenen Tags aufweisen.

properties: string[]

Eine durch Trennzeichen getrennte Liste der abzurufenden Eigenschaften.

top: number

Die maximale Anzahl von Builds, die zurückgegeben werden sollen.

continuationToken: string

Ein Fortsetzungstoken, das von einem vorherigen Aufruf dieser Methode zurückgegeben wurde, das verwendet werden kann, um den nächsten Buildsatz zurückzugeben.

maxBuildsPerDefinition: number

Die maximale Anzahl von Builds, die pro Definition zurückgegeben werden sollen.

deletedFilter: QueryDeletedOption

Gibt an, ob gelöschte Builds ausgeschlossen, eingeschlossen oder nur zurückgegeben werden sollen.

queryOrder: BuildQueryOrder

Die Reihenfolge, in der Builds zurückgegeben werden sollen.

branchName: string

Wenn angegeben, filtert nach Builds, die Verzweigungen erstellt haben, die diesen Branch erstellt haben.

buildIds: number[]

Eine durch Trennzeichen getrennte Liste, die die IDs der abzurufenden Builds angibt.

repositoryId: string

Falls angegeben, filtert nach Builds, die aus diesem Repository erstellt wurden.

repositoryType: string

Wenn angegeben, filtert nach Builds, die aus Repositorys dieses Typs erstellt wurden.

Gibt zurück

Promise<PagedList<Build>>

getBuildSettings(string)

Ruft die Buildeinstellungen ab.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<BuildSettings>

getBuildTags(string, number)

Ruft die Tags für einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

Gibt zurück

Promise<string[]>

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

Ruft Details für einen Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

timelineId: string

changeId: number

planId: string

Gibt zurück

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Ruft die einem Build zugeordneten Arbeitselemente ab. Es werden nur Arbeitselemente im selben Projekt zurückgegeben.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

top: number

Die maximale Anzahl der zurückzugebenden Arbeitselemente.

Gibt zurück

Promise<ResourceRef[]>

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

Ruft die einem Build zugeordneten Arbeitselemente ab, die nach bestimmten Commits gefiltert werden.

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

Parameter

commitIds: string[]

Eine durch Trennzeichen getrennte Liste von Commit-IDs.

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

top: number

Die maximale Anzahl der zurückzugebenden Arbeitselemente oder die Anzahl der Commits, die berücksichtigt werden sollen, wenn keine Commit-IDs angegeben sind.

Gibt zurück

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Ruft die Änderungen ab, die zwischen zwei angegebenen Builds am Repository vorgenommen wurden.

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

Parameter

project: string

Projekt-ID oder Projektname

fromBuildId: number

Die ID des ersten Builds.

toBuildId: number

Die ID des letzten Builds.

top: number

Die maximale Anzahl der zurückzugebenden Änderungen.

Gibt zurück

Promise<Change[]>

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

Ruft eine Definition ab, optional bei einer bestimmten Revision.

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

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

revision: number

Die abzurufende Revisionsnummer. Wenn dies nicht angegeben ist, wird die neueste Version zurückgegeben.

minMetricsTime: Date

Wenn angegeben, gibt das Datum an, ab dem Metriken eingeschlossen werden sollen.

propertyFilters: string[]

Eine durch Trennzeichen getrennte Liste von Eigenschaften, die in die Ergebnisse eingeschlossen werden sollen.

includeLatestBuilds: boolean

Gibt zurück

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Ruft Buildmetriken für eine Definition ab.

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

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

minMetricsTime: Date

Das Datum, ab dem Metriken berechnet werden sollen.

Gibt zurück

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Ruft Eigenschaften für eine Definition ab.

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

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

filter: string[]

Eine durch Trennzeichen getrennte Liste von Eigenschaften. Wenn angegeben, filtert nach diesen spezifischen Eigenschaften.

Gibt zurück

Promise<any>

getDefinitionResources(string, number)

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

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Gibt zurück

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Ruft alle Überarbeitungen einer Definition ab.

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

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

Gibt zurück

Promise<BuildDefinitionRevision[]>

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

Ruft eine Liste von Definitionen ab.

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

Parameter

project: string

Projekt-ID oder Projektname

name: string

Wenn angegeben, filtert sie nach Definitionen, deren Namen diesem Muster entsprechen.

repositoryId: string

Eine Repository-ID. Wenn angegeben, filtert sie nach Definitionen, die dieses Repository verwenden.

repositoryType: string

Wenn angegeben, filtert sie nach Definitionen, die über ein Repository dieses Typs verfügen.

queryOrder: DefinitionQueryOrder

Gibt die Reihenfolge an, in der Definitionen zurückgegeben werden sollen.

top: number

Die maximale Anzahl der zurückzugebenden Definitionen.

continuationToken: string

Ein Fortsetzungstoken, das von einem vorherigen Aufruf dieser Methode zurückgegeben wurde, das verwendet werden kann, um den nächsten Satz von Definitionen zurückzugeben.

minMetricsTime: Date

Wenn angegeben, gibt das Datum an, ab dem Metriken eingeschlossen werden sollen.

definitionIds: number[]

Eine durch Trennzeichen getrennte Liste, die die IDs der abzurufenden Definitionen angibt.

path: string

Wenn angegeben, filtert sie nach Definitionen unter diesem Ordner.

builtAfter: Date

Wenn angegeben, filtert nach Definitionen, die builds nach diesem Datum haben.

notBuiltAfter: Date

Wenn angegeben, filtert sie nach Definitionen, die nach diesem Datum keine Builds haben.

includeAllProperties: boolean

Gibt an, ob die vollständigen Definitionen zurückgegeben werden sollen. Standardmäßig werden flache Darstellungen der Definitionen zurückgegeben.

includeLatestBuilds: boolean

Gibt an, ob die neuesten und letzten abgeschlossenen Builds für diese Definition zurückgegeben werden sollen.

taskIdFilter: string

Wenn angegeben, filtert sie nach Definitionen, die die angegebene Aufgabe verwenden.

processType: number

Wenn angegeben, filtert nach Definitionen mit dem angegebenen Prozesstyp.

yamlFilename: string

Wenn angegeben, filtert sie nach YAML-Definitionen, die dem angegebenen Dateinamen entsprechen. Um diesen Filter zu verwenden, muss includeAllProperties auf true festgelegt werden.

Gibt zurück

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Ruft die Tags für eine Definition ab.

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

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

revision: number

Die Revisionsnummer der Definition. Wenn nicht angegeben, wird die neueste Revision der Definition verwendet.

Gibt zurück

Promise<string[]>

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

Konvertiert eine Definition in YAML, optional bei einer bestimmten Revision.

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

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

revision: number

Die abzurufende Revisionsnummer. Wenn dies nicht angegeben ist, wird die neueste Version zurückgegeben.

minMetricsTime: Date

Wenn angegeben, gibt das Datum an, ab dem Metriken eingeschlossen werden sollen.

propertyFilters: string[]

Eine durch Trennzeichen getrennte Liste von Eigenschaften, die in die Ergebnisse eingeschlossen werden sollen.

includeLatestBuilds: boolean

Gibt zurück

Promise<YamlBuild>

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

Ruft eine Datei aus dem Build ab.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

artifactName: string

Der Name des Artefakts.

fileId: string

Der Primärschlüssel für die Datei.

fileName: string

Der Name, auf den die Datei festgelegt wird.

Gibt zurück

Promise<ArrayBuffer>

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

Ruft den Inhalt einer Datei im angegebenen Quellcoderepository ab.

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

Parameter

project: string

Projekt-ID oder Projektname

providerName: string

Der Name des Quellanbieters.

serviceEndpointId: string

Wenn angegeben, die ID des abzufragenden Dienstendpunkts. Kann nur für Anbieter weggelassen werden, die keine Dienstendpunkte verwenden, z. B. TFVC oder TFGit.

repository: string

Falls angegeben, der anbieterspezifische Bezeichner oder der Name des Repositorys zum Abrufen von Branches. Kann nur für Anbieter weggelassen werden, die mehrere Repositorys nicht unterstützen.

commitOrBranch: string

Der Bezeichner des Commits oder Branchs, aus dem der Inhalt einer Datei abgerufen wird.

path: string

Der Pfad zur abzurufenden Datei relativ zum Stammverzeichnis des Repositorys.

Gibt zurück

Promise<string>

getFolders(string, string, FolderQueryOrder)

Ruft eine Liste der Builddefinitionsordner ab.

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

Parameter

project: string

Projekt-ID oder Projektname

path: string

Der Pfad, mit dem begonnen werden soll.

queryOrder: FolderQueryOrder

Die Reihenfolge, in der Ordner zurückgegeben werden sollen.

Gibt zurück

Promise<Folder[]>

getLatestBuild(string, string, string)

Ruft den neuesten Build für eine Definition ab, der optional auf einen bestimmten Branch ausgerichtet ist.

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

Parameter

project: string

Projekt-ID oder Projektname

definition: string

Definitionsname mit optionalem führendem Ordnerpfad oder der Definitions-ID

branchName: string

optionaler Parameter, der den zu verwendenden branch angibt. Wenn nicht angegeben, wird die Standardbranch verwendet.

Gibt zurück

Promise<Build>

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

Ruft den Inhalt eines Verzeichnisses im angegebenen Quellcoderepository ab.

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

Parameter

project: string

Projekt-ID oder Projektname

providerName: string

Der Name des Quellanbieters.

serviceEndpointId: string

Wenn angegeben, die ID des abzufragenden Dienstendpunkts. Kann nur für Anbieter weggelassen werden, die keine Dienstendpunkte verwenden, z. B. TFVC oder TFGit.

repository: string

Falls angegeben, der anbieterspezifische Bezeichner oder der Name des Repositorys zum Abrufen von Branches. Kann nur für Anbieter weggelassen werden, die mehrere Repositorys nicht unterstützen.

commitOrBranch: string

Der Bezeichner des Commits oder Branchs, aus dem der Inhalt einer Datei abgerufen wird.

path: string

Der zu listende Pfadinhalt relativ zum Stammverzeichnis des Repositorys.

Gibt zurück

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Ruft Buildmetriken für ein Projekt ab.

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

Parameter

project: string

Projekt-ID oder Projektname

metricAggregationType: string

Der zu verwendende Aggregationstyp (stündlich, täglich).

minMetricsTime: Date

Das Datum, ab dem Metriken berechnet werden sollen.

Gibt zurück

Promise<BuildMetric[]>

getProjectResources(string, string, string)

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

Parameter

project: string

Projekt-ID oder Projektname

type: string

id: string

Gibt zurück

Promise<DefinitionResourceReference[]>

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

Ruft ein Pull Request-Objekt vom Quellanbieter ab.

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

Parameter

project: string

Projekt-ID oder Projektname

providerName: string

Der Name des Quellanbieters.

pullRequestId: string

Anbieterspezifische ID des Pull Requests.

repositoryId: string

Anbieterspezifischer Bezeichner oder der Name des Repositorys, das den Pull Request enthält.

serviceEndpointId: string

Wenn angegeben, die ID des abzufragenden Dienstendpunkts. Kann nur für Anbieter weggelassen werden, die keine Dienstendpunkte verwenden, z. B. TFVC oder TFGit.

Gibt zurück

Promise<PullRequest>

getResourceUsage()

Ruft Informationen zu Buildressourcen im System ab.

function getResourceUsage(): Promise<BuildResourceUsage>

Gibt zurück

Promise<BuildResourceUsage>

getRetentionHistory(number)

Gibt den Aufbewahrungsverlauf für die Projektauflistung zurück. Dies umfasst Pipelines mit benutzerdefinierten Aufbewahrungsregeln, die möglicherweise verhindern, dass der Aufbewahrungsauftrag sie bereinigen kann, die Ausführung pro Pipeline mit Aufbewahrungstyp, Dateien, die Pipelines zugeordnet sind, die der Sammlung mit aufbewahrungstyp gehören, und die Anzahl der Dateien pro Pipeline.

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

Parameter

daysToLookback: number

Gibt zurück

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Gibt die Details der Aufbewahrungsleasase unter Angabe einer Lease-ID zurück.

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

Parameter

project: string

Projekt-ID oder Projektname

leaseId: number

Gibt zurück

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Gibt alle Leases zurück, die den angegebenen MinimalRetentionLeases entsprechen.

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

Parameter

project: string

Projekt-ID oder Projektname

leasesToFetch: MinimalRetentionLease[]

Liste der JSON-serialisierten MinimalRetentionLeases, die durch "|" getrennt sind

Gibt zurück

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Gibt alle Leases im Besitz der angegebenen Entität zurück, die optional auf eine einzelne Pipelinedefinition und ausführung ausgerichtet sind.

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

Parameter

project: string

Projekt-ID oder Projektname

ownerId: string

definitionId: number

Ein optionaler Parameter, um die Suche auf eine bestimmte Pipelinedefinition zu beschränken.

runId: number

Ein optionaler Parameter, um die Suche auf eine einzelne Pipelineausführung zu beschränken. Erfordert definitionId.

Gibt zurück

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Gibt alle Leases im Besitz des angegebenen Benutzers zurück, die optional auf eine einzelne Pipelinedefinition und ausführung ausgerichtet sind.

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

Parameter

project: string

Projekt-ID oder Projektname

userOwnerId: string

Die zu suchde Benutzer-ID.

definitionId: number

Ein optionaler Parameter, um die Suche auf eine bestimmte Pipelinedefinition zu beschränken.

runId: number

Ein optionaler Parameter, um die Suche auf eine einzelne Pipelineausführung zu beschränken. Erfordert definitionId.

Gibt zurück

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Ruft alle Aufbewahrungsleases ab, die für einen bestimmten Build gelten.

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

Parameter

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

Gibt zurück

Promise<RetentionLease[]>

getRetentionSettings(string)

Ruft die Aufbewahrungseinstellungen des Projekts ab.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ProjectRetentionSetting>

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

<p>Ruft die Build-status für eine Definition ab, die optional auf eine bestimmte Verzweigung, Phase, Auftrag und Konfiguration festgelegt ist.< /p><p>Wenn mehrere vorhanden sind, muss beim Angeben eines auftragsName-Werts ein stageName-Wert übergeben werden, und die gleiche Regel gilt dann für beide, wenn ein Konfigurationsparameter übergeben wird.< /P>

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

Parameter

project: string

Projekt-ID oder Projektname

definition: string

Entweder der Definitionsname mit optionalem führendem Ordnerpfad oder die Definitions-ID.

branchName: string

Berücksichtigen Sie nur den neuesten Build für diesen Branch. Wenn nicht angegeben, wird die Standardbranch verwendet.

stageName: string

Verwenden Sie diese Phase innerhalb der Pipeline, um die status zu rendern.

jobName: string

Verwenden Sie diesen Auftrag innerhalb einer Phase der Pipeline, um die status zu rendern.

configuration: string

Verwenden Sie diese Auftragskonfiguration, um die status

label: string

Ersetzt den Standardtext auf der linken Seite des Badges.

Gibt zurück

Promise<string>

getTags(string)

Ruft eine Liste aller Buildtags im Projekt ab.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<string[]>

getTemplate(string, string)

Ruft eine bestimmte Builddefinitionsvorlage ab.

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

Parameter

project: string

Projekt-ID oder Projektname

templateId: string

Die ID der angeforderten Vorlage.

Gibt zurück

Promise<BuildDefinitionTemplate>

getTemplates(string)

Ruft alle Definitionsvorlagen ab.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Ruft alle Arbeitselemente zwischen zwei Builds ab.

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

Parameter

project: string

Projekt-ID oder Projektname

fromBuildId: number

Die ID des ersten Builds.

toBuildId: number

Die ID des letzten Builds.

top: number

Die maximale Anzahl der zurückzugebenden Arbeitselemente.

Gibt zurück

Promise<ResourceRef[]>

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

Ruft eine Liste von Branches für das angegebene Quellcoderepository ab.

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

Parameter

project: string

Projekt-ID oder Projektname

providerName: string

Der Name des Quellanbieters.

serviceEndpointId: string

Wenn angegeben, die ID des abzufragenden Dienstendpunkts. Kann nur für Anbieter weggelassen werden, die keine Dienstendpunkte verwenden, z. B. TFVC oder TFGit.

repository: string

Der anbieterspezifische Bezeichner oder der Name des Repositorys zum Abrufen von Branches. Kann nur für Anbieter weggelassen werden, die mehrere Repositorys nicht unterstützen.

branchName: string

Wenn angegeben, der Name des Branchs, auf den speziell überprüft werden soll.

Gibt zurück

Promise<string[]>

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

Ruft eine Liste der Quellcoderepositorys ab.

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

Parameter

project: string

Projekt-ID oder Projektname

providerName: string

Der Name des Quellanbieters.

serviceEndpointId: string

Wenn angegeben, die ID des abzufragenden Dienstendpunkts. Kann nur für Anbieter weggelassen werden, die keine Dienstendpunkte verwenden, z. B. TFVC oder TFGit.

repository: string

Falls angegeben, der anbieterspezifische Bezeichner oder der Name eines einzelnen abzurufenden Repositorys.

resultSet: ResultSet

"top" für die Repositorys, die für den Endpunkt am relevantesten sind. Wenn nicht festgelegt, werden alle Repositorys zurückgegeben. Wird ignoriert, wenn "Repository" festgelegt ist.

pageResults: boolean

Wenn dieser Wert auf true festgelegt ist, wird der Ergebnissatz eingeschränkt, und es wird ein Fortsetzungstoken zurückgegeben, um die Abfrage fortzusetzen.

continuationToken: string

Beim Auslagern von Ergebnissen handelt es sich um ein Fortsetzungstoken, das von einem vorherigen Aufruf dieser Methode zurückgegeben wurde und verwendet werden kann, um den nächsten Satz von Repositorys zurückzugeben.

Gibt zurück

Promise<SourceRepositories>

listSourceProviders(string)

Rufen Sie eine Liste der Quellanbieter und deren Funktionen ab.

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

Parameter

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Ruft eine Liste der Webhooks ab, die im angegebenen Quellcoderepository installiert sind.

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

Parameter

project: string

Projekt-ID oder Projektname

providerName: string

Der Name des Quellanbieters.

serviceEndpointId: string

Wenn angegeben, die ID des abzufragenden Dienstendpunkts. Kann nur für Anbieter weggelassen werden, die keine Dienstendpunkte verwenden, z. B. TFVC oder TFGit.

repository: string

Falls angegeben, der anbieterspezifische Bezeichner oder der Name des Repositorys zum Abrufen von Webhooks. Kann nur für Anbieter weggelassen werden, die mehrere Repositorys nicht unterstützen.

Gibt zurück

Promise<RepositoryWebhook[]>

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

Ein Build wird in die Warteschlange gestellt.

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

Parameter

build: Build

project: string

Projekt-ID oder Projektname

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

Optionale Definitions-ID, um einen Build ohne Text in die Warteschlange zu stellen. Ignoriert, wenn ein gültiger Text vorhanden ist

Gibt zurück

Promise<Build>

restoreDefinition(string, number, boolean)

Wiederherstellen einer gelöschten Definition

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

Parameter

project: string

Projekt-ID oder Projektname

definitionId: number

Der Bezeichner der wiederherzustellenden Definition.

deleted: boolean

Bei false wird eine gelöschte Definition wiederhergestellt.

Gibt zurück

Promise<BuildDefinition>

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

Erstellt die Webhooks für die angegebenen Trigger im angegebenen Quellcoderepository neu.

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

Parameter

triggerTypes: DefinitionTriggerType[]

Die Typen von Triggern, für die Webhooks wiederhergestellt werden sollen.

project: string

Projekt-ID oder Projektname

providerName: string

Der Name des Quellanbieters.

serviceEndpointId: string

Wenn angegeben, die ID des abzufragenden Dienstendpunkts. Kann nur für Anbieter weggelassen werden, die keine Dienstendpunkte verwenden, z. B. TFVC oder TFGit.

repository: string

Falls angegeben, der anbieterspezifische Bezeichner oder der Name des Repositorys zum Abrufen von Webhooks. Kann nur für Anbieter weggelassen werden, die mehrere Repositorys nicht unterstützen.

Gibt zurück

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Updates einer vorhandenen Builddefinitionsvorlage.

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

Parameter

template: BuildDefinitionTemplate

Die neue Version der Vorlage.

project: string

Projekt-ID oder Projektname

templateId: string

Die ID der Vorlage.

Gibt zurück

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Updates einen Build.

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

Parameter

build: Build

Der Build.

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

retry: boolean

Gibt zurück

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Updates allgemeinen Einstellungen für die Pipeline.

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

Parameter

newSettings: PipelineGeneralSettings

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Updates Eigenschaften für einen Build.

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

Parameter

document: JsonPatchDocument

Ein json-patch-Dokument, das die zu aktualisierenden Eigenschaften beschreibt.

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

Gibt zurück

Promise<any>

updateBuilds(Build[], string)

Updates mehrere Builds.

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

Parameter

builds: Build[]

Die zu aktualisierenden Builds.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Updates die Buildeinstellungen aus.

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

Parameter

settings: BuildSettings

Die neuen Einstellungen.

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Fügt Tags aus einem Build hinzu/entfernt sie.

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

Parameter

updateParameters: UpdateTagParameters

Die tags, die hinzugefügt/entfernt werden sollen.

project: string

Projekt-ID oder Projektname

buildId: number

Die ID des Builds.

Gibt zurück

Promise<string[]>

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

Updates einer vorhandenen Builddefinition. Damit dieser Vorgang erfolgreich ausgeführt werden kann, muss der Wert der Eigenschaft "Revision" des Anforderungstexts mit dem der vorhandenen Builddefinition übereinstimmen. Es wird empfohlen, die vorhandene Builddefinition mithilfe von GET abzurufen, die Builddefinition nach Bedarf zu ändern und dann die geänderte Definition mit PUT zu übermitteln.

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

Parameter

definition: BuildDefinition

Die neue Version der Definition. Die Eigenschaft "Revision" muss mit der vorhandenen Definition übereinstimmen, damit das Update akzeptiert wird.

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Gibt zurück

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Updates Eigenschaften für eine Definition.

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

Parameter

document: JsonPatchDocument

Ein json-patch-Dokument, das die zu aktualisierenden Eigenschaften beschreibt.

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

Gibt zurück

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Fügt einer Definition Tags hinzu/entfernt sie.

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

Parameter

updateParameters: UpdateTagParameters

Die tags, die hinzugefügt/entfernt werden sollen.

project: string

Projekt-ID oder Projektname

definitionId: number

Die ID der Definition.

Gibt zurück

Promise<string[]>

updateFolder(Folder, string, string)

Updates eines vorhandenen Ordners unter einem vorhandenen Pfad

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

Parameter

folder: Folder

Die neue Version des Ordners.

project: string

Projekt-ID oder Projektname

path: string

Der vollständige Pfad zum Ordner.

Gibt zurück

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Updates die Dauer oder den Pipelineschutz status einer Aufbewahrungsleasase.

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

Parameter

leaseUpdate: RetentionLeaseUpdate

Die neuen Daten für die Aufbewahrungsleasase.

project: string

Projekt-ID oder Projektname

leaseId: number

Die ID der zu aktualisierenden Lease.

Gibt zurück

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Updates die Aufbewahrungseinstellungen des Projekts.

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

Parameter

updateModel: UpdateProjectRetentionSettingModel

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Aktualisieren einer Buildphase

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

Parameter

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

Share via

BuildRestClient class

Konstruktoren

Eigenschaften

Methoden

Details zum Konstruktor

BuildRestClient(IVssRestClientOptions)

Parameter

Details zur Eigenschaft

RESOURCE_AREA_ID

Eigenschaftswert

Details zur Methode

addBuildTag(string, number, string)

Parameter

Gibt zurück

addBuildTags(string[], string, number)

Parameter

Gibt zurück

addDefinitionTag(string, number, string)

Parameter

Gibt zurück

addDefinitionTags(string[], string, number)

Parameter

Gibt zurück

addRetentionLeases(NewRetentionLease[], string)

Parameter

Gibt zurück

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parameter

Gibt zurück

authorizeProjectResources(DefinitionResourceReference[], string)

Parameter

Gibt zurück

createArtifact(BuildArtifact, string, number)

Parameter

Gibt zurück

createDefinition(BuildDefinition, string, number, number)

Parameter

Gibt zurück

createFolder(Folder, string, string)

Parameter

Gibt zurück

deleteBuild(string, number)

Parameter

Gibt zurück

deleteBuildTag(string, number, string)

Parameter

Gibt zurück

deleteDefinition(string, number)

Parameter

Gibt zurück

deleteDefinitionTag(string, number, string)

Parameter

Gibt zurück

deleteFolder(string, string)

Parameter

Gibt zurück

deleteRetentionLeasesById(string, number[])

Parameter

Gibt zurück

deleteTag(string, string)

Parameter

Gibt zurück

deleteTemplate(string, string)

Parameter

Gibt zurück

getArtifact(string, number, string)

Parameter

Gibt zurück

getArtifactContentZip(string, number, string)

Parameter

Gibt zurück

getArtifacts(string, number)

Parameter

Gibt zurück

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

Parameter

Gibt zurück

getAttachments(string, number, string)

Parameter