BuildRestClient class

Odwołanie

Pakiet:: azure-devops-extension-api

Klasa bazowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends: RestClientBase

Konstruktory

BuildRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

addBuildTag(string, number, string)	Dodaje tag do kompilacji.
addBuildTags(string[], string, number)	Dodaje tagi do kompilacji.
addDefinitionTag(string, number, string)	Dodaje tag do definicji
addDefinitionTags(string[], string, number)	Dodaje wiele tagów do definicji.
addRetentionLeases(NewRetentionLease[], string)	Dodaje nowe dzierżawy dla przebiegów potoków.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Kojarzy artefakt z kompilacją.
createDefinition(BuildDefinition, string, number, number)	Tworzy nową definicję.
createFolder(Folder, string, string)	Tworzy nowy folder.
deleteBuild(string, number)	Usuwa kompilację.
deleteBuildTag(string, number, string)	Usuwa tag z kompilacji. UWAGA: ten interfejs API nie będzie działać w przypadku tagów ze znakami specjalnymi. Aby usunąć tagi ze znakami specjalnymi, użyj metody PATCH zamiast (w wersji 6.0 lub nowszej)
deleteDefinition(string, number)	Usuwa definicję i wszystkie skojarzone kompilacje.
deleteDefinitionTag(string, number, string)	Usuwa tag z definicji. UWAGA: ten interfejs API nie będzie działać w przypadku tagów ze znakami specjalnymi. Aby usunąć tagi ze znakami specjalnymi, użyj metody PATCH zamiast (w wersji 6.0 lub nowszej)
deleteFolder(string, string)	Usuwa folder definicji. Definicje i odpowiadające im kompilacje również zostaną usunięte.
deleteRetentionLeasesById(string, number[])	Usuwa określone dzierżawy przechowywania.
deleteTag(string, string)	Usuwa tag z kompilacji, definicji i z magazynu tagów
deleteTemplate(string, string)	Usuwa szablon definicji kompilacji.
getArtifact(string, number, string)	Pobiera określony artefakt dla kompilacji.
getArtifactContentZip(string, number, string)	Pobiera określony artefakt dla kompilacji.
getArtifacts(string, number)	Pobiera wszystkie artefakty dla kompilacji.
getAttachment(string, number, string, string, string, string)	Pobiera określony załącznik.
getAttachments(string, number, string)	Pobiera listę załączników określonego typu, które są skojarzone z kompilacją.
getBadge(string, number, string)	Pobiera wskaźnik wskazujący stan najnowszej kompilacji dla definicji. Pamiętaj, że ten interfejs API jest przestarzały. Preferuj statusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Pobiera kompilację
getBuildBadge(string, string, string, string)	Pobiera wskaźnik wskazujący stan najnowszej kompilacji dla określonej gałęzi.
getBuildBadgeData(string, string, string, string)	Pobiera wskaźnik wskazujący stan najnowszej kompilacji dla określonej gałęzi.
getBuildChanges(string, number, string, number, boolean)	Pobiera zmiany skojarzone z kompilacją
getBuildController(number)	Pobiera kontroler
getBuildControllers(string)	Pobiera kontroler, opcjonalnie filtrowany według nazwy
getBuildGeneralSettings(string)	Pobiera ustawienia ogólne potoku.
getBuildLog(string, number, number, number, number)	Pobiera pojedynczy plik dziennika dla kompilacji.
getBuildLogLines(string, number, number, number, number)	Pobiera pojedynczy plik dziennika dla kompilacji.
getBuildLogs(string, number)	Pobiera dzienniki dla kompilacji.
getBuildLogsZip(string, number)	Pobiera dzienniki dla kompilacji.
getBuildLogZip(string, number, number, number, number)	Pobiera pojedynczy plik dziennika dla kompilacji.
getBuildOptionDefinitions(string)	Pobiera wszystkie opcje definicji kompilacji obsługiwane przez system.
getBuildProperties(string, number, string[])	Pobiera właściwości dla kompilacji.
getBuildReport(string, number, string)	Pobiera raport kompilacji.
getBuildReportHtmlContent(string, number, string)	Pobiera raport kompilacji.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Pobiera listę kompilacji.
getBuildSettings(string)	Pobiera ustawienia kompilacji.
getBuildTags(string, number)	Pobiera tagi dla kompilacji.
getBuildTimeline(string, number, string, number, string)	Pobiera szczegóły kompilacji
getBuildWorkItemsRefs(string, number, number)	Pobiera elementy robocze skojarzone z kompilacją. Zwracane są tylko elementy robocze w tym samym projekcie.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Pobiera elementy robocze skojarzone z kompilacją, filtrowane do określonych zatwierdzeń.
getChangesBetweenBuilds(string, number, number, number)	Pobiera zmiany wprowadzone w repozytorium między dwiema podanymi kompilacjami.
getDefinition(string, number, number, Date, string[], boolean)	Pobiera definicję, opcjonalnie w określonej wersji.
getDefinitionMetrics(string, number, Date)	Pobiera metryki kompilacji dla definicji.
getDefinitionProperties(string, number, string[])	Pobiera właściwości definicji.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Pobiera wszystkie poprawki definicji.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Pobiera listę definicji.
getDefinitionTags(string, number, number)	Pobiera tagi dla definicji.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Konwertuje definicję na YAML, opcjonalnie w określonej wersji.
getFile(string, number, string, string, string)	Pobiera plik z kompilacji.
getFileContents(string, string, string, string, string, string)	Pobiera zawartość pliku w danym repozytorium kodu źródłowego.
getFolders(string, string, FolderQueryOrder)	Pobiera listę folderów definicji kompilacji.
getLatestBuild(string, string, string)	Pobiera najnowszą kompilację dla definicji, opcjonalnie ograniczone do określonej gałęzi.
getPathContents(string, string, string, string, string, string)	Pobiera zawartość katalogu w danym repozytorium kodu źródłowego.
getProjectMetrics(string, string, Date)	Pobiera metryki kompilacji dla projektu.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Pobiera obiekt żądania ściągnięcia od dostawcy źródłowego.
getResourceUsage()	Pobiera informacje o zasobach kompilacji w systemie.
getRetentionHistory(number)	Zwraca historię przechowywania kolekcji projektów. Obejmuje to potoki z niestandardowymi regułami przechowywania, które mogą uniemożliwić czyszczenie zadania przechowywania, uruchomienia na potok z typem przechowywania, plikami skojarzonymi z potokami należącymi do kolekcji z typem przechowywania oraz liczbą plików na potok.
getRetentionLease(string, number)	Zwraca szczegóły dzierżawy przechowywania podanego identyfikatora dzierżawy.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Zwraca wszystkie dzierżawy zgodne z określoną wartością MinimalRetentionLeases
getRetentionLeasesByOwnerId(string, string, number, number)	Zwraca wszystkie dzierżawy należące do określonej jednostki, opcjonalnie ograniczone do pojedynczej definicji i uruchomienia potoku.
getRetentionLeasesByUserId(string, string, number, number)	Zwraca wszystkie dzierżawy należące do określonego użytkownika, opcjonalnie ograniczone do jednej definicji i uruchomienia potoku.
getRetentionLeasesForBuild(string, number)	Pobiera wszystkie dzierżawy przechowywania, które mają zastosowanie do określonej kompilacji.
getRetentionSettings(string)	Pobiera ustawienia przechowywania projektu.
getStatusBadge(string, string, string, string, string, string, string)	<p>Pobiera stan kompilacji definicji, opcjonalnie o określonym zakresie dla określonej gałęzi, etapu, zadania i konfiguracji.< /p Jeśli><>istnieje więcej niż jeden, wymagane jest przekazanie wartości stageName podczas określania nazwy zadania, a ta sama reguła ma zastosowanie zarówno w przypadku przekazania parametru konfiguracji.< /P>
getTags(string)	Pobiera listę wszystkich tagów kompilacji w projekcie.
getTemplate(string, string)	Pobiera określony szablon definicji kompilacji.
getTemplates(string)	Pobiera wszystkie szablony definicji.
getWorkItemsBetweenBuilds(string, number, number, number)	Pobiera wszystkie elementy robocze między dwiema kompilacjami.
listBranches(string, string, string, string, string)	Pobiera listę gałęzi dla danego repozytorium kodu źródłowego.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Pobiera listę repozytoriów kodu źródłowego.
listSourceProviders(string)	Pobierz listę dostawców źródłowych i ich możliwości.
listWebhooks(string, string, string, string)	Pobiera listę elementów webhook zainstalowanych w danym repozytorium kodu źródłowego.
queueBuild(Build, string, boolean, string, number, number)	Kolejkuje kompilację
restoreDefinition(string, number, boolean)	Przywraca usuniętą definicję
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Ponownie utworzy elementy webhook dla określonych wyzwalaczy w danym repozytorium kodu źródłowego.
saveTemplate(BuildDefinitionTemplate, string, string)	Aktualizacje istniejącego szablonu definicji kompilacji.
updateBuild(Build, string, number, boolean)	Aktualizacje kompilacji.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Aktualizacje ustawienia ogólne potoku.
updateBuildProperties(JsonPatchDocument, string, number)	Aktualizacje właściwości kompilacji.
updateBuilds(Build[], string)	Aktualizacje wielu kompilacji.
updateBuildSettings(BuildSettings, string)	Aktualizacje ustawień kompilacji.
updateBuildTags(UpdateTagParameters, string, number)	Dodaje/usuwa tagi z kompilacji.
updateDefinition(BuildDefinition, string, number, number, number)	Aktualizacje istniejącej definicji kompilacji. Aby operacja powiodła się, wartość właściwości "Revision" treści żądania musi być zgodna z definicją istniejącej kompilacji. Zaleca się uzyskanie istniejącej definicji kompilacji przy użyciu polecenia GET, zmodyfikowanie definicji kompilacji w razie potrzeby, a następnie przesłanie zmodyfikowanej definicji za pomocą polecenia PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	Aktualizacje właściwości definicji.
updateDefinitionTags(UpdateTagParameters, string, number)	Dodaje/usuwa tagi z definicji.
updateFolder(Folder, string, string)	Aktualizacje istniejącego folderu pod daną istniejącą ścieżką
updateRetentionLease(RetentionLeaseUpdate, string, number)	Aktualizacje czas trwania lub stan ochrony potoku dzierżawy przechowywania.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Aktualizacje ustawień przechowywania projektu.
updateStage(UpdateStageParameters, number, string, string)	Aktualizowanie etapu kompilacji

