Deploymentgroups - List
Dapatkan daftar grup penyebaran berdasarkan nama atau ID.
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups?api-version=5.0-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups?name={name}&actionFilter={actionFilter}&$expand={$expand}&continuationToken={continuationToken}&$top={$top}&ids={ids}&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. |
$expand
|
query |
Sertakan detail tambahan ini di objek yang dikembalikan. |
||
$top
|
query |
integer int32 |
Jumlah maksimum grup penyebaran yang akan dikembalikan. Defaultnya adalah 1000. |
|
action
|
query |
Hanya dapatkan grup penyebaran tempat tindakan ini dapat dilakukan. |
||
continuation
|
query |
string |
Dapatkan grup penyebaran dengan nama yang lebih besar dari leksikografis continuationToken ini. |
|
ids
|
query |
string array (int32) |
Daftar ID grup penyebaran yang dipisahkan koma. |
|
name
|
query |
string |
Nama grup penyebaran. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
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
Get a deployment group by name |
Get deployment groups by IDs |
Get deployment groups in pages |
List all deployment groups |
Get a deployment group by name
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups?api-version=5.0-preview.1
Sample Response
{
"count": 1,
"value": [
{
"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
}
}
]
}
Get deployment groups by IDs
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups?api-version=5.0-preview.1
Sample Response
{
"count": 2,
"value": [
{
"machineCount": 0,
"description": "This deployment group is created to demnostrate the client usage",
"id": 12,
"project": {
"id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
"name": "DeploymentGroupRESTSample"
},
"name": "MyDeploymentGroup10",
"pool": {
"id": 7,
"scope": "86088ab1-30d8-4526-9663-3406752b8bc6",
"name": "DeploymentGroupRESTSample-MyDeploymentGroup10",
"isHosted": false,
"poolType": "deployment",
"size": 0
}
},
{
"machineCount": 0,
"description": "This deployment group is created to demnostrate the client usage",
"id": 13,
"project": {
"id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
"name": "DeploymentGroupRESTSample"
},
"name": "MyDeploymentGroup11",
"pool": {
"id": 8,
"scope": "86088ab1-30d8-4526-9663-3406752b8bc6",
"name": "DeploymentGroupRESTSample-MyDeploymentGroup11",
"isHosted": false,
"poolType": "deployment",
"size": 0
}
}
]
}
Get deployment groups in pages
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups?api-version=5.0-preview.1
Sample Response
x-MS-ContinuationToken: MyDeploymentGroup14
{
"count": 2,
"value": [
{
"machineCount": 0,
"description": "This deployment group is created to demnostrate the client usage",
"id": 14,
"project": {
"id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
"name": "DeploymentGroupRESTSample"
},
"name": "MyDeploymentGroup12",
"pool": {
"id": 9,
"scope": "86088ab1-30d8-4526-9663-3406752b8bc6",
"name": "DeploymentGroupRESTSample-MyDeploymentGroup12",
"isHosted": false,
"poolType": "deployment",
"size": 0
}
},
{
"machineCount": 0,
"description": "This deployment group is created to demnostrate the client usage",
"id": 15,
"project": {
"id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
"name": "DeploymentGroupRESTSample"
},
"name": "MyDeploymentGroup13",
"pool": {
"id": 10,
"scope": "86088ab1-30d8-4526-9663-3406752b8bc6",
"name": "DeploymentGroupRESTSample-MyDeploymentGroup13",
"isHosted": false,
"poolType": "deployment",
"size": 0
}
}
]
}
List all deployment groups
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups?api-version=5.0-preview.1
Sample Response
{
"count": 3,
"value": [
{
"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
}
},
{
"machineCount": 0,
"description": "This deployment group is created to demnostrate the client usage",
"id": 12,
"project": {
"id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
"name": "DeploymentGroupRESTSample"
},
"name": "MyDeploymentGroup10",
"pool": {
"id": 7,
"scope": "86088ab1-30d8-4526-9663-3406752b8bc6",
"name": "DeploymentGroupRESTSample-MyDeploymentGroup10",
"isHosted": false,
"poolType": "deployment",
"size": 0
}
},
{
"machineCount": 0,
"description": "This deployment group is created to demnostrate the client usage",
"id": 13,
"project": {
"id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
"name": "DeploymentGroupRESTSample"
},
"name": "MyDeploymentGroup11",
"pool": {
"id": 8,
"scope": "86088ab1-30d8-4526-9663-3406752b8bc6",
"name": "DeploymentGroupRESTSample-MyDeploymentGroup11",
"isHosted": false,
"poolType": "deployment",
"size": 0
}
}
]
}
Definisi
Nama | Deskripsi |
---|---|
Demand | |
Deployment |
Grup penyebaran. |
Deployment |
Hanya dapatkan grup penyebaran tempat tindakan ini dapat dilakukan. |
Deployment |
Sertakan detail tambahan ini di objek yang dikembalikan. |
Deployment |
Target penyebaran. |
Identity |
|
JObject | |
JToken | |
Package |
|
Project |
|
Properties |
Kelas mewakili tas properti sebagai kumpulan pasangan kunci-nilai. Nilai semua jenis primitif (jenis apa pun dengan ) |
Reference |
Kelas untuk mewakili kumpulan tautan referensi REST. |
Task |
|
Task |
Menyediakan data yang diperlukan untuk mengotorisasi agen menggunakan alur autentikasi OAuth 2.0. |
Task |
|
Task |
|
Task |
|
Task |
|
Task |
Mendapatkan atau mengatur jenis kumpulan |
Task |
Mewakili bagian kunci publik dari kunci asimetris RSA. |
Task |
|
Task |
Mendapatkan status konektivitas agen saat ini. |
Task |
|
Task |
|
Task |
|
Task |
|
Task |
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 |
Daftar target penyebaran dalam grup penyebaran. |
|
name |
string |
Nama grup penyebaran. |
pool |
Kumpulan penyebaran tempat agen penyebaran terdaftar. |
|
project |
Proyek tempat grup penyebaran berada. |
DeploymentGroupActionFilter
Hanya dapatkan grup penyebaran tempat tindakan ini dapat dilakukan.
Nama | Jenis | Deskripsi |
---|---|---|
manage |
string |
Hanya grup penyebaran yang pemanggilnya memiliki izin kelola . |
none |
string |
Semua grup penyebaran. |
use |
string |
Hanya grup penyebaran yang peneleponnya memiliki izin penggunaan . |
DeploymentGroupExpands
Sertakan detail tambahan ini di objek yang dikembalikan.
Nama | Jenis | Deskripsi |
---|---|---|
machines |
string |
Tidak digunakan lagi: Sertakan semua target penyebaran. |
none |
string |
Tidak ada properti tambahan. |
tags |
string |
Sertakan daftar tag unik di semua target penyebaran. |
DeploymentMachine
Target penyebaran.
Nama | Jenis | Deskripsi |
---|---|---|
agent |
Agen penyebaran. |
|
id |
integer |
Pengidentifikasi target penyebaran. |
tags |
string[] |
Tag target penyebaran. |
IdentityRef
Nama | Jenis | Deskripsi |
---|---|---|
_links |
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 |
|
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 | ||
type |
string |
JToken
Nama | Jenis | Deskripsi |
---|---|---|
first | ||
hasValues |
boolean |
|
item | ||
last | ||
next | ||
parent |
string |
|
path |
string |
|
previous | ||
root | ||
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.Object
kecuali 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 bersifat baca-saja, kami hanya ingin mengeksposnya sebagai baca saja. |
TaskAgent
Nama | Jenis | Deskripsi |
---|---|---|
_links |
Kelas untuk mewakili kumpulan tautan referensi REST. |
|
accessPoint |
string |
Mendapatkan titik akses agen. |
assignedAgentCloudRequest |
Mendapatkan Permintaan Cloud Agen yang saat ini terkait dengan agen ini |
|
assignedRequest |
Mendapatkan permintaan yang saat ini ditetapkan ke agen ini. |
|
authorization |
Mendapatkan atau mengatur informasi otorisasi untuk agen ini. |
|
createdOn |
string |
Mendapatkan tanggal pembuatan agen ini. |
enabled |
boolean |
Mendapatkan atau menetapkan nilai yang menunjukkan apakah agen ini harus diaktifkan untuk eksekusi pekerjaan atau tidak. |
id |
integer |
Mendapatkan pengidentifikasi agen. |
lastCompletedRequest |
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 |
Mendapatkan pembaruan yang tertunda untuk agen ini. |
|
properties |
Kelas mewakili tas properti sebagai kumpulan pasangan kunci-nilai. Nilai semua jenis primitif (jenis apa pun dengan ) |
|
provisioningState |
string |
Mendapatkan atau mengatur status penyediaan agen ini saat ini |
status |
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 |
Mendapatkan atau mengatur kunci publik yang digunakan untuk memverifikasi identitas agen ini. |
TaskAgentCloudRequest
Nama | Jenis | Deskripsi |
---|---|---|
agent | ||
agentCloudId |
integer |
|
agentConnectedTime |
string |
|
agentData | ||
agentSpecification | ||
pool | ||
provisionRequestTime |
string |
|
provisionedTime |
string |
|
releaseRequestTime |
string |
|
requestId |
string |
TaskAgentDelaySource
Nama | Jenis | Deskripsi |
---|---|---|
delays |
string[] |
|
taskAgent |
TaskAgentJobRequest
Nama | Jenis | Deskripsi |
---|---|---|
agentDelays | ||
agentSpecification | ||
assignTime |
string |
|
data |
object |
|
definition | ||
demands |
Demand[] |
|
expectedDuration |
string |
|
finishTime |
string |
|
hostId |
string |
|
jobId |
string |
|
jobName |
string |
|
lockedUntil |
string |
|
matchedAgents | ||
orchestrationId |
string |
|
owner | ||
planGroup |
string |
|
planId |
string |
|
planType |
string |
|
poolId |
integer |
|
queueId |
integer |
|
queueTime |
string |
|
receiveTime |
string |
|
requestId |
integer |
|
reservedAgent | ||
result | ||
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 |
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 umum. |
modulus |
string[] |
Mendapatkan atau mengatur modulus untuk kunci umum. |
TaskAgentReference
Nama | Jenis | Deskripsi |
---|---|---|
_links |
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 |
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 |
Alasan pembaruan agen ini |
|
requestTime |
string |
Mendapatkan tanggal saat pembaruan agen ini diminta. |
requestedBy |
Identitas yang meminta pembaruan agen |
|
sourceVersion |
Mendapatkan atau mengatur versi agen sumber dari pembaruan agen |
|
targetVersion |
Mendapatkan atau menetapkan versi agen target dari pembaruan agen |
TaskAgentUpdateReason
Nama | Jenis | Deskripsi |
---|---|---|
code |
TaskAgentUpdateReasonType
Nama | Jenis | Deskripsi |
---|---|---|
manual |
string |
|
minAgentVersionRequired |
string |
TaskOrchestrationOwner
Nama | Jenis | Deskripsi |
---|---|---|
_links |
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 |
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk