BuildRestClient class

Paket:: azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas: RestClientBase

Konstruktor

Properti

Metode

addBuildTag(string, number, string)	Menambahkan tag ke build.
addBuildTags(string[], string, number)	Menambahkan tag ke build.
addDefinitionTag(string, number, string)	Menambahkan tag ke definisi
addDefinitionTags(string[], string, number)	Menambahkan beberapa tag ke definisi.
addRetentionLeases(NewRetentionLease[], string)	Menambahkan sewa baru untuk eksekusi alur.
authorizeDefinitionResources(DefinitionResourceReference[], string, number)
authorizeProjectResources(DefinitionResourceReference[], string)
createArtifact(BuildArtifact, string, number)	Mengaitkan artefak dengan build.
createDefinition(BuildDefinition, string, number, number)	Membuat definisi baru.
createFolder(Folder, string, string)	Membuat folder baru.
deleteBuild(string, number)	Menghapus build.
deleteBuildTag(string, number, string)	Menghapus tag dari build. CATATAN: API ini tidak akan berfungsi untuk tag dengan karakter khusus. Untuk menghapus tag dengan karakter khusus, gunakan metode PATCH sebagai gantinya (dalam 6.0+)
deleteDefinition(string, number)	Menghapus definisi dan semua build terkait.
deleteDefinitionTag(string, number, string)	Menghapus tag dari definisi. CATATAN: API ini tidak akan berfungsi untuk tag dengan karakter khusus. Untuk menghapus tag dengan karakter khusus, gunakan metode PATCH sebagai gantinya (dalam 6.0+)
deleteFolder(string, string)	Menghapus folder definisi. Definisi dan build yang sesuai juga akan dihapus.
deleteRetentionLeasesById(string, number[])	Menghapus sewa retensi tertentu.
deleteTag(string, string)	Menghapus tag dari build, definisi, dan dari penyimpanan tag
deleteTemplate(string, string)	Menghapus templat definisi build.
getArtifact(string, number, string)	Mendapatkan artefak tertentu untuk build.
getArtifactContentZip(string, number, string)	Mendapatkan artefak tertentu untuk build.
getArtifacts(string, number)	Mendapatkan semua artefak untuk build.
getAttachment(string, number, string, string, string, string)	Mendapatkan lampiran tertentu.
getAttachments(string, number, string)	Mendapatkan daftar lampiran dari jenis tertentu yang terkait dengan build.
getBadge(string, number, string)	Mendapatkan lencana yang menunjukkan status build terbaru untuk definisi. Perhatikan bahwa API ini tidak digunakan lagi. Lebih suka StatusBadgeController.GetStatusBadge.
getBuild(string, number, string)	Mendapatkan build
getBuildBadge(string, string, string, string)	Mendapatkan lencana yang menunjukkan status build terbaru untuk cabang yang ditentukan.
getBuildBadgeData(string, string, string, string)	Mendapatkan lencana yang menunjukkan status build terbaru untuk cabang yang ditentukan.
getBuildChanges(string, number, string, number, boolean)	Mendapatkan perubahan yang terkait dengan build
getBuildController(number)	Mendapatkan pengontrol
getBuildControllers(string)	Mendapatkan pengontrol, secara opsional difilter menurut nama
getBuildGeneralSettings(string)	Mendapatkan pengaturan umum alur.
getBuildLog(string, number, number, number, number)	Mendapatkan file log individual untuk build.
getBuildLogLines(string, number, number, number, number)	Mendapatkan file log individual untuk build.
getBuildLogs(string, number)	Mendapatkan log untuk build.
getBuildLogsZip(string, number)	Mendapatkan log untuk build.
getBuildLogZip(string, number, number, number, number)	Mendapatkan file log individual untuk build.
getBuildOptionDefinitions(string)	Mendapatkan semua opsi definisi build yang didukung oleh sistem.
getBuildProperties(string, number, string[])	Mendapatkan properti untuk build.
getBuildReport(string, number, string)	Mendapatkan laporan build.
getBuildReportHtmlContent(string, number, string)	Mendapatkan laporan build.
getBuilds(string, number[], number[], string, Date, Date, string, BuildReason, BuildStatus, BuildResult, string[], string[], number, string, number, QueryDeletedOption, BuildQueryOrder, string, number[], string, string)	Mendapatkan daftar build.
getBuildSettings(string)	Mendapatkan pengaturan build.
getBuildTags(string, number)	Mendapatkan tag untuk build.
getBuildTimeline(string, number, string, number, string)	Mendapatkan detail untuk build
getBuildWorkItemsRefs(string, number, number)	Mendapatkan item kerja yang terkait dengan build. Hanya item kerja dalam proyek yang sama yang dikembalikan.
getBuildWorkItemsRefsFromCommits(string[], string, number, number)	Mendapatkan item kerja yang terkait dengan build, difilter ke penerapan tertentu.
getChangesBetweenBuilds(string, number, number, number)	Mendapatkan perubahan yang dilakukan pada repositori antara dua build yang diberikan.
getDefinition(string, number, number, Date, string[], boolean)	Mendapatkan definisi, secara opsional pada revisi tertentu.
getDefinitionMetrics(string, number, Date)	Mendapatkan metrik build untuk definisi.
getDefinitionProperties(string, number, string[])	Mendapatkan properti untuk definisi.
getDefinitionResources(string, number)
getDefinitionRevisions(string, number)	Mendapatkan semua revisi definisi.
getDefinitions(string, string, string, string, DefinitionQueryOrder, number, string, Date, number[], string, Date, Date, boolean, boolean, string, number, string)	Mendapatkan daftar definisi.
getDefinitionTags(string, number, number)	Mendapatkan tag untuk definisi.
getDefinitionYaml(string, number, number, Date, string[], boolean)	Mengonversi definisi ke YAML, secara opsional pada revisi tertentu.
getFile(string, number, string, string, string)	Mendapatkan file dari build.
getFileContents(string, string, string, string, string, string)	Mendapatkan konten file di repositori kode sumber yang diberikan.
getFolders(string, string, FolderQueryOrder)	Mendapatkan daftar folder definisi build.
getLatestBuild(string, string, string)	Mendapatkan build terbaru untuk definisi, secara opsional dicakup ke cabang tertentu.
getPathContents(string, string, string, string, string, string)	Mendapatkan konten direktori di repositori kode sumber tertentu.
getProjectMetrics(string, string, Date)	Mendapatkan metrik build untuk proyek.
getProjectResources(string, string, string)
getPullRequest(string, string, string, string, string)	Mendapatkan objek permintaan pull dari penyedia sumber.
getResourceUsage()	Mendapatkan informasi tentang sumber daya build dalam sistem.
getRetentionHistory(number)	Mengembalikan riwayat retensi untuk kumpulan proyek. Ini termasuk alur yang memiliki aturan retensi kustom yang dapat mencegah pekerjaan retensi membersihkannya, menjalankan per alur dengan jenis retensi, file yang terkait dengan alur yang dimiliki oleh koleksi dengan jenis retensi, dan jumlah file per alur.
getRetentionLease(string, number)	Mengembalikan detail sewa retensi yang diberikan id sewa.
getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])	Mengembalikan sewa apa pun yang cocok dengan MinimalRetentionLeases yang ditentukan
getRetentionLeasesByOwnerId(string, string, number, number)	Mengembalikan sewa apa pun yang dimiliki oleh entitas yang ditentukan, secara opsional dilingkup ke definisi alur tunggal dan dijalankan.
getRetentionLeasesByUserId(string, string, number, number)	Mengembalikan sewa apa pun yang dimiliki oleh pengguna yang ditentukan, secara opsional dilingkup ke definisi alur tunggal dan dijalankan.
getRetentionLeasesForBuild(string, number)	Mendapatkan semua sewa retensi yang berlaku untuk build tertentu.
getRetentionSettings(string)	Mendapatkan pengaturan retensi proyek.
getStatusBadge(string, string, string, string, string, string, string)	<p>Mendapatkan status build untuk definisi, secara opsional dicakup ke cabang, tahap, pekerjaan, dan konfigurasi tertentu.</p><p>Jika ada lebih dari satu, maka diperlukan untuk meneruskan nilai stageName saat menentukan jobName, dan aturan yang sama kemudian berlaku untuk keduanya jika melewati parameter konfigurasi.</p>
getTags(string)	Mendapatkan daftar semua tag build dalam proyek.
getTemplate(string, string)	Mendapatkan templat definisi build tertentu.
getTemplates(string)	Mendapatkan semua templat definisi.
getWorkItemsBetweenBuilds(string, number, number, number)	Mendapatkan semua item kerja di antara dua build.
listBranches(string, string, string, string, string)	Mendapatkan daftar cabang untuk repositori kode sumber yang diberikan.
listRepositories(string, string, string, string, ResultSet, boolean, string)	Mendapatkan daftar repositori kode sumber.
listSourceProviders(string)	Dapatkan daftar penyedia sumber dan kemampuannya.
listWebhooks(string, string, string, string)	Mendapatkan daftar webhook yang diinstal di repositori kode sumber tertentu.
queueBuild(Build, string, boolean, string, number, number)	Mengantrekan build
restoreDefinition(string, number, boolean)	Memulihkan definisi yang dihapus
restoreWebhooks(DefinitionTriggerType[], string, string, string, string)	Membuat ulang webhook untuk pemicu yang ditentukan dalam repositori kode sumber yang diberikan.
saveTemplate(BuildDefinitionTemplate, string, string)	Memperbarui templat definisi build yang ada.
updateBuild(Build, string, number, boolean)	Memperbarui build.
updateBuildGeneralSettings(PipelineGeneralSettings, string)	Memperbarui pengaturan umum alur.
updateBuildProperties(JsonPatchDocument, string, number)	Memperbarui properti untuk build.
updateBuilds(Build[], string)	Memperbarui beberapa build.
updateBuildSettings(BuildSettings, string)	Memperbarui pengaturan build.
updateBuildTags(UpdateTagParameters, string, number)	Menambahkan/Menghapus tag dari build.
updateDefinition(BuildDefinition, string, number, number, number)	Memperbarui definisi build yang ada. Agar operasi ini berhasil, nilai properti "Revisi" dari isi permintaan harus cocok dengan definisi build yang ada. Disarankan agar Anda mendapatkan definisi build yang ada dengan menggunakan GET, memodifikasi definisi build seperlunya, lalu mengirimkan definisi yang dimodifikasi dengan PUT.
updateDefinitionProperties(JsonPatchDocument, string, number)	Memperbarui properti untuk definisi.
updateDefinitionTags(UpdateTagParameters, string, number)	Menambahkan/Menghapus tag dari definisi.
updateFolder(Folder, string, string)	Memperbarui folder yang ada pada jalur yang ada
updateRetentionLease(RetentionLeaseUpdate, string, number)	Memperbarui status perlindungan durasi atau alur dari sewa retensi.
updateRetentionSettings(UpdateProjectRetentionSettingModel, string)	Memperbarui pengaturan retensi proyek.
updateStage(UpdateStageParameters, number, string, string)	Memperbarui tahap build

