Builds - Queue

Service:

Build

API Version:

7.1-preview.7

Mengantrekan build

POST https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.1-preview.7

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/build/builds?ignoreWarnings={ignoreWarnings}&checkInTicket={checkInTicket}&sourceBuildId={sourceBuildId}&definitionId={definitionId}&api-version=7.1-preview.7

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
project	path	True	string	ID proyek atau nama proyek
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.7' untuk menggunakan versi api ini.
checkInTicket	query		string
definitionId	query		integer int32	Id definisi opsional untuk mengantre build tanpa isi. Diabaikan jika ada isi yang valid
ignoreWarnings	query		boolean
sourceBuildId	query		integer int32

Isi Permintaan

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
agentSpecification	AgentSpecification	Spesifikasi agen untuk build.
appendCommitMessageToRunName	boolean	Tambahkan Pesan Penerapan Untuk BuildNumber di UI.
buildNumber	string	Nomor build/nama build.
buildNumberRevision	integer	Revisi nomor build.
controller	BuildController	Pengontrol build. Ini hanya diatur jika jenis definisi adalah Xaml.
definition	DefinitionReference	Definisi yang terkait dengan build.
deleted	boolean	Menunjukkan apakah build telah dihapus.
deletedBy	IdentityRef	Identitas proses atau orang yang menghapus build.
deletedDate	string	Tanggal build dihapus.
deletedReason	string	Deskripsi tentang bagaimana build dihapus.
demands	Demand[]	Daftar tuntutan yang mewakili kemampuan agen yang diperlukan oleh build ini.
finishTime	string	Waktu pembangunan selesai.
id	integer	ID build.
lastChangedBy	IdentityRef	Identitas yang mewakili proses atau orang yang terakhir mengubah build.
lastChangedDate	string	Tanggal build terakhir diubah.
logs	BuildLogReference	Informasi tentang log build.
orchestrationPlan	TaskOrchestrationPlanReference	Rencana orkestrasi untuk build.
parameters	string	Parameter untuk build.
plans	TaskOrchestrationPlanReference[]	Rencana orkestrasi yang terkait dengan build (build, cleanup)
priority	QueuePriority	Prioritas build.
project	TeamProjectReference	Proyek tim.
properties	PropertiesCollection	Kelas mewakili tas properti sebagai kumpulan pasangan kunci-nilai. Nilai semua jenis primitif (jenis apa pun dengan ) TypeCode != TypeCode.Objectkecuali DBNull diterima. Nilai tipe Byte[], Int32, Double, DateType, dan String mempertahankan jenisnya, primitif lainnya disesuaikan sebagai String. Byte[] diharapkan sebagai string yang dikodekan base64.
quality	string	Kualitas build xaml (baik, buruk, dll.)
queue	AgentPoolQueue	Antrean. Ini hanya diatur jika jenis definisi adalah Build. PERINGATAN: bidang ini tidak digunakan lagi dan tidak sesuai dengan antrean pekerjaan.
queueOptions	QueueOptions	Opsi tambahan untuk mengantre build.
queuePosition	integer	Posisi build saat ini dalam antrean.
queueTime	string	Waktu saat build diantrekan.
reason	BuildReason	Alasan pembuatan build dibuat.
repository	BuildRepository	Repositori.
requestedBy	IdentityRef	Identitas yang mengantre build.
requestedFor	IdentityRef	Identitas atas nama siapa build diantrekan.
result	BuildResult	Hasil build.
retainedByRelease	boolean	Menunjukkan apakah build dipertahankan oleh rilis.
sourceBranch	string	Cabang sumber.
sourceVersion	string	Versi sumber.
startTime	string	Waktu build dimulai.
status	BuildStatus	Status build.
tags	string[]
templateParameters	object	Parameter untuk evaluasi ekspresi templat
triggerInfo	object	Informasi khusus penyedia sumber tentang apa yang memicu build
triggeredByBuild	Build	Build yang memicu build ini melalui pemicu penyelesaian Build.
uri	string	URI build.
url	string	URL REST build.
validationResults	BuildRequestValidationResult[]	Mewakili hasil validasi permintaan build.