Szczegóły konstruktora

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parametry

options: IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

addBuildTag(string, number, string)

Dodaje tag do kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

tag: string

Tag do dodania.

Zwraca

Promise<string[]>

addBuildTags(string[], string, number)

Dodaje tagi do kompilacji.

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

Parametry

tags: string[]

Tagi do dodania. Treść żądania składa się bezpośrednio z wymienionych tagów.

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

Zwraca

Promise<string[]>

addDefinitionTag(string, number, string)

Dodaje tag do definicji

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

tag: string

Tag do dodania.

Zwraca

Promise<string[]>

addDefinitionTags(string[], string, number)

Dodaje wiele tagów do definicji.

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

Parametry

tags: string[]

Tagi do dodania.

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

Zwraca

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Dodaje nowe dzierżawy dla przebiegów potoków.

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

Parametry

newLeases: NewRetentionLease[]

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

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

Parametry

resources: DefinitionResourceReference[]

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Zwraca

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

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

Parametry

resources: DefinitionResourceReference[]

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Kojarzy artefakt z kompilacją.

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

Parametry

artifact: BuildArtifact

Artefakt.

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

Zwraca

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Tworzy nową definicję.

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

Parametry

definition: BuildDefinition

Definicja.

project: string

Identyfikator projektu lub nazwa projektu

