Deploymentgroups - Get
Kimliğine göre bir dağıtım grubu alın.
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?actionFilter={actionFilter}&$expand={$expand}&api-version=7.1-preview.1
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
deployment
|
path | True |
integer int32 |
Dağıtım grubunun kimliği. |
organization
|
path | True |
string |
Azure DevOps kuruluşunun adı. |
project
|
path | True |
string |
Proje Kimliği veya proje adı |
api-version
|
query | True |
string |
Kullanılacak API sürümü. Api'nin bu sürümünü kullanmak için bu değer '7.1-preview.1' olarak ayarlanmalıdır. |
$expand
|
query |
Döndürülen nesneye bu ek ayrıntıları ekleyin. |
||
action
|
query |
Dağıtım grubunu yalnızca bu eylem üzerinde gerçekleştirilebiliyorsa alın. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
başarılı işlem |
Güvenlik
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
Name | Description |
---|---|
vso.machinegroup_manage | Dağıtım grubunu ve aracı havuzlarını yönetme olanağı sağlar |
Örnekler
Get a deployment group by its ID
Sample Request
GET https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=7.1-preview.1
Sample Response
{
"machines": [],
"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
}
}
Tanımlar
Name | Description |
---|---|
Demand | |
Deployment |
Dağıtım grubu. |
Deployment |
Dağıtım grubunu yalnızca bu eylem üzerinde gerçekleştirilebiliyorsa alın. |
Deployment |
Döndürülen nesneye bu ek ayrıntıları ekleyin. |
Deployment |
Dağıtım hedefi. |
Identity |
|
JObject |
JSON nesnesini temsil eder. |
JToken |
Soyut bir JSON belirtecini temsil eder. |
Package |
|
Project |
|
Properties |
sınıfı, anahtar-değer çiftleri koleksiyonu olarak bir özellik çantasını temsil eder. Dışındaki |
Reference |
REST başvuru bağlantıları koleksiyonunu temsil eden sınıf. |
Task |
Görev aracısı. |
Task |
OAuth 2.0 kimlik doğrulama akışlarını kullanarak aracıyı yetkilendirmek için gereken verileri sağlar. |
Task |
|
Task |
Bir aracı için iş isteği. |
Task |
Ek havuz ayarları ve ayrıntıları |
Task |
|
Task |
Havuzun türünü alır veya ayarlar |
Task |
RSA asimetrik anahtarının ortak anahtar bölümünü temsil eder. |
Task |
Bir aracıya başvuru. |
Task |
Aracının çevrimiçi olup olmadığı. |
Task |
Aracı güncelleştirmesinin ayrıntıları. |
Task |
|
Task |
|
Task |
|
Task |
Bu isteğin sonucu. |
Demand
Name | Tür | Description |
---|---|---|
name |
string |
|
value |
string |
DeploymentGroup
Dağıtım grubu.
Name | Tür | Description |
---|---|---|
description |
string |
Dağıtım grubunun açıklaması. |
id |
integer |
Dağıtım grubu tanımlayıcısı. |
machineCount |
integer |
Dağıtım grubundaki dağıtım hedefi sayısı. |
machineTags |
string[] |
Dağıtım grubundaki tüm dağıtım hedeflerindeki benzersiz etiketlerin listesi. |
machines |
Dağıtım grubundaki dağıtım hedeflerinin listesi. |
|
name |
string |
Dağıtım grubunun adı. |
pool |
Dağıtım aracılarının kayıtlı olduğu dağıtım havuzu. |
|
project |
Dağıtım grubunun ait olduğu proje. |
DeploymentGroupActionFilter
Dağıtım grubunu yalnızca bu eylem üzerinde gerçekleştirilebiliyorsa alın.
Name | Tür | Description |
---|---|---|
manage |
string |
Yalnızca çağıranın yönetme iznine sahip olduğu dağıtım grupları. |
none |
string |
Tüm dağıtım grupları. |
use |
string |
Yalnızca çağıranın kullanım iznine sahip olduğu dağıtım grupları. |
DeploymentGroupExpands
Döndürülen nesneye bu ek ayrıntıları ekleyin.
Name | Tür | Description |
---|---|---|
machines |
string |
Kullanım dışı: Tüm dağıtım hedeflerini ekleyin. |
none |
string |
Ek özellik yok. |
tags |
string |
Tüm dağıtım hedeflerindeki etiketlerin benzersiz listesini ekleyin. |
DeploymentMachine
Dağıtım hedefi.
Name | Tür | Description |
---|---|---|
agent |
Dağıtım aracısı. |
|
id |
integer |
Dağıtım hedefi Tanımlayıcısı. |
properties |
Dağıtım hedefinin özellikleri. |
|
tags |
string[] |
Dağıtım hedefinin etiketleri. |
IdentityRef
Name | Tür | Description |
---|---|---|
_links |
Bu alan, grafik konusu hakkında sıfır veya daha fazla ilgi çekici bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında daha fazla ilişki veya daha ayrıntılı bilgi edinmek için çağrılabilir. |
|
descriptor |
string |
Tanımlayıcı, sistem çalışırken graf konusuna başvurmanın birincil yoludur. Bu alan, hem Hesaplar hem de Kuruluşlar genelinde aynı graf konusunu benzersiz olarak tanımlar. |
directoryAlias |
string |
Kullanım dışı - IdentityRef "_links" sözlüğündeki "self" girişinde başvuruda bulunılan Graph kullanıcısı sorgulanarak alınabilir |
displayName |
string |
Bu, grafik konusunun benzersiz olmayan görünen adıdır. Bu alanı değiştirmek için kaynak sağlayıcıdaki değerini değiştirmeniz gerekir. |
id |
string |
|
imageUrl |
string |
Kullanım dışı - IdentityRef "_links" sözlüğün "avatar" girişinde kullanılabilir |
inactive |
boolean |
Kullanım dışı - GraphUser "_links" sözlüğün "membershipState" girişinde başvurulan Graph üyelik durumu sorgulanarak alınabilir |
isAadIdentity |
boolean |
Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Kullanım dışı - ToIdentityRef'in önceden var olan uygulamalarının çoğunda kullanımda değil |
uniqueName |
string |
Kullanım dışı - bunun yerine Domain+PrincipalName kullanın |
url |
string |
Bu URL, bu grafik konusunun kaynak kaynağına giden tam yoldur. |
JObject
JSON nesnesini temsil eder.
Name | Tür | Description |
---|---|---|
item |
Soyut bir JSON belirtecini temsil eder. |
|
type |
string |
Bu JToken için düğüm türünü alır. |
JToken
Soyut bir JSON belirtecini temsil eder.
Name | Tür | Description |
---|---|---|
first |
Bu belirtecin ilk alt belirtecini alın. |
|
hasValues |
boolean |
Bu belirtecin alt belirteçleri olup olmadığını belirten bir değer alır. |
item |
Soyut bir JSON belirtecini temsil eder. |
|
last |
Bu belirtecin son alt belirtecini alın. |
|
next |
Bu düğümün bir sonraki eşdüzey belirtecini alır. |
|
parent |
string |
Üst öğeyi alır veya ayarlar. |
path |
string |
JSON belirtecinin yolunu alır. |
previous |
Bu düğümün önceki eşdüzey belirtecini alır. |
|
root |
Bu JToken'in kök JToken'ini alır. |
|
type |
string |
Bu JToken için düğüm türünü alır. |
PackageVersion
Name | Tür | Description |
---|---|---|
major |
integer |
|
minor |
integer |
|
patch |
integer |
ProjectReference
Name | Tür | Description |
---|---|---|
id |
string |
|
name |
string |
PropertiesCollection
sınıfı, anahtar-değer çiftleri koleksiyonu olarak bir özellik çantasını temsil eder. Dışındaki DBNull
tüm ilkel türlerin (ile herhangi bir TypeCode != TypeCode.Object
türü) değerleri kabul edilir. Byte[], Int32, Double, DateType ve String türündeki değerler türlerini korur, diğer temel öğeler Dize olarak döndürüler. Byte[] base64 kodlanmış dizesi olarak bekleniyor.
Name | Tür | Description |
---|---|---|
count |
integer |
Koleksiyondaki özelliklerin sayısı. |
item |
object |
|
keys |
string[] |
Koleksiyondaki anahtar kümesi. |
values |
string[] |
Koleksiyondaki değer kümesi. |
ReferenceLinks
REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
Name | Tür | Description |
---|---|---|
links |
object |
Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak göstermek istiyoruz. |
TaskAgent
Görev aracısı.
Name | Tür | Description |
---|---|---|
_links |
REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf. |
|
accessPoint |
string |
Bu aracının erişim noktası. |
assignedAgentCloudRequest |
Şu anda bu aracıyla ilişkili aracı bulut isteği. |
|
assignedRequest |
Şu anda bu aracıya atanmış olan istek. |
|
authorization |
Bu aracı için yetkilendirme bilgileri. |
|
createdOn |
string |
Bu aracının oluşturulduğu tarih. |
enabled |
boolean |
Bu aracının işleri çalıştırıp çalıştırmayacağı. |
id |
integer |
Aracının tanımlayıcısı. |
lastCompletedRequest |
Bu aracı tarafından tamamlanan son istek. |
|
maxParallelism |
integer |
Bu aracı için izin verilen en yüksek iş paralelliği. |
name |
string |
Aracının adı. |
osDescription |
string |
Aracı işletim sistemi. |
pendingUpdate |
Bu aracı için güncelleştirme bekleniyor. |
|
properties |
sınıfı, anahtar-değer çiftleri koleksiyonu olarak bir özellik çantasını temsil eder. Dışındaki |
|
provisioningState |
string |
Bu aracının sağlama durumu. |
status |
Aracının çevrimiçi olup olmadığı. |
|
statusChangedOn |
string |
Son bağlantı durumu değişikliğinin gerçekleştiği tarih. |
systemCapabilities |
object |
Bu aracının konağı tarafından desteklenen sistem tanımlı özellikler. Uyarı: Özellikleri ayarlamak için PUT yöntemini kullanın, PUT var olan özelliklerin üzerine tamamen yazar. |
userCapabilities |
object |
Bu aracının konağı tarafından desteklenen kullanıcı tanımlı özellikler. Uyarı: Özellikleri ayarlamak için PUT yöntemini kullanın, PUT var olan özelliklerin üzerine tamamen yazar. |
version |
string |
Aracı sürümü. |
TaskAgentAuthorization
OAuth 2.0 kimlik doğrulama akışlarını kullanarak aracıyı yetkilendirmek için gereken verileri sağlar.
Name | Tür | Description |
---|---|---|
authorizationUrl |
string |
Yapılandırılan belirteç hizmetinden erişim belirteçleri almak için kullanılan uç nokta. |
clientId |
string |
Bu aracı için istemci tanımlayıcısı. |
publicKey |
Bu aracının kimliğini doğrulamak için kullanılan ortak anahtar. |
TaskAgentCloudRequest
Name | Tür | Description |
---|---|---|
agent |
Bir aracıya başvuru. |
|
agentCloudId |
integer |
|
agentConnectedTime |
string |
|
agentData |
Bir JSON nesnesini temsil eder. |
|
agentSpecification |
Bir JSON nesnesini temsil eder. |
|
pool | ||
provisionRequestTime |
string |
|
provisionedTime |
string |
|
releaseRequestTime |
string |
|
requestId |
string |
TaskAgentJobRequest
Bir aracı için iş isteği.
Name | Tür | Description |
---|---|---|
agentSpecification |
Bir JSON nesnesini temsil eder. |
|
assignTime |
string |
Bu isteğin atandığı tarih/saat. |
data |
object |
İstekle ilgili ek veriler. |
definition |
Bu istekle ilişkili işlem hattı tanımı |
|
demands |
Demand[] |
Bu isteği yerine getirmek için gereken taleplerin listesi. |
finishTime |
string |
Bu isteğin bittiği tarih/saat. |
hostId |
string |
Bu isteği tetikleyen ana bilgisayar. |
jobId |
string |
Bu istekten kaynaklanan işin kimliği. |
jobName |
string |
Bu istekten kaynaklanan işin adı. |
lockedUntil |
string |
Aracının kilidi yenilemesi için son tarih. |
matchedAgents |
Bir aracıya başvuru. |
|
matchesAllAgentsInPool |
boolean |
|
orchestrationId |
string |
|
owner |
Bu istekle ilişkili işlem hattı |
|
planGroup |
string |
|
planId |
string |
Bu istekle bağlantılı düzenleme planının iç kimliği. |
planType |
string |
Düzenleme planının türünü temsil eden iç ayrıntı. |
poolId |
integer |
Bu isteğin hedefle istediği havuzun kimliği |
priority |
integer |
|
queueId |
integer |
Bu isteğin hedefle istediği kuyruğun kimliği |
queueTime |
string |
Bu isteğin kuyruğa alındığı tarih/saat. |
receiveTime |
string |
Bu isteğin bir aracı tarafından alındığı tarih/saat. |
requestId |
integer |
İsteğin kimliği. |
reservedAgent |
Bu istek için ayrılan aracı. |
|
result |
Bu isteğin sonucu. |
|
scopeId |
string |
İşlem hattının kapsamı; proje kimliğiyle eşleşir. |
serviceOwner |
string |
Bu isteğin sahibi olan hizmet. |
statusMessage |
string |
|
userDelayed |
boolean |
TaskAgentPoolOptions
Ek havuz ayarları ve ayrıntıları
Name | Tür | Description |
---|---|---|
elasticPool |
string |
Elastik havuz hizmeti tarafından yedeklenen TaskAgentPool |
none |
string |
|
preserveAgentOnJobFailure |
string |
TaskAgentJobRequest hatasından sonra aracılar araştırma için tutulursa true olarak ayarlayın |
singleUseAgents |
string |
Aracılar her TaskAgentJobRequest sonrasında yeniden görüntüleniyorsa true olarak ayarlayın |
TaskAgentPoolReference
Name | Tür | Description |
---|---|---|
id |
integer |
|
isHosted |
boolean |
Bu havuzun hizmet tarafından yönetilip yönetilmediğini belirten bir değer alır veya ayarlar. |
isLegacy |
boolean |
Havuzun eski olup olmadığını belirler. |
name |
string |
|
options |
Ek havuz ayarları ve ayrıntıları |
|
poolType |
Havuzun türünü alır veya ayarlar |
|
scope |
string |
|
size |
integer |
Havuzun geçerli boyutunu alır. |
TaskAgentPoolType
Havuzun türünü alır veya ayarlar
Name | Tür | Description |
---|---|---|
automation |
string |
Tipik bir görev aracıları havuzu |
deployment |
string |
Dağıtım havuzu |
TaskAgentPublicKey
RSA asimetrik anahtarının ortak anahtar bölümünü temsil eder.
Name | Tür | Description |
---|---|---|
exponent |
string[] |
Ortak anahtar için üssü alır veya ayarlar. |
modulus |
string[] |
Ortak anahtarın modüllerini alır veya ayarlar. |
TaskAgentReference
Bir aracıya başvuru.
Name | Tür | Description |
---|---|---|
_links |
REST başvuru bağlantıları koleksiyonunu temsil eden sınıf. |
|
accessPoint |
string |
Bu aracının erişim noktası. |
enabled |
boolean |
Bu aracının işleri çalıştırıp çalıştırmaması. |
id |
integer |
Aracının tanımlayıcısı. |
name |
string |
Aracının adı. |
osDescription |
string |
Aracı işletim sistemi. |
provisioningState |
string |
Bu aracının sağlama durumu. |
status |
Aracının çevrimiçi olup olmadığı. |
|
version |
string |
Aracı sürümü. |
TaskAgentStatus
Aracının çevrimiçi olup olmadığı.
Name | Tür | Description |
---|---|---|
offline |
string |
|
online |
string |
TaskAgentUpdate
Aracı güncelleştirmesinin ayrıntıları.
Name | Tür | Description |
---|---|---|
currentState |
string |
Bu aracı güncelleştirmesinin geçerli durumu. |
reason |
Bu güncelleştirmenin nedeni. |
|
requestTime |
string |
Bu güncelleştirmenin istendiği tarih. |
requestedBy |
Bu güncelleştirmeyi istenen kimlik. |
|
sourceVersion |
Güncelleştirmenin kaynak aracı sürümü. |
|
targetVersion |
Güncelleştirmenin hedef aracı sürümü. |
TaskAgentUpdateReason
Name | Tür | Description |
---|---|---|
code |
TaskAgentUpdateReasonType
Name | Tür | Description |
---|---|---|
downgrade |
string |
|
manual |
string |
|
minAgentVersionRequired |
string |
TaskOrchestrationOwner
Name | Tür | Description |
---|---|---|
_links |
REST başvuru bağlantıları koleksiyonunu temsil eden sınıf. |
|
id |
integer |
|
name |
string |
TaskResult
Bu isteğin sonucu.
Name | Tür | Description |
---|---|---|
abandoned |
string |
|
canceled |
string |
|
failed |
string |
|
skipped |
string |
|
succeeded |
string |
|
succeededWithIssues |
string |
Geri Bildirim
https://aka.ms/ContentUserFeedback.
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz.Gönderin ve geri bildirimi görüntüleyin