Respons

Nama	Jenis	Deskripsi
200 OK	Build	operasi berhasil

Keamanan

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nama	Deskripsi
vso.build_execute	Memberikan kemampuan untuk mengakses artefak build, termasuk hasil build, definisi, dan permintaan, dan kemampuan untuk mengantre build, memperbarui properti build, dan kemampuan untuk menerima pemberitahuan tentang peristiwa build melalui kait layanan.

Definisi

Nama	Deskripsi
AgentPoolQueue	Mewakili antrean untuk menjalankan build.
AgentSpecification	Spesifikasi agen yang ditentukan oleh penyedia kumpulan.
Build	Representasi data dari build.
BuildController
BuildLogReference	Mewakili referensi ke log build.
BuildReason	Alasan pembuatan build dibuat.
BuildRepository	Mewakili repositori yang digunakan oleh definisi build.
BuildRequestValidationResult	Mewakili hasil validasi permintaan build.
BuildResult	Hasil build.
BuildStatus	Status build.
ControllerStatus	Status pengontrol.
DefinitionQueueStatus	Nilai yang menunjukkan apakah build dapat diantrekan terhadap definisi ini.
DefinitionReference	Mewakili referensi ke definisi.
DefinitionType	Jenis definisi.
Demand	Mewakili permintaan yang digunakan oleh definisi atau build.
IdentityRef
ProjectState	Status proyek.
ProjectVisibility	Visibilitas proyek.
PropertiesCollection	Kelas mewakili tas properti sebagai kumpulan pasangan kunci-nilai. Nilai semua jenis primitif (jenis apa pun dengan ) TypeCode != TypeCode.Objectkecuali DBNull diterima. Nilai tipe Byte[], Int32, Double, DateType, dan String mempertahankan jenisnya, primitif lainnya disesuaikan sebagai String. Byte[] diharapkan sebagai string yang dikodekan base64.
QueueOptions	Opsi tambahan untuk mengantre build.
QueuePriority	Prioritas build.
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
TaskAgentPoolReference	Mewakili referensi ke kumpulan agen.
TaskOrchestrationPlanReference	Mewakili referensi ke rencana orkestrasi.
TeamProjectReference	Mewakili referensi dangkal ke TeamProject.
ValidationResult	Hasilnya.

AgentPoolQueue

Mewakili antrean untuk menjalankan build.

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
id	integer	ID antrean.
name	string	Nama antrean.
pool	TaskAgentPoolReference	Kumpulan yang digunakan oleh antrean ini.
url	string	Tautan http lengkap ke sumber daya.

AgentSpecification

Spesifikasi agen yang ditentukan oleh penyedia kumpulan.

Nama	Jenis	Deskripsi
identifier	string	Pengidentifikasi unik spesifikasi agen.

Build