definitionToCloneId: number

definitionToCloneRevision: number

Zwraca

Promise<BuildDefinition>

createFolder(Folder, string, string)

Tworzy nowy folder.

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

Parametry

folder: Folder

Folder.

project: string

Identyfikator projektu lub nazwa projektu

path: string

Pełna ścieżka folderu.

Zwraca

Promise<Folder>

deleteBuild(string, number)

Usuwa kompilację.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

Zwraca

Promise<void>

deleteBuildTag(string, number, string)

Usuwa tag z kompilacji. UWAGA: ten interfejs API nie będzie działać w przypadku tagów ze znakami specjalnymi. Aby usunąć tagi ze znakami specjalnymi, użyj metody PATCH zamiast (w wersji 6.0 lub nowszej)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

tag: string

Tag do usunięcia.

Zwraca

Promise<string[]>

deleteDefinition(string, number)

Usuwa definicję i wszystkie skojarzone kompilacje.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

Zwraca

Promise<void>

deleteDefinitionTag(string, number, string)

Usuwa tag z definicji. UWAGA: ten interfejs API nie będzie działać w przypadku tagów ze znakami specjalnymi. Aby usunąć tagi ze znakami specjalnymi, użyj metody PATCH zamiast (w wersji 6.0 lub nowszej)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

tag: string

Tag do usunięcia.

Zwraca

Promise<string[]>

deleteFolder(string, string)

Usuwa folder definicji. Definicje i odpowiadające im kompilacje również zostaną usunięte.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

path: string

Pełna ścieżka do folderu.

Zwraca

Promise<void>

deleteRetentionLeasesById(string, number[])

Usuwa określone dzierżawy przechowywania.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

ids: number[]

Zwraca

Promise<void>

deleteTag(string, string)

Usuwa tag z kompilacji, definicji i z magazynu tagów

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

tag: string

Tag do usunięcia.

Zwraca

Promise<string[]>

deleteTemplate(string, string)

Usuwa szablon definicji kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

templateId: string

Identyfikator szablonu.

Zwraca

Promise<void>

getArtifact(string, number, string)

Pobiera określony artefakt dla kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

artifactName: string

Nazwa artefaktu.

Zwraca

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Pobiera określony artefakt dla kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

artifactName: string

Nazwa artefaktu.

Zwraca

Promise<ArrayBuffer>

getArtifacts(string, number)

Pobiera wszystkie artefakty dla kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

Zwraca

Promise<BuildArtifact[]>

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

Pobiera określony załącznik.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

timelineId: string

Identyfikator osi czasu.

recordId: string

Identyfikator rekordu osi czasu.

type: string

Typ załącznika.

name: string

Nazwa załącznika.

Zwraca

Promise<ArrayBuffer>

getAttachments(string, number, string)

Pobiera listę załączników określonego typu, które są skojarzone z kompilacją.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

type: string

Typ załącznika.

Zwraca

Promise<Attachment[]>

getBadge(string, number, string)

Pobiera wskaźnik wskazujący stan najnowszej kompilacji dla definicji. Pamiętaj, że ten interfejs API jest przestarzały. Preferuj statusBadgeController.GetStatusBadge.

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

Parametry

project: string

Identyfikator lub nazwa projektu.

definitionId: number

Identyfikator definicji.

branchName: string

Nazwa gałęzi.

Zwraca

Promise<string>

getBuild(string, number, string)

Pobiera kompilację

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

propertyFilters: string

Zwraca

Promise<Build>

getBuildBadge(string, string, string, string)