Detail Konstruktor

BuildRestClient(IVssRestClientOptions)

new BuildRestClient(options: IVssRestClientOptions)

Parameter

options: IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

addBuildTag(string, number, string)

Menambahkan tag ke build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

tag: string

Tag yang akan ditambahkan.

Mengembalikan

Promise<string[]>

addBuildTags(string[], string, number)

Menambahkan tag ke build.

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

Parameter

tags: string[]

Tag yang akan ditambahkan. Isi permintaan terdiri langsung dari tag yang tercantum.

project: string

ID proyek atau nama proyek

buildId: number

ID build.

Mengembalikan

Promise<string[]>

addDefinitionTag(string, number, string)

Menambahkan tag ke definisi

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

Parameter

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

tag: string

Tag yang akan ditambahkan.

Mengembalikan

Promise<string[]>

addDefinitionTags(string[], string, number)

Menambahkan beberapa tag ke definisi.

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

Parameter

tags: string[]

Tag yang akan ditambahkan.

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

Mengembalikan

Promise<string[]>

addRetentionLeases(NewRetentionLease[], string)

Menambahkan sewa baru untuk eksekusi alur.

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

Parameter

newLeases: NewRetentionLease[]

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<RetentionLease[]>

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

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

Parameter

resources: DefinitionResourceReference[]

