Deploymentgroups - Add

Service:

Distributed Task

API Version:

7.1-preview.1

Membuat grup penyebaran.

POST https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups?api-version=7.1-preview.1

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.1' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
description	string	Deskripsi grup penyebaran.
name	string	Nama grup penyebaran.
poolId	integer	Pengidentifikasi kumpulan penyebaran tempat agen penyebaran terdaftar.

Respons

Nama	Jenis	Deskripsi
200 OK	DeploymentGroup	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.machinegroup_manage	Menyediakan kemampuan untuk mengelola grup penyebaran dan kumpulan agen

Contoh

Create a deployment group

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups?api-version=7.1-preview.1

{
  "name": "MyDeploymentGroup1",
  "description": "This deployment group is created to demnostrate the client usage"
}

Sample Response

Status code:

200

{
  "machineCount": 0,
  "description": "This deployment group is created to demnostrate the client usage",
  "id": 11,
  "project": {
    "id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
    "name": "DeploymentGroupRESTSample"
  },
  "name": "MyDeploymentGroup1",
  "pool": {
    "id": 6,
    "scope": "86088ab1-30d8-4526-9663-3406752b8bc6",
    "name": "DeploymentGroupRESTSample-MyDeploymentGroup1",
    "isHosted": false,
    "poolType": "deployment",
    "size": 0
  }
}

Definisi

Nama	Deskripsi
Demand
DeploymentGroup	Grup penyebaran.
DeploymentGroupCreateParameter	Properti untuk membuat grup Penyebaran.
DeploymentMachine	Target penyebaran.
IdentityRef
JObject	Mewakili objek JSON.
JToken	Mewakili token JSON abstrak.
PackageVersion
ProjectReference
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.
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
TaskAgent	Agen tugas.
TaskAgentAuthorization	Menyediakan data yang diperlukan untuk mengotorisasi agen menggunakan alur autentikasi OAuth 2.0.
TaskAgentCloudRequest
TaskAgentJobRequest	Permintaan pekerjaan untuk agen.
TaskAgentPoolOptions	Pengaturan dan detail kumpulan tambahan
TaskAgentPoolReference
TaskAgentPoolType	Mendapatkan atau mengatur jenis kumpulan
TaskAgentPublicKey	Mewakili bagian kunci publik dari kunci asimetris RSA.
TaskAgentReference	Referensi ke agen.
TaskAgentStatus	Apakah agen sedang online atau tidak.
TaskAgentUpdate	Detail tentang pembaruan agen.
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult	Hasil dari permintaan ini.

Demand

Nama	Jenis	Deskripsi
name	string
value	string

DeploymentGroup

Grup penyebaran.

Nama	Jenis	Deskripsi
description	string	Deskripsi grup penyebaran.
id	integer	Pengidentifikasi grup penyebaran.
machineCount	integer	Jumlah target penyebaran dalam grup penyebaran.
machineTags	string[]	Daftar tag unik di semua target penyebaran dalam grup penyebaran.
machines	DeploymentMachine[]	Daftar target penyebaran dalam grup penyebaran.
name	string	Nama grup penyebaran.
pool	TaskAgentPoolReference	Kumpulan penyebaran tempat agen penyebaran terdaftar.
project	ProjectReference	Proyek tempat grup penyebaran berada.

DeploymentGroupCreateParameter

Properti untuk membuat grup Penyebaran.

Nama	Jenis	Deskripsi
description	string	Deskripsi grup penyebaran.
name	string	Nama grup penyebaran.
poolId	integer	Pengidentifikasi kumpulan penyebaran tempat agen penyebaran terdaftar.

DeploymentMachine

Target penyebaran.

Nama	Jenis	Deskripsi
agent	TaskAgent	Agen penyebaran.
id	integer	Pengidentifikasi target penyebaran.
properties	PropertiesCollection	Properti target penyebaran.
tags	string[]	Tag target penyebaran.

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 mengidentifikasi subjek grafik yang sama secara unik 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" 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.

JObject

Mewakili objek JSON.

Nama	Jenis	Deskripsi
item	JToken	Mewakili token JSON abstrak.
type	string	Mendapatkan jenis node untuk JToken ini.

JToken

Mewakili token JSON abstrak.