Representasi data dari build.

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
agentSpecification	AgentSpecification	Spesifikasi agen untuk build.
appendCommitMessageToRunName	boolean	Tambahkan Pesan Penerapan Untuk BuildNumber di UI.
buildNumber	string	Nomor build/nama build.
buildNumberRevision	integer	Revisi nomor build.
controller	BuildController	Pengontrol build. Ini hanya diatur jika jenis definisi adalah Xaml.
definition	DefinitionReference	Definisi yang terkait dengan build.
deleted	boolean	Menunjukkan apakah build telah dihapus.
deletedBy	IdentityRef	Identitas proses atau orang yang menghapus build.
deletedDate	string	Tanggal build dihapus.
deletedReason	string	Deskripsi tentang bagaimana build dihapus.
demands	Demand[]	Daftar tuntutan yang mewakili kemampuan agen yang diperlukan oleh build ini.
finishTime	string	Waktu pembangunan selesai.
id	integer	ID build.
lastChangedBy	IdentityRef	Identitas yang mewakili proses atau orang yang terakhir mengubah build.
lastChangedDate	string	Tanggal build terakhir diubah.
logs	BuildLogReference	Informasi tentang log build.
orchestrationPlan	TaskOrchestrationPlanReference	Rencana orkestrasi untuk build.
parameters	string	Parameter untuk build.
plans	TaskOrchestrationPlanReference[]	Rencana orkestrasi yang terkait dengan build (build, cleanup)
priority	QueuePriority	Prioritas build.
project	TeamProjectReference	Proyek tim.
properties	PropertiesCollection	Kelas mewakili tas properti sebagai kumpulan pasangan kunci-nilai. Nilai semua jenis primitif (jenis apa pun dengan ) TypeCode != TypeCode.Objectkecuali DBNull diterima. Nilai tipe Byte[], Int32, Double, DateType, dan String mempertahankan jenisnya, primitif lainnya disesuaikan sebagai String. Byte[] diharapkan sebagai string yang dikodekan base64.
quality	string	Kualitas build xaml (baik, buruk, dll.)
queue	AgentPoolQueue	Antrean. Ini hanya diatur jika jenis definisi adalah Build. PERINGATAN: bidang ini tidak digunakan lagi dan tidak sesuai dengan antrean pekerjaan.
queueOptions	QueueOptions	Opsi tambahan untuk mengantre build.
queuePosition	integer	Posisi build saat ini dalam antrean.
queueTime	string	Waktu saat build diantrekan.
reason	BuildReason	Alasan pembuatan build dibuat.
repository	BuildRepository	Repositori.
requestedBy	IdentityRef	Identitas yang mengantre build.
requestedFor	IdentityRef	Identitas atas nama siapa build diantrekan.
result	BuildResult	Hasil build.
retainedByRelease	boolean	Menunjukkan apakah build dipertahankan oleh rilis.
sourceBranch	string	Cabang sumber.
sourceVersion	string	Versi sumber.
startTime	string	Waktu build dimulai.
status	BuildStatus	Status build.
tags	string[]
templateParameters	object	Parameter untuk evaluasi ekspresi templat
triggerInfo	object	Informasi khusus penyedia sumber tentang apa yang memicu build
triggeredByBuild	Build	Build yang memicu build ini melalui pemicu penyelesaian Build.
uri	string	URI build.
url	string	URL REST build.
validationResults	BuildRequestValidationResult[]	Mewakili hasil validasi permintaan build.

BuildController

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
createdDate	string	Tanggal pengontrol dibuat.
description	string	Deskripsi pengontrol.
enabled	boolean	Menunjukkan apakah pengontrol diaktifkan.
id	integer	Id sumber daya
name	string	Nama sumber daya tertaut (nama definisi, nama pengontrol, dll.)
status	ControllerStatus	Status pengontrol.
updatedDate	string	Tanggal pengontrol terakhir diperbarui.
uri	string	URI pengontrol.
url	string	Tautan http penuh ke sumber daya

BuildLogReference

Mewakili referensi ke log build.

Nama	Jenis	Deskripsi
id	integer	ID log.
type	string	Jenis lokasi log.
url	string	Tautan lengkap ke sumber daya log.

BuildReason

Alasan pembuatan build dibuat.

Nama	Jenis	Deskripsi
all	string	Semua alasan.
batchedCI	string	Build dimulai untuk pemicu TriggerType.BatchedContinuousIntegration.
buildCompletion	string	Build dimulai ketika build lain selesai.
checkInShelveset	string	Build dimulai untuk pemicu ContinuousIntegrationType.Gated.
individualCI	string	Build dimulai untuk pemicu TriggerType.ContinuousIntegration.
manual	string	Build dimulai secara manual.
none	string	Tidak ada alasan. Nilai ini tidak boleh digunakan.
pullRequest	string	Build dimulai oleh permintaan pull. Ditambahkan dalam sumber daya versi 3.
resourceTrigger	string	Build dimulai ketika sumber daya dalam alur memicunya
schedule	string	Build dimulai untuk pemicu TriggerType.Schedule.
scheduleForced	string	Build dimulai untuk pemicu TriggerType.ScheduleForced.
triggered	string	Build dipicu untuk tujuan kebijakan penyimpanan.
userCreated	string	Build dibuat oleh pengguna.
validateShelveset	string	Build dimulai secara manual untuk validasi privat.