project: string

ID proyek atau nama proyek

definitionId: number

Mengembalikan

Promise<DefinitionResourceReference[]>

authorizeProjectResources(DefinitionResourceReference[], string)

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

Parameter

resources: DefinitionResourceReference[]

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<DefinitionResourceReference[]>

createArtifact(BuildArtifact, string, number)

Mengaitkan artefak dengan build.

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

Parameter

artifact: BuildArtifact

Artefaknya.

project: string

ID proyek atau nama proyek

buildId: number

ID build.

Mengembalikan

Promise<BuildArtifact>

createDefinition(BuildDefinition, string, number, number)

Membuat definisi baru.

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

Parameter

definition: BuildDefinition

Definisinya.

project: string

ID proyek atau nama proyek

definitionToCloneId: number

definitionToCloneRevision: number

Mengembalikan

Promise<BuildDefinition>

createFolder(Folder, string, string)

Membuat folder baru.

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

Parameter

folder: Folder

Folder .

project: string

ID proyek atau nama proyek

path: string

Jalur lengkap folder.

Mengembalikan

Promise<Folder>

deleteBuild(string, number)

Menghapus build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

Mengembalikan

Promise<void>

deleteBuildTag(string, number, string)

Menghapus tag dari build. CATATAN: API ini tidak akan berfungsi untuk tag dengan karakter khusus. Untuk menghapus tag dengan karakter khusus, gunakan metode PATCH sebagai gantinya (dalam 6.0+)

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

tag: string

Tag yang akan dihapus.

Mengembalikan

Promise<string[]>

deleteDefinition(string, number)

Menghapus definisi dan semua build terkait.

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

Parameter

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

Mengembalikan

Promise<void>

deleteDefinitionTag(string, number, string)

Menghapus tag dari definisi. CATATAN: API ini tidak akan berfungsi untuk tag dengan karakter khusus. Untuk menghapus tag dengan karakter khusus, gunakan metode PATCH sebagai gantinya (dalam 6.0+)

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

Parameter

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

tag: string

Tag yang akan dihapus.

Mengembalikan

Promise<string[]>

deleteFolder(string, string)

Menghapus folder definisi. Definisi dan build yang sesuai juga akan dihapus.

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

Parameter

project: string

ID proyek atau nama proyek

path: string

Jalur lengkap ke folder.

Mengembalikan

Promise<void>

deleteRetentionLeasesById(string, number[])

Menghapus sewa retensi tertentu.

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

Parameter

project: string

ID proyek atau nama proyek

ids: number[]

Mengembalikan

Promise<void>

deleteTag(string, string)

Menghapus tag dari build, definisi, dan dari penyimpanan tag

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

Parameter

project: string

ID proyek atau nama proyek

tag: string

Tag yang akan dihapus.

Mengembalikan

Promise<string[]>

deleteTemplate(string, string)

Menghapus templat definisi build.

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

Parameter

project: string

ID proyek atau nama proyek

templateId: string

ID templat.

Mengembalikan

Promise<void>

getArtifact(string, number, string)

Mendapatkan artefak tertentu untuk build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

artifactName: string

Nama artefak.

Mengembalikan

Promise<BuildArtifact>

getArtifactContentZip(string, number, string)

Mendapatkan artefak tertentu untuk build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

artifactName: string

Nama artefak.

Mengembalikan

Promise<ArrayBuffer>

getArtifacts(string, number)

Mendapatkan semua artefak untuk build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

Mengembalikan

Promise<BuildArtifact[]>

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

Mendapatkan lampiran tertentu.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

timelineId: string

ID garis waktu.

recordId: string

ID rekaman garis waktu.

type: string

Jenis lampiran.

name: string

Nama lampiran.

Mengembalikan

Promise<ArrayBuffer>

getAttachments(string, number, string)

Mendapatkan daftar lampiran dari jenis tertentu yang terkait dengan build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

type: string

Jenis lampiran.

Mengembalikan

Promise<Attachment[]>

getBadge(string, number, string)

Mendapatkan lencana yang menunjukkan status build terbaru untuk definisi. Perhatikan bahwa API ini tidak digunakan lagi. Lebih suka StatusBadgeController.GetStatusBadge.

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

Parameter

project: string

ID atau nama proyek.

definitionId: number

ID definisi.

branchName: string

Nama cabang.

Mengembalikan

Promise<string>

getBuild(string, number, string)

Mendapatkan build

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

propertyFilters: string

Mengembalikan

Promise<Build>

getBuildBadge(string, string, string, string)

Mendapatkan lencana yang menunjukkan status build terbaru untuk cabang yang ditentukan.

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

Parameter

project: string

ID proyek atau nama proyek

repoType: string

Jenis repositori.

repoId: string

ID repositori.

branchName: string

Nama cabang.

Mengembalikan

Promise<BuildBadge>

getBuildBadgeData(string, string, string, string)

Mendapatkan lencana yang menunjukkan status build terbaru untuk cabang yang ditentukan.

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

Parameter

project: string

ID proyek atau nama proyek

repoType: string

Jenis repositori.

repoId: string

ID repositori.

branchName: string

Nama cabang.

Mengembalikan

Promise<string>

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

Mendapatkan perubahan yang terkait dengan build

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