Nama	Jenis	Deskripsi
first	JToken	Dapatkan token anak pertama dari token ini.
hasValues	boolean	Mendapatkan nilai yang menunjukkan apakah token ini memiliki token anak.
item	JToken	Mewakili token JSON abstrak.
last	JToken	Dapatkan token anak terakhir dari token ini.
next	JToken	Mendapatkan token saudara kandung berikutnya dari simpul ini.
parent	string	Mendapatkan atau mengatur induk.
path	string	Mendapatkan jalur token JSON.
previous	JToken	Mendapatkan token saudara kandung sebelumnya dari simpul ini.
root	JToken	Mendapatkan JToken akar dari JToken ini.
type	string	Mendapatkan jenis node untuk JToken ini.

PackageVersion

Nama	Jenis	Deskripsi
major	integer
minor	integer
patch	integer

ProjectReference

Nama	Jenis	Deskripsi
id	string
name	string

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.

ReferenceLinks

Kelas untuk mewakili kumpulan tautan referensi REST.

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

TaskAgent

Agen tugas.

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
accessPoint	string	Titik akses agen ini.
assignedAgentCloudRequest	TaskAgentCloudRequest	Permintaan cloud agen yang saat ini terkait dengan agen ini.
assignedRequest	TaskAgentJobRequest	Permintaan yang saat ini ditetapkan ke agen ini.
authorization	TaskAgentAuthorization	Informasi otorisasi untuk agen ini.
createdOn	string	Tanggal pembuatan agen ini.
enabled	boolean	Apakah agen ini harus menjalankan pekerjaan atau tidak.
id	integer	Pengidentifikasi agen.
lastCompletedRequest	TaskAgentJobRequest	Permintaan terakhir yang diselesaikan oleh agen ini.
maxParallelism	integer	Paralelisme pekerjaan maksimum yang diizinkan untuk agen ini.
name	string	Nama agen.
osDescription	string	Agen OS.
pendingUpdate	TaskAgentUpdate	Pembaruan tertunda untuk agen ini.
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.
provisioningState	string	Status penyediaan agen ini.
status	TaskAgentStatus	Apakah agen sedang online atau tidak.
statusChangedOn	string	Tanggal terjadinya perubahan status konektivitas terakhir.
systemCapabilities	object	Kemampuan yang ditentukan sistem didukung oleh host agen ini. Peringatan: Untuk mengatur kemampuan, gunakan metode PUT, PUT akan sepenuhnya menimpa kemampuan yang ada.
userCapabilities	object	Kemampuan yang ditentukan pengguna didukung oleh host agen ini. Peringatan: Untuk mengatur kemampuan, gunakan metode PUT, PUT akan sepenuhnya menimpa kemampuan yang ada.
version	string	Versi agen.

TaskAgentAuthorization

Menyediakan data yang diperlukan untuk mengotorisasi agen menggunakan alur autentikasi OAuth 2.0.

Nama	Jenis	Deskripsi
authorizationUrl	string	Titik akhir digunakan untuk mendapatkan token akses dari layanan token yang dikonfigurasi.
clientId	string	Pengidentifikasi klien untuk agen ini.
publicKey	TaskAgentPublicKey	Kunci umum yang digunakan untuk memverifikasi identitas agen ini.

TaskAgentCloudRequest

Nama	Jenis	Deskripsi
agent	TaskAgentReference	Referensi ke agen.
agentCloudId	integer
agentConnectedTime	string
agentData	JObject	Mewakili objek JSON.
agentSpecification	JObject	Mewakili objek JSON.
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentJobRequest

Permintaan pekerjaan untuk agen.