BuildRepository

Mewakili repositori yang digunakan oleh definisi build.

Nama	Jenis	Deskripsi
checkoutSubmodules	boolean	Menunjukkan apakah akan melakukan checkout submodul.
clean	string	Menunjukkan apakah akan membersihkan folder target saat mendapatkan kode dari repositori.
defaultBranch	string	Nama cabang default.
id	string	ID repositori.
name	string	Nama repositori yang ramah.
properties	object
rootFolder	string	Folder akar.
type	string	Jenis repositori.
url	string	URL repositori.

BuildRequestValidationResult

Mewakili hasil validasi permintaan build.

Nama	Jenis	Deskripsi
message	string	Pesan yang terkait dengan hasilnya.
result	ValidationResult	Hasilnya.

BuildResult

Hasil build.

Nama	Jenis	Deskripsi
canceled	string	Build dibatalkan sebelum memulai.
failed	string	Build selesai tidak berhasil.
none	string	Tidak ada hasil
partiallySucceeded	string	Build berhasil menyelesaikan kompilasi tetapi memiliki kesalahan lain.
succeeded	string	Build berhasil diselesaikan.

BuildStatus

Status build.

Nama	Jenis	Deskripsi
all	string	Semua status.
cancelling	string	Build sedang dibatalkan
completed	string	Build telah selesai.
inProgress	string	Build saat ini sedang berlangsung.
none	string	Tidak ada status.
notStarted	string	Build belum dimulai.
postponed	string	Build tidak aktif dalam antrean.

ControllerStatus

Status pengontrol.

Nama	Jenis	Deskripsi
available	string	Menunjukkan bahwa pengontrol build saat ini tersedia.
offline	string	Menunjukkan bahwa pengontrol build telah mengambil dirinya offline.
unavailable	string	Menunjukkan bahwa pengontrol build tidak dapat dihubungi.

DefinitionQueueStatus

Nilai yang menunjukkan apakah build dapat diantrekan terhadap definisi ini.

Nama	Jenis	Deskripsi
disabled	string	Ketika dinonaktifkan, antrean definisi tidak akan memungkinkan build untuk diantrekan oleh pengguna dan sistem tidak akan mengantre build integrasi terjadwal, terjaga, atau berkelanjutan. Build yang sudah ada dalam antrean tidak akan dimulai oleh sistem.
enabled	string	Ketika diaktifkan, antrean definisi memungkinkan build untuk diantrekan oleh pengguna, sistem akan mengantre build integrasi terjadwal, terjaga dan berkelanjutan, dan build yang diantrekan akan dimulai oleh sistem.
paused	string	Ketika dijeda, antrean definisi memungkinkan build untuk diantrekan oleh pengguna dan sistem akan mengantre build integrasi terjadwal, terjaga dan berkelanjutan. Build dalam antrean tidak akan dimulai oleh sistem.

DefinitionReference

Mewakili referensi ke definisi.

Nama	Jenis	Deskripsi
createdDate	string	Tanggal versi definisi ini dibuat.
id	integer	ID definisi yang dirujuk.
name	string	Nama definisi yang dirujuk.
path	string	Jalur folder definisi.
project	TeamProjectReference	Referensi ke proyek.
queueStatus	DefinitionQueueStatus	Nilai yang menunjukkan apakah build dapat diantrekan terhadap definisi ini.
revision	integer	Nomor revisi definisi.
type	DefinitionType	Jenis definisi.
uri	string	URI definisi.
url	string	URL REST definisi.

DefinitionType

Jenis definisi.

Nama	Jenis	Deskripsi
build	string
xaml	string

Demand

Mewakili permintaan yang digunakan oleh definisi atau build.

Nama	Jenis	Deskripsi
name	string	Nama kemampuan yang dirujuk oleh permintaan.
value	string	Nilai yang diminta.