Pobiera wskaźnik wskazujący stan najnowszej kompilacji dla określonej gałęzi.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repoType: string

Typ repozytorium.

repoId: string

Identyfikator repozytorium.

branchName: string

Nazwa gałęzi.

Zwraca

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Pobiera wskaźnik wskazujący stan najnowszej kompilacji dla określonej gałęzi.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

repoType: string

Typ repozytorium.

repoId: string

Identyfikator repozytorium.

branchName: string

Nazwa gałęzi.

Zwraca

Promise<string>

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

Pobiera zmiany skojarzone z kompilacją

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

continuationToken: string

top: number

Maksymalna liczba zmian do zwrócenia

includeSourceChange: boolean

Zwraca

Promise<PagedList<Change>>

getBuildController(number)

Pobiera kontroler

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

Parametry

controllerId: number

Zwraca

Promise<BuildController>

getBuildControllers(string)

Pobiera kontroler, opcjonalnie filtrowany według nazwy

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

Parametry

name: string

Zwraca

Promise<BuildController[]>

getBuildGeneralSettings(string)

Pobiera ustawienia ogólne potoku.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<PipelineGeneralSettings>

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

Pobiera pojedynczy plik dziennika dla kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

logId: number

Identyfikator pliku dziennika.

startLine: number

Wiersz początkowy.

endLine: number

Linia końcowa.

Zwraca

Promise<string>

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

Pobiera pojedynczy plik dziennika dla kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

logId: number

Identyfikator pliku dziennika.

startLine: number

Wiersz początkowy.

endLine: number

Linia końcowa.

Zwraca

Promise<string[]>

getBuildLogs(string, number)

Pobiera dzienniki dla kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

Zwraca

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Pobiera dzienniki dla kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

Zwraca

Promise<ArrayBuffer>

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

Pobiera pojedynczy plik dziennika dla kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

logId: number

Identyfikator pliku dziennika.

startLine: number

Wiersz początkowy.

endLine: number

Linia końcowa.

Zwraca

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Pobiera wszystkie opcje definicji kompilacji obsługiwane przez system.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Pobiera właściwości dla kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

filter: string[]

Rozdzielana przecinkami lista właściwości. Jeśli zostanie określony, filtruje do tych określonych właściwości.

Zwraca

Promise<any>

getBuildReport(string, number, string)

Pobiera raport kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

type: string

Zwraca

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Pobiera raport kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

type: string

Zwraca

Promise<any>

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

Pobiera listę kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitions: number[]

Rozdzielana przecinkami lista identyfikatorów definicji. Jeśli zostanie określony, filtruje kompilacje dla tych definicji.

queues: number[]

Rozdzielana przecinkami lista identyfikatorów kolejek. Jeśli zostanie określony, filtruje kompilacje, które były uruchamiane względem tych kolejek.

buildNumber: string

Jeśli zostanie określony, filtruje kompilacje zgodne z tym numerem kompilacji. Dołącz * w celu przeprowadzenia wyszukiwania prefiksu.

minTime: Date

Jeśli zostanie określony, filtruje kompilacje, które zostały ukończone/uruchomione/w kolejce po tej dacie na podstawie określonej wartości queryOrder.

maxTime: Date

Jeśli zostanie określony, filtruje kompilacje, które zostały ukończone/uruchomione/w kolejce przed tą datą na podstawie określonej wartości queryOrder.

requestedFor: string

Jeśli zostanie określony, filtruje kompilacje żądane dla określonego użytkownika.

reasonFilter: BuildReason

Jeśli zostanie określony, filtruje kompilacje zgodne z tą przyczyną.

statusFilter: BuildStatus

Jeśli zostanie określony, filtruje kompilacje zgodne z tym stanem.

resultFilter: BuildResult

Jeśli zostanie określony, filtruje kompilacje zgodne z tym wynikiem.

tagFilters: string[]

Rozdzielana przecinkami lista tagów. Jeśli zostanie określony, filtruje kompilacje z określonymi tagami.

properties: string[]

Rozdzielana przecinkami lista właściwości do pobrania.

top: number

Maksymalna liczba kompilacji do zwrócenia.

continuationToken: string

Token kontynuacji zwrócony przez poprzednie wywołanie tej metody, który może służyć do zwracania następnego zestawu kompilacji.

maxBuildsPerDefinition: number

Maksymalna liczba kompilacji do zwrócenia na definicję.

deletedFilter: QueryDeletedOption

Wskazuje, czy należy wykluczyć, dołączyć, czy tylko zwrócić usunięte kompilacje.

queryOrder: BuildQueryOrder

Kolejność zwracania kompilacji.

branchName: string

Jeśli zostanie określony, filtruje kompilacje, które skompilują gałęzie, które skompilują tę gałąź.

buildIds: number[]

Rozdzielana przecinkami lista określająca identyfikatory kompilacji do pobrania.

repositoryId: string

Jeśli zostanie określony, filtruje kompilacje utworzone na podstawie tego repozytorium.

repositoryType: string

Jeśli zostanie określony, filtruje kompilacje utworzone na podstawie repozytoriów tego typu.

Zwraca

Promise<PagedList<Build>>

getBuildSettings(string)

Pobiera ustawienia kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<BuildSettings>