Nama	Jenis	Deskripsi
agentSpecification	JObject	Mewakili objek JSON.
assignTime	string	Tanggal/waktu permintaan ini ditetapkan.
data	object	Data tambahan tentang permintaan.
definition	TaskOrchestrationOwner	Definisi alur yang terkait dengan permintaan ini
demands	Demand[]	Daftar tuntutan yang diperlukan untuk memenuhi permintaan ini.
finishTime	string	Tanggal/waktu permintaan ini selesai.
hostId	string	Host yang memicu permintaan ini.
jobId	string	ID pekerjaan yang dihasilkan dari permintaan ini.
jobName	string	Nama pekerjaan yang dihasilkan dari permintaan ini.
lockedUntil	string	Tenggat waktu bagi agen untuk memperbarui kunci.
matchedAgents	TaskAgentReference[]	Referensi ke agen.
matchesAllAgentsInPool	boolean
orchestrationId	string
owner	TaskOrchestrationOwner	Alur yang terkait dengan permintaan ini
planGroup	string
planId	string	ID internal untuk rencana orkestrasi yang terhubung dengan permintaan ini.
planType	string	Detail internal yang mewakili jenis rencana orkestrasi.
poolId	integer	ID kumpulan yang ditargetkan permintaan ini
priority	integer
queueId	integer	ID antrean yang ditargetkan permintaan ini
queueTime	string	Tanggal/waktu permintaan ini diantrekan.
receiveTime	string	Tanggal/waktu permintaan ini diterima oleh agen.
requestId	integer	ID permintaan.
reservedAgent	TaskAgentReference	Agen yang dialokasikan untuk permintaan ini.
result	TaskResult	Hasil dari permintaan ini.
scopeId	string	Cakupan alur; cocok dengan ID proyek.
serviceOwner	string	Layanan yang memiliki permintaan ini.
statusMessage	string
userDelayed	boolean

TaskAgentPoolOptions

Pengaturan dan detail kumpulan tambahan

Nama	Jenis	Deskripsi
elasticPool	string	TaskAgentPool yang didukung oleh layanan kumpulan Elastis
none	string
preserveAgentOnJobFailure	string	Atur ke true jika agen ditahan untuk penyelidikan setelah kegagalan TaskAgentJobRequest
singleUseAgents	string	Atur ke true jika agen di-image ulang setelah setiap TaskAgentJobRequest

TaskAgentPoolReference

Nama	Jenis	Deskripsi
id	integer
isHosted	boolean	Mendapatkan atau menetapkan nilai yang menunjukkan apakah kumpulan ini dikelola oleh layanan atau tidak.
isLegacy	boolean	Menentukan apakah kumpulan tersebut warisan.
name	string
options	TaskAgentPoolOptions	Pengaturan dan detail kumpulan tambahan
poolType	TaskAgentPoolType	Mendapatkan atau mengatur jenis kumpulan
scope	string
size	integer	Mendapatkan ukuran kumpulan saat ini.

TaskAgentPoolType

Mendapatkan atau mengatur jenis kumpulan

Nama	Jenis	Deskripsi
automation	string	Kumpulan agen tugas yang khas
deployment	string	Kumpulan penyebaran

TaskAgentPublicKey

Mewakili bagian kunci publik dari kunci asimetris RSA.

Nama	Jenis	Deskripsi
exponent	string[]	Mendapatkan atau mengatur eksponen untuk kunci publik.
modulus	string[]	Mendapatkan atau mengatur modulus untuk kunci umum.

TaskAgentReference

Referensi ke agen.

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
accessPoint	string	Titik akses agen ini.
enabled	boolean	Apakah agen ini harus menjalankan pekerjaan atau tidak.
id	integer	Pengidentifikasi agen.
name	string	Nama agen.
osDescription	string	AGEN OS.
provisioningState	string	Status penyediaan agen ini.
status	TaskAgentStatus	Apakah agen sedang online atau tidak.
version	string	Versi agen.

TaskAgentStatus

Apakah agen sedang online atau tidak.

Nama	Jenis	Deskripsi
offline	string
online	string

TaskAgentUpdate

Detail tentang pembaruan agen.

Nama	Jenis	Deskripsi
currentState	string	Status pembaruan agen ini saat ini.
reason	TaskAgentUpdateReason	Alasan pembaruan ini.
requestTime	string	Tanggal di mana pembaruan ini diminta.
requestedBy	IdentityRef	Identitas yang meminta pembaruan ini.
sourceVersion	PackageVersion	Versi agen sumber pembaruan.
targetVersion	PackageVersion	Versi agen target pembaruan.

TaskAgentUpdateReason

Nama	Jenis	Deskripsi
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Nama	Jenis	Deskripsi
downgrade	string
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
id	integer
name	string

TaskResult

Hasil dari permintaan ini.

Nama	Jenis	Deskripsi
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string