Deploymentgroups - Update
Dağıtım grubunu güncelleştirme.
PATCH https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=5.0-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 '5.0-preview.1' olarak ayarlanmalıdır. |
İstek Gövdesi
Name | Tür | Description |
---|---|---|
description |
string |
Dağıtım grubunun açıklaması. |
name |
string |
Dağıtım grubunun adı. |
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
Update a deployment group
Sample Request
PATCH https://dev.azure.com/fabrikam/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=5.0-preview.1
{
"name": "MyDeploymentGroup1-Update1",
"description": "Description of this deployment group is updated"
}
Sample Response
{
"machineCount": 0,
"description": "Description of this deployment group is updated",
"id": 11,
"project": {
"id": "91879ed9-819b-46f3-9e0b-52ed4b20c04c",
"name": "DeploymentGroupRESTSample"
},
"name": "MyDeploymentGroup1-Update1",
"pool": {
"id": 6,
"isHosted": false,
"poolType": "deployment",
"size": 0
}
}
Tanımlar
Name | Description |
---|---|
Demand | |
Deployment |
Dağıtım grubu. |
Deployment |
Dağıtım grubu güncelleştirme parametresi. |
Deployment |
Dağıtım hedefi. |
Identity |
|
JObject | |
JToken | |
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 |
|
Task |
OAuth 2.0 kimlik doğrulama akışlarını kullanarak aracıyı yetkilendirmek için gereken verileri sağlar. |
Task |
|
Task |
|
Task |
|
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 |
|
Task |
Aracının geçerli bağlantı durumunu alır. |
Task |
|
Task |
|
Task |
|
Task |
|
Task |
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 kaydedildiği dağıtım havuzu. |
|
project |
Dağıtım grubunun ait olduğu proje. |
DeploymentGroupUpdateParameter
Dağıtım grubu güncelleştirme parametresi.
Name | Tür | Description |
---|---|---|
description |
string |
Dağıtım grubunun açıklaması. |
name |
string |
Dağıtım grubunun adı. |
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ı. |
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 |
|
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 |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
url |
string |
Bu URL, bu grafik konusunun kaynak kaynağına giden tam yoldur. |
JObject
Name | Tür | Description |
---|---|---|
item | ||
type |
string |
JToken
Name | Tür | Description |
---|---|---|
first | ||
hasValues |
boolean |
|
item | ||
last | ||
next | ||
parent |
string |
|
path |
string |
|
previous | ||
root | ||
type |
string |
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 retuned edilir. Byte[] base64 kodlanmış dize 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
Name | Tür | Description |
---|---|---|
_links |
REST başvuru bağlantıları koleksiyonunu temsil eden sınıf. |
|
accessPoint |
string |
Aracının erişim noktasını alır. |
assignedAgentCloudRequest |
Şu anda bu aracıyla ilişkilendirilmiş Olan Aracı Bulut İsteğini alır |
|
assignedRequest |
Şu anda bu aracıya atanmış olan isteği alır. |
|
authorization |
Bu aracı için yetkilendirme bilgilerini alır veya ayarlar. |
|
createdOn |
string |
Bu aracının oluşturulduğu tarihi alır. |
enabled |
boolean |
Bu aracının iş yürütme için etkinleştirilmesi gerekip gerekmediğini belirten bir değer alır veya ayarlar. |
id |
integer |
Aracının tanımlayıcısını alır. |
lastCompletedRequest |
Bu aracı tarafından tamamlanan son isteği alır. |
|
maxParallelism |
integer |
Bu konakta izin verilen iş paralelliği üst sınırını alır veya ayarlar. |
name |
string |
Aracının adını alır. |
oSDescription |
string |
Aracının işletim sistemini alır. |
pendingUpdate |
Bu aracı için bekleyen güncelleştirmeyi alır. |
|
properties |
sınıfı, anahtar-değer çiftleri koleksiyonu olarak bir özellik çantasını temsil eder. Dışındaki |
|
provisioningState |
string |
Bu aracının geçerli sağlama durumunu alır veya ayarlar |
status |
Aracının geçerli bağlantı durumunu alır. |
|
statusChangedOn |
string |
Son bağlantı durumu değişikliğinin gerçekleştiği tarihi alır. |
systemCapabilities |
object |
|
userCapabilities |
object |
|
version |
string |
Aracının sürümünü alır. |
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ç noktayı alır veya ayarlar. |
clientId |
string |
Bu aracı için istemci tanımlayıcısını alır veya ayarlar. |
publicKey |
Bu aracının kimliğini doğrulamak için kullanılan ortak anahtarı alır veya ayarlar. |
TaskAgentCloudRequest
Name | Tür | Description |
---|---|---|
agent | ||
agentCloudId |
integer |
|
agentConnectedTime |
string |
|
agentData | ||
agentSpecification | ||
pool | ||
provisionRequestTime |
string |
|
provisionedTime |
string |
|
releaseRequestTime |
string |
|
requestId |
string |
TaskAgentDelaySource
Name | Tür | Description |
---|---|---|
delays |
string[] |
|
taskAgent |
TaskAgentJobRequest
Name | Tür | Description |
---|---|---|
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
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. |
name |
string |
|
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 |
|
deployment |
string |
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
Name | Tür | Description |
---|---|---|
_links |
REST başvuru bağlantıları koleksiyonunu temsil eden sınıf. |
|
accessPoint |
string |
Aracının erişim noktasını alır. |
enabled |
boolean |
Bu aracının iş yürütme için etkinleştirilmesi gerekip gerekmediğini belirten bir değer alır veya ayarlar. |
id |
integer |
Aracının tanımlayıcısını alır. |
name |
string |
Aracının adını alır. |
oSDescription |
string |
Aracının işletim sistemini alır. |
provisioningState |
string |
Bu aracının geçerli sağlama durumunu alır veya ayarlar |
status |
Aracının geçerli bağlantı durumunu alır. |
|
version |
string |
Aracının sürümünü alır. |
TaskAgentStatus
Aracının geçerli bağlantı durumunu alır.
Name | Tür | Description |
---|---|---|
offline |
string |
|
online |
string |
TaskAgentUpdate
Name | Tür | Description |
---|---|---|
currentState |
string |
Bu aracı güncelleştirmesinin geçerli durumu |
reason |
Bu aracı güncelleştirmesinin nedeni |
|
requestTime |
string |
Bu aracı güncelleştirmesinin istendiği tarihi alır. |
requestedBy |
Aracı güncelleştirmesini isteyen kimlik |
|
sourceVersion |
Aracı güncelleştirmesinin kaynak aracı sürümünü alır veya ayarlar |
|
targetVersion |
Aracı güncelleştirmesinin hedef aracı sürümünü alır veya ayarlar |
TaskAgentUpdateReason
Name | Tür | Description |
---|---|---|
code |
TaskAgentUpdateReasonType
Name | Tür | Description |
---|---|---|
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
Name | Tür | Description |
---|---|---|
abandoned |
string |
|
canceled |
string |
|
failed |
string |
|
skipped |
string |
|
succeeded |
string |
|
succeededWithIssues |
string |