getBuildTags(string, number)

Pobiera tagi dla kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

Zwraca

Promise<string[]>

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

Pobiera szczegóły kompilacji

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

timelineId: string

changeId: number

planId: string

Zwraca

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Pobiera elementy robocze skojarzone z kompilacją. Zwracane są tylko elementy robocze w tym samym projekcie.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

top: number

Maksymalna liczba elementów roboczych do zwrócenia.

Zwraca

Promise<ResourceRef[]>

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

Pobiera elementy robocze skojarzone z kompilacją, filtrowane do określonych zatwierdzeń.

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

Parametry

commitIds: string[]

Rozdzielana przecinkami lista identyfikatorów zatwierdzeń.

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

top: number

Maksymalna liczba elementów roboczych do zwrócenia lub liczba zatwierdzeń do rozważenia, jeśli nie określono identyfikatorów zatwierdzeń.

Zwraca

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Pobiera zmiany wprowadzone w repozytorium między dwiema podanymi kompilacjami.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

fromBuildId: number

Identyfikator pierwszej kompilacji.

toBuildId: number

Identyfikator ostatniej kompilacji.

top: number

Maksymalna liczba zmian do zwrócenia.

Zwraca

Promise<Change[]>

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

Pobiera definicję, opcjonalnie w określonej wersji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

revision: number

Numer poprawki do pobrania. Jeśli ta wartość nie zostanie określona, zostanie zwrócona najnowsza wersja.

minMetricsTime: Date

Jeśli zostanie określony, wskazuje datę, z której należy uwzględnić metryki.

propertyFilters: string[]

Rozdzielana przecinkami lista właściwości do uwzględnienia w wynikach.

includeLatestBuilds: boolean

Zwraca

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Pobiera metryki kompilacji dla definicji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

minMetricsTime: Date

Data, z której mają być obliczane metryki.

Zwraca

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Pobiera właściwości definicji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

filter: string[]

Rozdzielana przecinkami lista właściwości. Jeśli zostanie określony, filtruje do tych określonych właściwości.

Zwraca

Promise<any>

getDefinitionResources(string, number)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Zwraca

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Pobiera wszystkie poprawki definicji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

Zwraca

Promise<BuildDefinitionRevision[]>

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

Pobiera listę definicji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

name: string

Jeśli zostanie określony, filtruje definicje, których nazwy są zgodne z tym wzorcem.

repositoryId: string

Identyfikator repozytorium. Jeśli zostanie określony, filtruje definicje korzystające z tego repozytorium.

repositoryType: string

Jeśli zostanie określony, filtruje definicje, które mają repozytorium tego typu.

queryOrder: DefinitionQueryOrder

Wskazuje kolejność zwracania definicji.

top: number

Maksymalna liczba definicji do zwrócenia.

continuationToken: string

Token kontynuacji zwrócony przez poprzednie wywołanie tej metody, którego można użyć do zwrócenia następnego zestawu definicji.

minMetricsTime: Date

Jeśli zostanie określony, wskazuje datę, z której należy uwzględnić metryki.

definitionIds: number[]

Rozdzielana przecinkami lista określająca identyfikatory definicji do pobrania.

path: string

Jeśli zostanie określony, filtruje definicje w tym folderze.

builtAfter: Date

Jeśli zostanie określony, filtruje definicje, które mają kompilacje po tej dacie.

notBuiltAfter: Date

Jeśli zostanie określony, filtruje definicje, które nie mają kompilacji po tej dacie.

includeAllProperties: boolean

Wskazuje, czy powinny zostać zwrócone pełne definicje. Domyślnie zwracane są płytkie reprezentacje definicji.

includeLatestBuilds: boolean

Wskazuje, czy mają być zwracane najnowsze i najnowsze ukończone kompilacje dla tej definicji.

taskIdFilter: string

Jeśli zostanie określony, filtruje definicje, które używają określonego zadania.

processType: number

Jeśli zostanie określony, filtruje definicje z danym typem procesu.

yamlFilename: string

Jeśli zostanie określony, filtruje definicje YAML zgodne z daną nazwą pliku. Aby użyć tego filtru, należy ustawić właściwośćAllProperties na true

Zwraca

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Pobiera tagi dla definicji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

revision: number

Numer poprawki definicji. Jeśli nie zostanie określony, użyj najnowszej poprawki definicji.

Zwraca

Promise<string[]>

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

Konwertuje definicję na YAML, opcjonalnie w określonej wersji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

revision: number

Numer poprawki do pobrania. Jeśli ta wartość nie zostanie określona, zostanie zwrócona najnowsza wersja.

minMetricsTime: Date

Jeśli zostanie określony, wskazuje datę, z której należy uwzględnić metryki.

propertyFilters: string[]

Rozdzielana przecinkami lista właściwości do uwzględnienia w wynikach.

includeLatestBuilds: boolean

Zwraca

Promise<YamlBuild>

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

Pobiera plik z kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

artifactName: string

Nazwa artefaktu.

fileId: string

Klucz podstawowy pliku.

fileName: string

Nazwa, na którą zostanie ustawiony plik.

Zwraca

Promise<ArrayBuffer>

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