continuationToken: string

top: number

Jumlah maksimum perubahan yang akan dikembalikan

includeSourceChange: boolean

Mengembalikan

Promise<PagedList<Change>>

getBuildController(number)

Mendapatkan pengontrol

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

Parameter

controllerId: number

Mengembalikan

Promise<BuildController>

getBuildControllers(string)

Mendapatkan pengontrol, secara opsional difilter menurut nama

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

Parameter

name: string

Mengembalikan

Promise<BuildController[]>

getBuildGeneralSettings(string)

Mendapatkan pengaturan umum alur.

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<PipelineGeneralSettings>

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

Mendapatkan file log individual untuk build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

logId: number

ID file log.

startLine: number

Garis mulai.

endLine: number

Garis akhir.

Mengembalikan

Promise<string>

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

Mendapatkan file log individual untuk build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

logId: number

ID file log.

startLine: number

Garis mulai.

endLine: number

Garis akhir.

Mengembalikan

Promise<string[]>

getBuildLogs(string, number)

Mendapatkan log untuk build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

Mengembalikan

Promise<BuildLog[]>

getBuildLogsZip(string, number)

Mendapatkan log untuk build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

Mengembalikan

Promise<ArrayBuffer>

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

Mendapatkan file log individual untuk build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

logId: number

ID file log.

startLine: number

Garis mulai.

endLine: number

Garis akhir.

Mengembalikan

Promise<ArrayBuffer>

getBuildOptionDefinitions(string)

Mendapatkan semua opsi definisi build yang didukung oleh sistem.

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<BuildOptionDefinition[]>

getBuildProperties(string, number, string[])

Mendapatkan properti untuk build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

filter: string[]

Daftar properti yang dibatasi koma. Jika ditentukan, filter ke properti tertentu ini.

Mengembalikan

Promise<any>

getBuildReport(string, number, string)

Mendapatkan laporan build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

type: string

Mengembalikan

Promise<BuildReportMetadata>

getBuildReportHtmlContent(string, number, string)

Mendapatkan laporan build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

type: string

Mengembalikan

Promise<any>

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

Mendapatkan daftar build.

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

ID proyek atau nama proyek

definitions: number[]

Daftar ID definisi yang dibatasi koma. Jika ditentukan, filter untuk membangun definisi ini.

queues: number[]

Daftar ID antrean yang dibatasi koma. Jika ditentukan, filter untuk build yang berjalan terhadap antrean ini.

buildNumber: string

Jika ditentukan, filter untuk membangun yang cocok dengan nomor build ini. Tambahkan * untuk melakukan pencarian awalan.

minTime: Date

Jika ditentukan, filter ke build yang selesai/dimulai/diantrekan setelah tanggal ini berdasarkan queryOrder yang ditentukan.

maxTime: Date

Jika ditentukan, filter ke build yang selesai/dimulai/diantrekan sebelum tanggal ini berdasarkan queryOrder yang ditentukan.

requestedFor: string

Jika ditentukan, filter ke build yang diminta untuk pengguna yang ditentukan.

reasonFilter: BuildReason

Jika ditentukan, filter untuk membangun yang cocok dengan alasan ini.

statusFilter: BuildStatus

Jika ditentukan, filter untuk membangun yang cocok dengan status ini.

resultFilter: BuildResult

Jika ditentukan, filter untuk membangun yang cocok dengan hasil ini.

tagFilters: string[]

Daftar tag yang dibatasi koma. Jika ditentukan, filter ke build yang memiliki tag yang ditentukan.

properties: string[]

Daftar properti yang dibatasi koma untuk diambil.

top: number

Jumlah maksimum build yang akan dikembalikan.

continuationToken: string

Token kelanjutan, dikembalikan oleh panggilan sebelumnya ke metode ini, yang dapat digunakan untuk mengembalikan kumpulan build berikutnya.

maxBuildsPerDefinition: number

Jumlah maksimum build yang akan dikembalikan per definisi.

deletedFilter: QueryDeletedOption

Menunjukkan apakah akan mengecualikan, menyertakan, atau hanya mengembalikan build yang dihapus.

queryOrder: BuildQueryOrder

Urutan di mana build harus dikembalikan.

branchName: string

Jika ditentukan, filter ke build yang membangun cabang yang membangun cabang ini.

buildIds: number[]

Daftar yang dibatasi koma yang menentukan ID build yang akan diambil.

repositoryId: string

Jika ditentukan, filter ke build yang dibangun dari repositori ini.

repositoryType: string

Jika ditentukan, filter ke build yang dibangun dari repositori jenis ini.

Mengembalikan

Promise<PagedList<Build>>

getBuildSettings(string)

Mendapatkan pengaturan build.

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<BuildSettings>

getBuildTags(string, number)

Mendapatkan tag untuk build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

Mengembalikan

Promise<string[]>

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

Mendapatkan detail untuk build

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

timelineId: string

changeId: number

planId: string

Mengembalikan

Promise<Timeline>

getBuildWorkItemsRefs(string, number, number)

Mendapatkan item kerja yang terkait dengan build. Hanya item kerja dalam proyek yang sama yang dikembalikan.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

top: number

Jumlah maksimum item kerja yang akan dikembalikan.

Mengembalikan

Promise<ResourceRef[]>

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

Mendapatkan item kerja yang terkait dengan build, difilter ke penerapan tertentu.

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

Parameter

commitIds: string[]

Daftar ID penerapan yang dibatasi koma.

project: string

ID proyek atau nama proyek

buildId: number

ID build.

top: number

Jumlah maksimum item kerja yang akan dikembalikan, atau jumlah penerapan yang perlu dipertimbangkan jika tidak ada ID penerapan yang ditentukan.

Mengembalikan

Promise<ResourceRef[]>

getChangesBetweenBuilds(string, number, number, number)

Mendapatkan perubahan yang dilakukan pada repositori antara dua build yang diberikan.

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

