Deploymentgroups - Add

Service:

Task Agent

API Version:

5.0-preview.1

Membuat grup penyebaran.

POST https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups?api-version=5.0-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 '5.0-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=5.0-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
JToken
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 jenis 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
TaskAgentAuthorization	Menyediakan data yang diperlukan untuk mengotorisasi agen menggunakan alur autentikasi OAuth 2.0.
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
TaskAgentPoolReference
TaskAgentPoolType	Mendapatkan atau mengatur jenis kumpulan
TaskAgentPublicKey	Mewakili bagian kunci publik dari kunci asimetris RSA.
TaskAgentReference
TaskAgentStatus	Mendapatkan status konektivitas agen saat ini.
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

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.
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
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
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

JObject

Nama	Jenis	Deskripsi
item	JToken
type	string

JToken

Nama	Jenis	Deskripsi
first	JToken
hasValues	boolean
item	JToken
last	JToken
next	JToken
parent	string
path	string
previous	JToken
root	JToken
type	string

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 jenis 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[]	Sekumpulan 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

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
accessPoint	string	Mendapatkan titik akses agen.
assignedAgentCloudRequest	TaskAgentCloudRequest	Mendapatkan Permintaan Cloud Agen yang saat ini terkait dengan agen ini
assignedRequest	TaskAgentJobRequest	Mendapatkan permintaan yang saat ini ditetapkan ke agen ini.
authorization	TaskAgentAuthorization	Mendapatkan atau mengatur informasi otorisasi untuk agen ini.
createdOn	string	Mendapatkan tanggal di mana agen ini dibuat.
enabled	boolean	Mendapatkan atau menetapkan nilai yang menunjukkan apakah agen ini harus diaktifkan untuk eksekusi pekerjaan atau tidak.
id	integer	Mendapatkan pengidentifikasi agen.
lastCompletedRequest	TaskAgentJobRequest	Mendapatkan permintaan terakhir yang diselesaikan oleh agen ini.
maxParallelism	integer	Mendapatkan atau mengatur paralelisme pekerjaan maksimum yang diizinkan pada host ini.
name	string	Mendapatkan nama agen.
oSDescription	string	Mendapatkan OS agen.
pendingUpdate	TaskAgentUpdate	Mendapatkan 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 jenis Byte[], Int32, Double, DateType dan String mempertahankan jenisnya, primitif lainnya disesuaikan sebagai String. Byte[] diharapkan sebagai string yang dikodekan base64.
provisioningState	string	Mendapatkan atau mengatur status penyediaan agen ini saat ini
status	TaskAgentStatus	Mendapatkan status konektivitas agen saat ini.
statusChangedOn	string	Mendapatkan tanggal terjadinya perubahan status konektivitas terakhir.
systemCapabilities	object
userCapabilities	object
version	string	Mendapatkan versi agen.

TaskAgentAuthorization

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

Nama	Jenis	Deskripsi
authorizationUrl	string	Mendapatkan atau mengatur titik akhir yang digunakan untuk mendapatkan token akses dari layanan token yang dikonfigurasi.
clientId	string	Mendapatkan atau mengatur pengidentifikasi klien untuk agen ini.
publicKey	TaskAgentPublicKey	Mendapatkan atau mengatur kunci publik yang digunakan untuk memverifikasi identitas agen ini.

TaskAgentCloudRequest

Nama	Jenis	Deskripsi
agent	TaskAgentReference
agentCloudId	integer
agentConnectedTime	string
agentData	JObject
agentSpecification	JObject
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentDelaySource

Nama	Jenis	Deskripsi
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

Nama	Jenis	Deskripsi
agentDelays	TaskAgentDelaySource[]
agentSpecification	JObject
assignTime	string
data	object
definition	TaskOrchestrationOwner
demands	Demand[]
expectedDuration	string
finishTime	string
hostId	string
jobId	string
jobName	string
lockedUntil	string
matchedAgents	TaskAgentReference[]
orchestrationId	string
owner	TaskOrchestrationOwner
planGroup	string
planId	string
planType	string
poolId	integer
queueId	integer
queueTime	string
receiveTime	string
requestId	integer
reservedAgent	TaskAgentReference
result	TaskResult
scopeId	string
serviceOwner	string

TaskAgentPoolReference

Nama	Jenis	Deskripsi
id	integer
isHosted	boolean	Mendapatkan atau menetapkan nilai yang menunjukkan apakah kumpulan ini dikelola oleh layanan atau tidak.
name	string
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
deployment	string

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

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
accessPoint	string	Mendapatkan titik akses agen.
enabled	boolean	Mendapatkan atau menetapkan nilai yang menunjukkan apakah agen ini harus diaktifkan untuk eksekusi pekerjaan atau tidak.
id	integer	Mendapatkan pengidentifikasi agen.
name	string	Mendapatkan nama agen.
oSDescription	string	Mendapatkan OS agen.
provisioningState	string	Mendapatkan atau mengatur status penyediaan agen ini saat ini
status	TaskAgentStatus	Mendapatkan status konektivitas agen saat ini.
version	string	Mendapatkan versi agen.

TaskAgentStatus

Mendapatkan status konektivitas agen saat ini.

Nama	Jenis	Deskripsi
offline	string
online	string

TaskAgentUpdate

Nama	Jenis	Deskripsi
currentState	string	Status pembaruan agen ini saat ini
reason	TaskAgentUpdateReason	Alasan pembaruan agen ini
requestTime	string	Mendapatkan tanggal di mana pembaruan agen ini diminta.
requestedBy	IdentityRef	Identitas yang meminta pembaruan agen
sourceVersion	PackageVersion	Mendapatkan atau mengatur versi agen sumber dari pembaruan agen
targetVersion	PackageVersion	Mendapatkan atau menetapkan versi agen target dari pembaruan agen

TaskAgentUpdateReason

Nama	Jenis	Deskripsi
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

Nama	Jenis	Deskripsi
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

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

TaskResult

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