Pobiera zawartość pliku w danym repozytorium kodu źródłowego.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

providerName: string

Nazwa dostawcy źródłowego.

serviceEndpointId: string

Jeśli zostanie określony, identyfikator punktu końcowego usługi do odpytowania. Można pominąć tylko dla dostawców, którzy nie korzystają z punktów końcowych usługi, np. TFVC lub TFGit.

repository: string

Jeśli zostanie określony, identyfikator specyficzny dla dostawcy lub nazwa repozytorium do pobrania gałęzi. Można pominąć tylko dla dostawców, którzy nie obsługują wielu repozytoriów.

commitOrBranch: string

Identyfikator zatwierdzenia lub gałęzi, z której pobierana jest zawartość pliku.

path: string

Ścieżka do pliku do pobrania względem katalogu głównego repozytorium.

Zwraca

Promise<string>

getFolders(string, string, FolderQueryOrder)

Pobiera listę folderów definicji kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

path: string

Ścieżka do rozpoczęcia.

queryOrder: FolderQueryOrder

Kolejność zwracania folderów.

Zwraca

Promise<Folder[]>

getLatestBuild(string, string, string)

Pobiera najnowszą kompilację dla definicji, opcjonalnie ograniczone do określonej gałęzi.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definition: string

nazwa definicji z opcjonalną ścieżką folderu wiodącego lub identyfikatorem definicji

branchName: string

opcjonalny parametr wskazujący konkretną gałąź do użycia. Jeśli nie zostanie określona, zostanie użyta gałąź domyślna.

Zwraca

Promise<Build>

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

Pobiera zawartość katalogu w danym repozytorium kodu źródłowego.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

providerName: string

Nazwa dostawcy źródłowego.

serviceEndpointId: string

Jeśli zostanie określony, identyfikator punktu końcowego usługi do odpytowania. Można pominąć tylko dla dostawców, którzy nie korzystają z punktów końcowych usługi, np. TFVC lub TFGit.

repository: string

Jeśli zostanie określony, identyfikator specyficzny dla dostawcy lub nazwa repozytorium do pobrania gałęzi. Można pominąć tylko dla dostawców, którzy nie obsługują wielu repozytoriów.

commitOrBranch: string

Identyfikator zatwierdzenia lub gałęzi, z której pobierana jest zawartość pliku.

path: string

Zawartość ścieżki do listy względem katalogu głównego repozytorium.

Zwraca

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Pobiera metryki kompilacji dla projektu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

metricAggregationType: string

Typ agregacji do użycia (co godzinę, codziennie).

minMetricsTime: Date

Data, z której mają być obliczane metryki.

Zwraca

Promise<BuildMetric[]>

getProjectResources(string, string, string)

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

type: string

id: string

Zwraca

Promise<DefinitionResourceReference[]>

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

Pobiera obiekt żądania ściągnięcia od dostawcy źródłowego.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

providerName: string

Nazwa dostawcy źródłowego.

pullRequestId: string

Identyfikator specyficzny dla dostawcy żądania ściągnięcia.

repositoryId: string

Identyfikator specyficzny dla dostawcy lub nazwa repozytorium zawierającego żądanie ściągnięcia.

serviceEndpointId: string

Jeśli zostanie określony, identyfikator punktu końcowego usługi do wykonywania zapytania. Można pominąć tylko dla dostawców, którzy nie używają punktów końcowych usługi, np. TFVC lub TFGit.

Zwraca

Promise<PullRequest>

getResourceUsage()

Pobiera informacje o zasobach kompilacji w systemie.

function getResourceUsage(): Promise<BuildResourceUsage>

Zwraca

Promise<BuildResourceUsage>

getRetentionHistory(number)

Zwraca historię przechowywania kolekcji projektów. Obejmuje to potoki z niestandardowymi regułami przechowywania, które mogą uniemożliwić czyszczenie zadania przechowywania, uruchomienia na potok z typem przechowywania, plikami skojarzonymi z potokami należącymi do kolekcji z typem przechowywania oraz liczbą plików na potok.

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

Parametry

daysToLookback: number

Zwraca

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Zwraca szczegóły dzierżawy przechowywania podanego identyfikatora dzierżawy.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

leaseId: number

Zwraca

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Zwraca wszystkie dzierżawy zgodne z określoną wartością MinimalRetentionLeases

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

leasesToFetch: MinimalRetentionLease[]

Lista serializacji JSON MinimalRetentionLeases rozdzielona przez '|'

Zwraca

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Zwraca wszystkie dzierżawy należące do określonej jednostki, opcjonalnie ograniczone do pojedynczej definicji i uruchomienia potoku.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

ownerId: string

definitionId: number

Opcjonalny parametr ograniczający wyszukiwanie do określonej definicji potoku.

runId: number

Opcjonalny parametr ograniczający wyszukiwanie do pojedynczego uruchomienia potoku. Wymaga identyfikatora definitionId.

Zwraca

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Zwraca wszystkie dzierżawy należące do określonego użytkownika, opcjonalnie ograniczone do jednej definicji i uruchomienia potoku.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

userOwnerId: string

Identyfikator użytkownika do wyszukania.

definitionId: number