Parameter

project: string

ID proyek atau nama proyek

fromBuildId: number

ID build pertama.

toBuildId: number

ID build terakhir.

top: number

Jumlah maksimum perubahan yang akan dikembalikan.

Mengembalikan

Promise<Change[]>

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

Mendapatkan definisi, secara opsional pada revisi tertentu.

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

Parameter

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

revision: number

Nomor revisi yang akan diambil. Jika ini tidak ditentukan, versi terbaru akan dikembalikan.

minMetricsTime: Date

Jika ditentukan, menunjukkan tanggal dari mana metrik harus disertakan.

propertyFilters: string[]

Daftar properti yang dibatasi koma untuk disertakan dalam hasilnya.

includeLatestBuilds: boolean

Mengembalikan

Promise<BuildDefinition>

getDefinitionMetrics(string, number, Date)

Mendapatkan metrik build untuk definisi.

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

Parameter

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

minMetricsTime: Date

Tanggal untuk menghitung metrik.

Mengembalikan

Promise<BuildMetric[]>

getDefinitionProperties(string, number, string[])

Mendapatkan properti untuk definisi.

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

Parameter

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

filter: string[]

Daftar properti yang dibatasi koma. Jika ditentukan, filter ke properti tertentu ini.

Mengembalikan

Promise<any>

getDefinitionResources(string, number)

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

Parameter

project: string

ID proyek atau nama proyek

definitionId: number

Mengembalikan

Promise<DefinitionResourceReference[]>

getDefinitionRevisions(string, number)

Mendapatkan semua revisi definisi.

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

Parameter

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

Mengembalikan

Promise<BuildDefinitionRevision[]>

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

Mendapatkan daftar definisi.

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

ID proyek atau nama proyek

name: string

Jika ditentukan, filter ke definisi yang namanya cocok dengan pola ini.

repositoryId: string

ID repositori. Jika ditentukan, filter ke definisi yang menggunakan repositori ini.

repositoryType: string

Jika ditentukan, filter ke definisi yang memiliki repositori jenis ini.

queryOrder: DefinitionQueryOrder

Menunjukkan urutan di mana definisi harus dikembalikan.

top: number

Jumlah maksimum definisi yang akan dikembalikan.

continuationToken: string

Token kelanjutan, yang dikembalikan oleh panggilan sebelumnya ke metode ini, yang dapat digunakan untuk mengembalikan kumpulan definisi berikutnya.

minMetricsTime: Date

Jika ditentukan, menunjukkan tanggal dari mana metrik harus disertakan.

definitionIds: number[]

Daftar yang dibatasi koma yang menentukan ID definisi yang akan diambil.

path: string

Jika ditentukan, filter ke definisi di bawah folder ini.

builtAfter: Date

Jika ditentukan, filter ke definisi yang memiliki build setelah tanggal ini.

notBuiltAfter: Date

Jika ditentukan, filter ke definisi yang tidak memiliki build setelah tanggal ini.

includeAllProperties: boolean

Menunjukkan apakah definisi lengkap harus dikembalikan. Secara default, representasi dangkal dari definisi dikembalikan.

includeLatestBuilds: boolean

Menunjukkan apakah akan mengembalikan build terbaru dan terbaru yang telah selesai untuk definisi ini.

taskIdFilter: string

Jika ditentukan, filter ke definisi yang menggunakan tugas yang ditentukan.

processType: number

Jika ditentukan, filter ke definisi dengan jenis proses yang diberikan.

yamlFilename: string

Jika ditentukan, filter ke definisi YAML yang cocok dengan nama file yang diberikan. Untuk menggunakan filter ini includeAllProperties harus diatur ke true

Mengembalikan

Promise<PagedList<BuildDefinitionReference>>

getDefinitionTags(string, number, number)

Mendapatkan tag untuk definisi.

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

Parameter

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

revision: number

Nomor revisi definisi. Jika tidak ditentukan, menggunakan revisi terbaru definisi.

Mengembalikan

Promise<string[]>

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

Mengonversi definisi ke YAML, secara opsional pada revisi tertentu.

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

Parameter

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

revision: number

Nomor revisi yang akan diambil. Jika ini tidak ditentukan, versi terbaru akan dikembalikan.

minMetricsTime: Date

Jika ditentukan, menunjukkan tanggal dari mana metrik harus disertakan.

propertyFilters: string[]

Daftar properti yang dibatasi koma untuk disertakan dalam hasilnya.

includeLatestBuilds: boolean

Mengembalikan

Promise<YamlBuild>

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

Mendapatkan file dari build.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

artifactName: string

Nama artefak.

fileId: string

Kunci primer untuk file.

fileName: string

Nama tempat file akan disetel.

Mengembalikan

Promise<ArrayBuffer>

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

Mendapatkan konten file di repositori kode sumber yang diberikan.

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

Parameter

project: string

ID proyek atau nama proyek

providerName: string

Nama penyedia sumber.

serviceEndpointId: string

Jika ditentukan, ID titik akhir layanan yang akan dikueri. Hanya dapat dihilangkan untuk penyedia yang tidak menggunakan titik akhir layanan, misalnya TFVC atau TFGit.

repository: string

Jika ditentukan, pengidentifikasi khusus vendor atau nama repositori untuk mendapatkan cabang. Hanya dapat dihilangkan untuk penyedia yang tidak mendukung beberapa repositori.

commitOrBranch: string

Pengidentifikasi penerapan atau cabang tempat konten file diambil.

path: string

Jalur ke file yang akan diambil, relatif terhadap akar repositori.

Mengembalikan

Promise<string>

getFolders(string, string, FolderQueryOrder)

Mendapatkan daftar folder definisi build.

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

Parameter

project: string

ID proyek atau nama proyek

path: string

Jalur untuk memulai.

queryOrder: FolderQueryOrder

Urutan di mana folder harus dikembalikan.

Mengembalikan

Promise<Folder[]>