IdentityRef

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi lebih rinci tentang subjek grafik ini.
descriptor	string	Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem berjalan. Bidang ini akan secara unik mengidentifikasi subjek grafik yang sama di seluruh Akun dan Organisasi.
directoryAlias	string	Tidak digunakan lagi - Dapat diambil dengan mengkueri pengguna Graph yang direferensikan dalam entri "mandiri" kamus IdentityRef "_links"
displayName	string	Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber.
id	string
imageUrl	string	Tidak digunakan lagi - Tersedia dalam entri "avatar" kamus IdentityRef "_links"
inactive	boolean	Tidak digunakan lagi - Dapat diambil dengan mengkueri status keanggotaan Graph yang direferensikan dalam entri "membershipState" dari kamus "_links" GraphUser
isAadIdentity	boolean	Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Tidak digunakan lagi - tidak digunakan dalam sebagian besar implementasi ToIdentityRef yang sudah ada sebelumnya
uniqueName	string	Tidak digunakan lagi - gunakan Domain+PrincipalName sebagai gantinya
url	string	Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

ProjectState

Status proyek.

Nama	Jenis	Deskripsi
all	string	Semua proyek terlepas dari status kecuali Dihapus.
createPending	string	Proyek telah diantrekan untuk pembuatan, tetapi prosesnya belum dimulai.
deleted	string	Proyek telah dihapus.
deleting	string	Project sedang dalam proses dihapus.
new	string	Proyek sedang dalam proses dibuat.
unchanged	string	Proyek belum diubah.
wellFormed	string	Project benar-benar dibuat dan siap digunakan.

ProjectVisibility

Visibilitas proyek.

Nama	Jenis	Deskripsi
private	string	Proyek ini hanya terlihat oleh pengguna dengan akses eksplisit.
public	string	Proyek ini terlihat oleh semua.

PropertiesCollection

Kelas mewakili tas properti sebagai kumpulan pasangan kunci-nilai. Nilai semua jenis primitif (jenis apa pun dengan ) TypeCode != TypeCode.Objectkecuali DBNull diterima. Nilai tipe Byte[], Int32, Double, DateType, dan String mempertahankan jenisnya, primitif lainnya disesuaikan sebagai String. Byte[] diharapkan sebagai string yang dikodekan base64.

Nama	Jenis	Deskripsi
count	integer	Jumlah properti dalam koleksi.
item	object
keys	string[]	Set kunci dalam koleksi.
values	string[]	Kumpulan nilai dalam koleksi.

QueueOptions

Opsi tambahan untuk mengantre build.

Nama	Jenis	Deskripsi
doNotRun	string	Buat ID paket untuk build, jangan jalankan
none	string	Tidak ada opsi antrean

QueuePriority

Prioritas build.

Nama	Jenis	Deskripsi
aboveNormal	string	Prioritas di atas normal.
belowNormal	string	Di bawah prioritas normal.
high	string	Prioritas tinggi.
low	string	Prioritas rendah.
normal	string	Prioritas normal.

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan baca-saja dari tautan. Karena tautan Referensi bersifat baca-saja, kami hanya ingin mengeksposnya sebagai baca saja.

TaskAgentPoolReference

Mewakili referensi ke kumpulan agen.

Nama	Jenis	Deskripsi
id	integer	ID kumpulan.
isHosted	boolean	Nilai yang menunjukkan apakah kumpulan ini dikelola oleh layanan atau tidak.
name	string	Nama kumpulan.

TaskOrchestrationPlanReference

Mewakili referensi ke rencana orkestrasi.

Nama	Jenis	Deskripsi
orchestrationType	integer	Jenis rencana.
planId	string	ID paket.

TeamProjectReference

Mewakili referensi dangkal ke TeamProject.

Nama	Jenis	Deskripsi
abbreviation	string	Singkatan proyek.
defaultTeamImageUrl	string	Url ke gambar identitas tim default.
description	string	Deskripsi proyek (jika ada).
id	string	Pengidentifikasi proyek.
lastUpdateTime	string	Waktu pembaruan terakhir proyek.
name	string	Nama proyek.
revision	integer	Revisi proyek.
state	ProjectState	Status proyek.
url	string	Url ke versi lengkap objek.
visibility	ProjectVisibility	Visibilitas proyek.

ValidationResult

Hasilnya.

Nama	Jenis	Deskripsi
error	string
ok	string
warning	string