Opcjonalny parametr ograniczający wyszukiwanie do określonej definicji potoku.

runId: number

Opcjonalny parametr ograniczający wyszukiwanie do pojedynczego uruchomienia potoku. Wymaga identyfikatora definitionId.

Zwraca

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Pobiera wszystkie dzierżawy przechowywania, które mają zastosowanie do określonej kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

Zwraca

Promise<RetentionLease[]>

getRetentionSettings(string)

Pobiera ustawienia przechowywania projektu.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ProjectRetentionSetting>

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

<p>Pobiera stan kompilacji definicji, opcjonalnie o określonym zakresie dla określonej gałęzi, etapu, zadania i konfiguracji.< /p Jeśli><>istnieje więcej niż jeden, wymagane jest przekazanie wartości stageName podczas określania nazwy zadania, a ta sama reguła ma zastosowanie zarówno w przypadku przekazania parametru konfiguracji.< /P>

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definition: string

Nazwa definicji z opcjonalną ścieżką folderu wiodącego lub identyfikatorem definicji.

branchName: string

Należy wziąć pod uwagę tylko najnowszą kompilację dla tej gałęzi. Jeśli nie zostanie określona, zostanie użyta gałąź domyślna.

stageName: string

Użyj tego etapu w potoku, aby renderować stan.

jobName: string

Użyj tego zadania na etapie potoku, aby renderować stan.

configuration: string

Użyj tej konfiguracji zadania, aby renderować stan

label: string

Zastępuje domyślny tekst po lewej stronie wskaźnika.

Zwraca

Promise<string>

getTags(string)

Pobiera listę wszystkich tagów kompilacji w projekcie.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<string[]>

getTemplate(string, string)

Pobiera określony szablon definicji kompilacji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

templateId: string

Identyfikator żądanego szablonu.

Zwraca

Promise<BuildDefinitionTemplate>

getTemplates(string)

Pobiera wszystkie szablony definicji.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Pobiera wszystkie elementy robocze między dwiema kompilacjami.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

fromBuildId: number

Identyfikator pierwszej kompilacji.

toBuildId: number

Identyfikator ostatniej kompilacji.

top: number

Maksymalna liczba elementów roboczych do zwrócenia.

Zwraca

Promise<ResourceRef[]>

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

Pobiera listę gałęzi dla danego repozytorium kodu źródłowego.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

providerName: string

Nazwa dostawcy źródłowego.

serviceEndpointId: string

repository: string

Identyfikator specyficzny dla dostawcy lub nazwa repozytorium do pobrania gałęzi. Można pominąć tylko dla dostawców, którzy nie obsługują wielu repozytoriów.

branchName: string

Jeśli zostanie podana, nazwa gałęzi, która ma być sprawdzana specjalnie.

Zwraca

Promise<string[]>

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

Pobiera listę repozytoriów kodu źródłowego.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

providerName: string

Nazwa dostawcy źródłowego.

serviceEndpointId: string

repository: string

Jeśli zostanie określony, identyfikator specyficzny dla dostawcy lub nazwa pojedynczego repozytorium do pobrania.

resultSet: ResultSet

"top" dla repozytoriów najbardziej odpowiednich dla punktu końcowego. Jeśli nie zostanie ustawiona, zostaną zwrócone wszystkie repozytoria. Ignorowane, jeśli ustawiono opcję "repozytorium".

pageResults: boolean

Jeśli ustawiono wartość true, spowoduje to ograniczenie zestawu wyników i zwróci token kontynuacji, aby kontynuować zapytanie.

continuationToken: string

Podczas stronicowania wyników jest to token kontynuacji zwrócony przez poprzednie wywołanie tej metody, którego można użyć do zwrócenia następnego zestawu repozytoriów.

Zwraca

Promise<SourceRepositories>

listSourceProviders(string)

Pobierz listę dostawców źródłowych i ich możliwości.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Pobiera listę elementów webhook zainstalowanych w danym repozytorium kodu źródłowego.

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

providerName: string

Nazwa dostawcy źródłowego.

serviceEndpointId: string

repository: string

Jeśli zostanie określony, identyfikator specyficzny dla dostawcy lub nazwa repozytorium, aby pobrać elementy webhook. Można pominąć tylko dla dostawców, którzy nie obsługują wielu repozytoriów.

Zwraca

Promise<RepositoryWebhook[]>

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

Kolejkuje kompilację

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

Parametry

build: Build

project: string

Identyfikator projektu lub nazwa projektu

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

Opcjonalny identyfikator definicji do kolejkowania kompilacji bez treści. Ignorowane, jeśli istnieje prawidłowa treść

Zwraca

Promise<Build>

restoreDefinition(string, number, boolean)

Przywraca usuniętą definicję

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

Parametry

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji do przywrócenia.

deleted: boolean

W przypadku wartości false przywraca usuniętą definicję.

Zwraca

Promise<BuildDefinition>

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

Ponownie utworzy elementy webhook dla określonych wyzwalaczy w danym repozytorium kodu źródłowego.

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

Parametry

triggerTypes: DefinitionTriggerType[]

Typy wyzwalaczy do przywracania elementów webhook dla.

project: string