getLatestBuild(string, string, string)

Mendapatkan build terbaru untuk definisi, secara opsional dicakup ke cabang tertentu.

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

Parameter

project: string

ID proyek atau nama proyek

definition: string

nama definisi dengan jalur folder utama opsional, atau id definisi

branchName: string

parameter opsional yang menunjukkan cabang tertentu untuk digunakan. Jika tidak ditentukan, cabang default digunakan.

Mengembalikan

Promise<Build>

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

Mendapatkan konten direktori di repositori kode sumber tertentu.

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

Parameter

project: string

ID proyek atau nama proyek

providerName: string

Nama penyedia sumber.

serviceEndpointId: string

Jika ditentukan, ID titik akhir layanan yang akan dikueri. Hanya dapat dihilangkan untuk penyedia yang tidak menggunakan titik akhir layanan, misalnya TFVC atau TFGit.

repository: string

Jika ditentukan, pengidentifikasi khusus vendor atau nama repositori untuk mendapatkan cabang. Hanya dapat dihilangkan untuk penyedia yang tidak mendukung beberapa repositori.

commitOrBranch: string

Pengidentifikasi penerapan atau cabang tempat konten file diambil.

path: string

Jalur konten ke daftar, relatif terhadap akar repositori.

Mengembalikan

Promise<SourceRepositoryItem[]>

getProjectMetrics(string, string, Date)

Mendapatkan metrik build untuk proyek.

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

Parameter

project: string

ID proyek atau nama proyek

metricAggregationType: string

Jenis agregasi yang akan digunakan (per jam, setiap hari).

minMetricsTime: Date

Tanggal untuk menghitung metrik.

Mengembalikan

Promise<BuildMetric[]>

getProjectResources(string, string, string)

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

Parameter

project: string

ID proyek atau nama proyek

type: string

id: string

Mengembalikan

Promise<DefinitionResourceReference[]>

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

Mendapatkan objek permintaan pull dari penyedia sumber.

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

Parameter

project: string

ID proyek atau nama proyek

providerName: string

Nama penyedia sumber.

pullRequestId: string

Id khusus vendor dari permintaan pull.

repositoryId: string

Pengidentifikasi khusus vendor atau nama repositori yang berisi permintaan pull.

serviceEndpointId: string

Jika ditentukan, ID titik akhir layanan yang akan dikueri. Hanya dapat dihilangkan untuk penyedia yang tidak menggunakan titik akhir layanan, misalnya TFVC atau TFGit.

Mengembalikan

Promise<PullRequest>

getResourceUsage()

Mendapatkan informasi tentang sumber daya build dalam sistem.

function getResourceUsage(): Promise<BuildResourceUsage>

Mengembalikan

Promise<BuildResourceUsage>

getRetentionHistory(number)

Mengembalikan riwayat retensi untuk kumpulan proyek. Ini termasuk alur yang memiliki aturan retensi kustom yang dapat mencegah pekerjaan retensi membersihkannya, menjalankan per alur dengan jenis retensi, file yang terkait dengan alur yang dimiliki oleh koleksi dengan jenis retensi, dan jumlah file per alur.

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

Parameter

daysToLookback: number

Mengembalikan

Promise<BuildRetentionHistory>

getRetentionLease(string, number)

Mengembalikan detail sewa retensi yang diberikan id sewa.

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

Parameter

project: string

ID proyek atau nama proyek

leaseId: number

Mengembalikan

Promise<RetentionLease>

getRetentionLeasesByMinimalRetentionLeases(string, MinimalRetentionLease[])

Mengembalikan sewa apa pun yang cocok dengan MinimalRetentionLeases yang ditentukan

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

Parameter

project: string

ID proyek atau nama proyek

leasesToFetch: MinimalRetentionLease[]

Daftar MinimalRetentionLeases berseri JSON yang dipisahkan oleh '|'

Mengembalikan

Promise<RetentionLease[]>

getRetentionLeasesByOwnerId(string, string, number, number)

Mengembalikan sewa apa pun yang dimiliki oleh entitas yang ditentukan, secara opsional dilingkup ke definisi alur tunggal dan dijalankan.

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

Parameter

project: string

ID proyek atau nama proyek

ownerId: string

definitionId: number

Parameter opsional untuk membatasi pencarian ke definisi alur tertentu.

runId: number

Parameter opsional untuk membatasi pencarian ke satu eksekusi alur. Memerlukan definitionId.

Mengembalikan

Promise<RetentionLease[]>

getRetentionLeasesByUserId(string, string, number, number)

Mengembalikan sewa apa pun yang dimiliki oleh pengguna yang ditentukan, secara opsional dilingkup ke definisi alur tunggal dan dijalankan.

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

Parameter

project: string

ID proyek atau nama proyek

userOwnerId: string

Id pengguna yang akan dicari.

definitionId: number

Parameter opsional untuk membatasi pencarian ke definisi alur tertentu.

runId: number

Parameter opsional untuk membatasi pencarian ke satu eksekusi alur. Memerlukan definitionId.

Mengembalikan

Promise<RetentionLease[]>

getRetentionLeasesForBuild(string, number)

Mendapatkan semua sewa retensi yang berlaku untuk build tertentu.

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

Parameter

project: string

ID proyek atau nama proyek

buildId: number

ID build.

Mengembalikan

Promise<RetentionLease[]>

getRetentionSettings(string)

Mendapatkan pengaturan retensi proyek.

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<ProjectRetentionSetting>

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

<p>Mendapatkan status build untuk definisi, secara opsional dicakup ke cabang, tahap, pekerjaan, dan konfigurasi tertentu.</p><p>Jika ada lebih dari satu, maka diperlukan untuk meneruskan nilai stageName saat menentukan jobName, dan aturan yang sama kemudian berlaku untuk keduanya jika melewati parameter konfigurasi.</p>

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

Parameter

project: string

ID proyek atau nama proyek

definition: string