Identyfikator projektu lub nazwa projektu

providerName: string

Nazwa dostawcy źródłowego.

serviceEndpointId: string

repository: string

Zwraca

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Aktualizacje istniejącego szablonu definicji kompilacji.

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

Parametry

template: BuildDefinitionTemplate

Nowa wersja szablonu.

project: string

Identyfikator projektu lub nazwa projektu

templateId: string

Identyfikator szablonu.

Zwraca

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Aktualizacje kompilacji.

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

Parametry

build: Build

Kompilacja.

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

retry: boolean

Zwraca

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Aktualizacje ustawienia ogólne potoku.

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

Parametry

newSettings: PipelineGeneralSettings

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Aktualizacje właściwości kompilacji.

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

Parametry

document: JsonPatchDocument

Dokument json-patch opisujący właściwości do zaktualizowania.

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

Zwraca

Promise<any>

updateBuilds(Build[], string)

Aktualizacje wielu kompilacji.

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

Parametry

builds: Build[]

Kompilacje do aktualizacji.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Aktualizacje ustawień kompilacji.

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

Parametry

settings: BuildSettings

Nowe ustawienia.

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Dodaje/usuwa tagi z kompilacji.

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

Parametry

updateParameters: UpdateTagParameters

Tagi do dodania/usunięcia.

project: string

Identyfikator projektu lub nazwa projektu

buildId: number

Identyfikator kompilacji.

Zwraca

Promise<string[]>

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

Aktualizacje istniejącej definicji kompilacji. Aby operacja powiodła się, wartość właściwości "Revision" treści żądania musi być zgodna z definicją istniejącej kompilacji. Zaleca się uzyskanie istniejącej definicji kompilacji przy użyciu polecenia GET, zmodyfikowanie definicji kompilacji w razie potrzeby, a następnie przesłanie zmodyfikowanej definicji za pomocą polecenia PUT.

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

Parametry

definition: BuildDefinition

Nowa wersja definicji. Jej właściwość "Revision" musi być zgodna z istniejącą definicją, aby aktualizacja została zaakceptowana.

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Zwraca

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Aktualizacje właściwości definicji.

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

Parametry

document: JsonPatchDocument

Dokument json-patch opisujący właściwości do zaktualizowania.

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

Zwraca

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Dodaje/usuwa tagi z definicji.

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

Parametry

updateParameters: UpdateTagParameters

Tagi do dodania/usunięcia.

project: string

Identyfikator projektu lub nazwa projektu

definitionId: number

Identyfikator definicji.

Zwraca

Promise<string[]>

updateFolder(Folder, string, string)

Aktualizacje istniejącego folderu pod daną istniejącą ścieżką

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

Parametry

folder: Folder

Nowa wersja folderu.

project: string

Identyfikator projektu lub nazwa projektu

path: string

Pełna ścieżka do folderu.

Zwraca

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Aktualizacje czas trwania lub stan ochrony potoku dzierżawy przechowywania.

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

Parametry

leaseUpdate: RetentionLeaseUpdate

Nowe dane dotyczące dzierżawy przechowywania.

project: string

Identyfikator projektu lub nazwa projektu

leaseId: number

Identyfikator dzierżawy do zaktualizowania.

Zwraca

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Aktualizacje ustawień przechowywania projektu.

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

Parametry

updateModel: UpdateProjectRetentionSettingModel

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Aktualizowanie etapu kompilacji

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

Parametry

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

Udostępnij za pośrednictwem

BuildRestClient class

Konstruktory

Właściwości

Metody

Szczegóły konstruktora

BuildRestClient(IVssRestClientOptions)

Parametry

Szczegóły właściwości

RESOURCE_AREA_ID

Wartość właściwości

Szczegóły metody

addBuildTag(string, number, string)

Parametry

Zwraca

addBuildTags(string[], string, number)

Parametry

Zwraca

addDefinitionTag(string, number, string)

Parametry

Zwraca

addDefinitionTags(string[], string, number)

Parametry

Zwraca

addRetentionLeases(NewRetentionLease[], string)

Parametry

Zwraca

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parametry

Zwraca

authorizeProjectResources(DefinitionResourceReference[], string)

Parametry

Zwraca

createArtifact(BuildArtifact, string, number)

Parametry

Zwraca

createDefinition(BuildDefinition, string, number, number)

Parametry

Zwraca

createFolder(Folder, string, string)

Parametry

Zwraca

deleteBuild(string, number)

Parametry

Zwraca

deleteBuildTag(string, number, string)

Parametry

Zwraca

deleteDefinition(string, number)

Parametry

Zwraca

deleteDefinitionTag(string, number, string)

Parametry

Zwraca

deleteFolder(string, string)

Parametry

Zwraca

deleteRetentionLeasesById(string, number[])

Parametry

Zwraca

deleteTag(string, string)

Parametry

Zwraca

deleteTemplate(string, string)

Parametry

Zwraca

getArtifact(string, number, string)

Parametry

Zwraca

getArtifactContentZip(string, number, string)

Parametry

Zwraca

getArtifacts(string, number)

Parametry

Zwraca

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

Parametry

Zwraca

getAttachments(string, number, string)

Parametry