Baik nama definisi dengan jalur folder terkemuka opsional, atau id definisi.

branchName: string

Hanya pertimbangkan build terbaru untuk cabang ini. Jika tidak ditentukan, cabang default digunakan.

stageName: string

Gunakan tahap ini dalam alur untuk merender status.

jobName: string

Gunakan pekerjaan ini dalam tahap alur untuk merender status.

configuration: string

Gunakan konfigurasi pekerjaan ini untuk merender status

label: string

Mengganti teks default di sisi kiri lencana.

Mengembalikan

Promise<string>

getTags(string)

Mendapatkan daftar semua tag build dalam proyek.

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<string[]>

getTemplate(string, string)

Mendapatkan templat definisi build tertentu.

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

Parameter

project: string

ID proyek atau nama proyek

templateId: string

ID templat yang diminta.

Mengembalikan

Promise<BuildDefinitionTemplate>

getTemplates(string)

Mendapatkan semua templat definisi.

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<BuildDefinitionTemplate[]>

getWorkItemsBetweenBuilds(string, number, number, number)

Mendapatkan semua item kerja di antara dua build.

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

Parameter

project: string

ID proyek atau nama proyek

fromBuildId: number

ID build pertama.

toBuildId: number

ID build terakhir.

top: number

Jumlah maksimum item kerja yang akan dikembalikan.

Mengembalikan

Promise<ResourceRef[]>

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

Mendapatkan daftar cabang untuk repositori kode sumber yang diberikan.

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

Parameter

project: string

ID proyek atau nama proyek

providerName: string

Nama penyedia sumber.

serviceEndpointId: string

Jika ditentukan, ID titik akhir layanan yang akan dikueri. Hanya dapat dihilangkan untuk penyedia yang tidak menggunakan titik akhir layanan, misalnya TFVC atau TFGit.

repository: string

Pengidentifikasi khusus vendor atau nama repositori untuk mendapatkan cabang. Hanya dapat dihilangkan untuk penyedia yang tidak mendukung beberapa repositori.

branchName: string

Jika disediakan, nama cabang yang akan diperiksa secara khusus.

Mengembalikan

Promise<string[]>

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

Mendapatkan daftar repositori kode sumber.

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

Parameter

project: string

ID proyek atau nama proyek

providerName: string

Nama penyedia sumber.

serviceEndpointId: string

Jika ditentukan, ID titik akhir layanan yang akan dikueri. Hanya dapat dihilangkan untuk penyedia yang tidak menggunakan titik akhir layanan, misalnya TFVC atau TFGit.

repository: string

Jika ditentukan, pengidentifikasi khusus vendor atau nama repositori tunggal yang akan didapatkan.

resultSet: ResultSet

'top' untuk repositori yang paling relevan untuk titik akhir. Jika tidak diatur, semua repositori dikembalikan. Diabaikan jika 'repositori' diatur.

pageResults: boolean

Jika diatur ke true, ini akan membatasi kumpulan hasil dan akan mengembalikan token kelanjutan untuk melanjutkan kueri.

continuationToken: string

Ketika hasil penomoran, ini adalah token kelanjutan, dikembalikan oleh panggilan sebelumnya ke metode ini, yang dapat digunakan untuk mengembalikan set repositori berikutnya.

Mengembalikan

Promise<SourceRepositories>

listSourceProviders(string)

Dapatkan daftar penyedia sumber dan kemampuannya.

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

Parameter

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<SourceProviderAttributes[]>

listWebhooks(string, string, string, string)

Mendapatkan daftar webhook yang diinstal di repositori kode sumber tertentu.

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

Parameter

project: string

ID proyek atau nama proyek

providerName: string

Nama penyedia sumber.

serviceEndpointId: string

Jika ditentukan, ID titik akhir layanan yang akan dikueri. Hanya dapat dihilangkan untuk penyedia yang tidak menggunakan titik akhir layanan, misalnya TFVC atau TFGit.

repository: string

Jika ditentukan, pengidentifikasi khusus vendor atau nama repositori untuk mendapatkan webhook. Hanya dapat dihilangkan untuk penyedia yang tidak mendukung beberapa repositori.

Mengembalikan

Promise<RepositoryWebhook[]>

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

Mengantrekan build

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

Parameter

build: Build

project: string

ID proyek atau nama proyek

ignoreWarnings: boolean

checkInTicket: string

sourceBuildId: number

definitionId: number

Id definisi opsional untuk mengantre build tanpa isi. Diabaikan jika ada isi yang valid

Mengembalikan

Promise<Build>

restoreDefinition(string, number, boolean)

Memulihkan definisi yang dihapus

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

Parameter

project: string

ID proyek atau nama proyek

definitionId: number

Pengidentifikasi definisi yang akan dipulihkan.

deleted: boolean

Saat false, memulihkan definisi yang dihapus.

Mengembalikan

Promise<BuildDefinition>

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

Membuat ulang webhook untuk pemicu yang ditentukan dalam repositori kode sumber yang diberikan.

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

Parameter

triggerTypes: DefinitionTriggerType[]

Jenis pemicu untuk memulihkan webhook.

project: string

ID proyek atau nama proyek

providerName: string

Nama penyedia sumber.

serviceEndpointId: string

Jika ditentukan, ID titik akhir layanan yang akan dikueri. Hanya dapat dihilangkan untuk penyedia yang tidak menggunakan titik akhir layanan, misalnya TFVC atau TFGit.

repository: string

Jika ditentukan, pengidentifikasi khusus vendor atau nama repositori untuk mendapatkan webhook. Hanya dapat dihilangkan untuk penyedia yang tidak mendukung beberapa repositori.

Mengembalikan

Promise<void>

saveTemplate(BuildDefinitionTemplate, string, string)

Memperbarui templat definisi build yang ada.

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

Parameter

template: BuildDefinitionTemplate

Versi baru templat.

project: string

ID proyek atau nama proyek

templateId: string

ID templat.

Mengembalikan

Promise<BuildDefinitionTemplate>

updateBuild(Build, string, number, boolean)

Memperbarui build.

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

Parameter

build: Build

Build.

project: string

ID proyek atau nama proyek

buildId: number

ID build.

retry: boolean

Mengembalikan

Promise<Build>

updateBuildGeneralSettings(PipelineGeneralSettings, string)

Memperbarui pengaturan umum alur.

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

Parameter

newSettings: PipelineGeneralSettings

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<PipelineGeneralSettings>

updateBuildProperties(JsonPatchDocument, string, number)

Memperbarui properti untuk build.

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

Parameter

document: JsonPatchDocument

Dokumen json-patch yang menjelaskan properti yang akan diperbarui.

project: string

ID proyek atau nama proyek

buildId: number

ID build.

Mengembalikan

Promise<any>

updateBuilds(Build[], string)

Memperbarui beberapa build.

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

Parameter

builds: Build[]

Build yang akan diperbarui.

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<Build[]>

updateBuildSettings(BuildSettings, string)

Memperbarui pengaturan build.

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

Parameter

settings: BuildSettings

Pengaturan baru.

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<BuildSettings>

updateBuildTags(UpdateTagParameters, string, number)

Menambahkan/Menghapus tag dari build.

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

Parameter

updateParameters: UpdateTagParameters

Tag yang akan ditambahkan/dihapus.

project: string

ID proyek atau nama proyek

buildId: number

ID build.

Mengembalikan

Promise<string[]>

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

Memperbarui definisi build yang ada. Agar operasi ini berhasil, nilai properti "Revisi" dari isi permintaan harus cocok dengan definisi build yang ada. Disarankan agar Anda mendapatkan definisi build yang ada dengan menggunakan GET, memodifikasi definisi build seperlunya, lalu mengirimkan definisi yang dimodifikasi dengan PUT.

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

Parameter

definition: BuildDefinition

Versi baru definisi. Properti "Revisi" harus sesuai dengan definisi yang ada agar pembaruan diterima.

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

secretsSourceDefinitionId: number

secretsSourceDefinitionRevision: number

Mengembalikan

Promise<BuildDefinition>

updateDefinitionProperties(JsonPatchDocument, string, number)

Memperbarui properti untuk definisi.

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

Parameter

document: JsonPatchDocument

Dokumen json-patch yang menjelaskan properti yang akan diperbarui.

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

Mengembalikan

Promise<any>

updateDefinitionTags(UpdateTagParameters, string, number)

Menambahkan/Menghapus tag dari definisi.

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

Parameter

updateParameters: UpdateTagParameters

Tag yang akan ditambahkan/dihapus.

project: string

ID proyek atau nama proyek

definitionId: number

ID definisi.

Mengembalikan

Promise<string[]>

updateFolder(Folder, string, string)

Memperbarui folder yang ada pada jalur yang ada

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

Parameter

folder: Folder

Versi baru folder.

project: string

ID proyek atau nama proyek

path: string

Jalur lengkap ke folder.

Mengembalikan

Promise<Folder>

updateRetentionLease(RetentionLeaseUpdate, string, number)

Memperbarui status perlindungan durasi atau alur dari sewa retensi.

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

Parameter

leaseUpdate: RetentionLeaseUpdate

Data baru untuk sewa retensi.

project: string

ID proyek atau nama proyek

leaseId: number

ID sewa yang akan diperbarui.

Mengembalikan

Promise<RetentionLease>

updateRetentionSettings(UpdateProjectRetentionSettingModel, string)

Memperbarui pengaturan retensi proyek.

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

Parameter

updateModel: UpdateProjectRetentionSettingModel

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<ProjectRetentionSetting>

updateStage(UpdateStageParameters, number, string, string)

Memperbarui tahap build

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

Parameter

updateParameters: UpdateStageParameters

buildId: number

stageRefName: string

project: string

ID proyek atau nama proyek

Mengembalikan

Promise<void>

Saran dan Komentar

Apakah halaman ini membantu?

Bagikan melalui

BuildRestClient class

Konstruktor

Properti

Metode

Detail Konstruktor

BuildRestClient(IVssRestClientOptions)

Parameter

Detail Properti

RESOURCE_AREA_ID

Nilai Properti

Detail Metode

addBuildTag(string, number, string)

Parameter

Mengembalikan

addBuildTags(string[], string, number)

Parameter

Mengembalikan

addDefinitionTag(string, number, string)

Parameter

Mengembalikan

addDefinitionTags(string[], string, number)

Parameter

Mengembalikan

addRetentionLeases(NewRetentionLease[], string)

Parameter

Mengembalikan

authorizeDefinitionResources(DefinitionResourceReference[], string, number)

Parameter

Mengembalikan

authorizeProjectResources(DefinitionResourceReference[], string)

Parameter

Mengembalikan

createArtifact(BuildArtifact, string, number)

Parameter

Mengembalikan

createDefinition(BuildDefinition, string, number, number)

Parameter

Mengembalikan

createFolder(Folder, string, string)

Parameter

Mengembalikan

deleteBuild(string, number)

Parameter

Mengembalikan

deleteBuildTag(string, number, string)

Parameter

Mengembalikan

deleteDefinition(string, number)

Parameter

Mengembalikan

deleteDefinitionTag(string, number, string)

Parameter

Mengembalikan

deleteFolder(string, string)

Parameter

Mengembalikan

deleteRetentionLeasesById(string, number[])

Parameter

Mengembalikan

deleteTag(string, string)

Parameter

Mengembalikan

deleteTemplate(string, string)

Parameter

Mengembalikan

getArtifact(string, number, string)

Parameter

Mengembalikan

getArtifactContentZip(string, number, string)

Parameter

Mengembalikan

getArtifacts(string, number)

Parameter

Mengembalikan

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

Parameter

Mengembalikan

getAttachments(string, number, string)

Parameter