Deploymentgroups - Update

參考

Service:: Task Agent

API Version:: 5.0-preview.1

更新部署群組。

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

URI 參數

名稱	位於	必要	類型	Description
deploymentGroupId	path	True	integer int32	部署群組的識別碼。
organization	path	True	string	Azure DevOps 組織的名稱。
project	path	True	string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為 '5.0-preview.1'，以使用此版本的 API。

要求本文

名稱	類型	Description
description	string	部署群組的描述。
name	string	部署群組的名稱。

回應

名稱	類型	Description
200 OK	DeploymentGroup	成功的作業

安全性

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

名稱	Description
vso.machinegroup_manage	提供管理部署群組和代理程式組件區的能力

範例

Update a deployment group

Sample Request

HTTP

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

Status code:: 200

{
  "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
  }
}

定義

名稱	Description
Demand
DeploymentGroup	部署群組。
DeploymentGroupUpdateParameter	部署群組更新參數。
DeploymentMachine	部署目標。
IdentityRef
JObject
JToken
PackageVersion
ProjectReference
PropertiesCollection	類別會將屬性包表示為索引鍵/值組的集合。所有基本類型的值都會 (接受任何具有 `TypeCode != TypeCode.Object`) `DBNull` 的型別。 Byte[]、Int32、Double、DateType 和 String 類型的值會保留其類型，其他基本類型則會重新調整為 String。 Byte[] 預期為 base64 編碼字串。
ReferenceLinks	表示 REST 參考連結集合的類別。
TaskAgent
TaskAgentAuthorization	提供使用 OAuth 2.0 驗證流程授權代理程式所需的資料。
TaskAgentCloudRequest
TaskAgentDelaySource
TaskAgentJobRequest
TaskAgentPoolReference
TaskAgentPoolType	取得或設定集區的型別
TaskAgentPublicKey	表示 RSA 非對稱金鑰的公開金鑰部分。
TaskAgentReference
TaskAgentStatus	取得代理程式的目前線上狀態。
TaskAgentUpdate
TaskAgentUpdateReason
TaskAgentUpdateReasonType
TaskOrchestrationOwner
TaskResult

Demand

名稱	類型	Description
name	string
value	string

DeploymentGroup

部署群組。

名稱	類型	Description
description	string	部署群組的描述。
id	integer	部署群組識別碼。
machineCount	integer	部署群組中的部署目標數目。
machineTags	string[]	部署群組中所有部署目標的唯一標記清單。
machines	DeploymentMachine[]	部署群組中的部署目標清單。
name	string	部署群組的名稱。
pool	TaskAgentPoolReference	用來註冊部署代理程式的部署集區。
project	ProjectReference	部署群組所屬的專案。

DeploymentGroupUpdateParameter

部署群組更新參數。

名稱	類型	Description
description	string	部署群組的描述。
name	string	部署群組的名稱。

DeploymentMachine

部署目標。

名稱	類型	Description
agent	TaskAgent	部署代理程式。
id	integer	部署目標識別碼。
tags	string[]	部署目標的標記。

IdentityRef

名稱	類型	Description
_links	ReferenceLinks	此欄位包含有關圖表主旨的零個或多個有趣連結。您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
descriptor	string	描述項是在系統執行時參考圖形主旨的主要方式。此欄位可唯一識別帳戶和組織之間的相同圖表主旨。
directoryAlias	string
displayName	string	這是圖表主旨的非唯一顯示名稱。若要變更此欄位，您必須在來源提供者中變更其值。
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	此 URL 是此圖表主體來源資源的完整路由。

JObject

名稱	類型	Description
item	JToken
type	string

JToken

名稱	類型	Description
first	JToken
hasValues	boolean
item	JToken
last	JToken
next	JToken
parent	string
path	string
previous	JToken
root	JToken
type	string

PackageVersion

名稱	類型	Description
major	integer
minor	integer
patch	integer

ProjectReference

名稱	類型	Description
id	string
name	string

PropertiesCollection

類別會將屬性包表示為索引鍵/值組的集合。所有基本類型的值都會 (接受任何具有 TypeCode != TypeCode.Object) DBNull 的型別。 Byte[]、Int32、Double、DateType 和 String 類型的值會保留其類型，其他基本類型則會重新調整為 String。 Byte[] 預期為 base64 編碼字串。

名稱	類型	Description
count	integer	集合中的屬性計數。
item	object
keys	string[]	集合中的索引鍵集合。
values	string[]	集合中的值集合。

ReferenceLinks

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

TaskAgent

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
accessPoint	string	取得代理程式的存取點。
assignedAgentCloudRequest	TaskAgentCloudRequest	取得目前與此代理程式相關聯的代理程式雲端要求
assignedRequest	TaskAgentJobRequest	取得目前指派給這個代理程式的要求。
authorization	TaskAgentAuthorization	取得或設定這個代理程式的授權資訊。
createdOn	string	取得建立此代理程式的日期。
enabled	boolean	取得或設定值，指出是否應該啟用此代理程式來執行作業。
id	integer	取得代理程式的識別碼。
lastCompletedRequest	TaskAgentJobRequest	取得這個代理程式完成的最後一個要求。
maxParallelism	integer	取得或設定此主機上允許的最大作業平行處理原則。
name	string	取得代理程式的名稱。
oSDescription	string	取得代理程式的 OS。
pendingUpdate	TaskAgentUpdate	取得這個代理程式的擱置更新。
properties	PropertiesCollection	類別會將屬性包表示為索引鍵/值組的集合。所有基本類型的值都會 (接受任何具有 `TypeCode != TypeCode.Object`) `DBNull` 的型別。 Byte[]、Int32、Double、DateType 和 String 類型的值會保留其類型，其他基本類型則會重新調整為 String。 Byte[] 預期為 base64 編碼字串。
provisioningState	string	取得或設定此代理程式的目前布建狀態
status	TaskAgentStatus	取得代理程式的目前線上狀態。
statusChangedOn	string	取得上次發生線上狀態變更的日期。
systemCapabilities	object
userCapabilities	object
version	string	取得代理程式的版本。

TaskAgentAuthorization

提供使用 OAuth 2.0 驗證流程授權代理程式所需的資料。

名稱	類型	Description
authorizationUrl	string	取得或設定用來從已設定權杖服務取得存取權杖的端點。
clientId	string	取得或設定這個代理程式的用戶端識別碼。
publicKey	TaskAgentPublicKey	取得或設定用來驗證此代理程式的身分識別的公開金鑰。

TaskAgentCloudRequest

名稱	類型	Description
agent	TaskAgentReference
agentCloudId	integer
agentConnectedTime	string
agentData	JObject
agentSpecification	JObject
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentDelaySource

名稱	類型	Description
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

名稱	類型	Description
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

名稱	類型	Description
id	integer
isHosted	boolean	取得或設定值，指出此集區是否由服務管理。
name	string
poolType	TaskAgentPoolType	取得或設定集區的型別
scope	string
size	integer	取得集區的目前大小。

TaskAgentPoolType

取得或設定集區的型別

名稱	類型	Description
automation	string
deployment	string

TaskAgentPublicKey

表示 RSA 非對稱金鑰的公開金鑰部分。

名稱	類型	Description
exponent	string[]	取得或設定公開金鑰的指數。
modulus	string[]	取得或設定公開金鑰的模數。

TaskAgentReference

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
accessPoint	string	取得代理程式的存取點。
enabled	boolean	取得或設定值，指出是否應該啟用此代理程式來執行作業。
id	integer	取得代理程式的識別碼。
name	string	取得代理程式的名稱。
oSDescription	string	取得代理程式的 OS。
provisioningState	string	取得或設定此代理程式的目前布建狀態
status	TaskAgentStatus	取得代理程式的目前線上狀態。
version	string	取得代理程式的版本。

TaskAgentStatus

取得代理程式的目前線上狀態。

名稱	類型	Description
offline	string
online	string

TaskAgentUpdate

名稱	類型	Description
currentState	string	此代理程式更新的目前狀態
reason	TaskAgentUpdateReason	此代理程式更新的原因
requestTime	string	取得要求此代理程式更新的日期。
requestedBy	IdentityRef	要求代理程式更新的身分識別
sourceVersion	PackageVersion	取得或設定代理程式更新的來源代理程式版本
targetVersion	PackageVersion	取得或設定代理程式更新的目標代理程式版本

TaskAgentUpdateReason

名稱	類型	Description
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

名稱	類型	Description
manual	string
minAgentVersionRequired	string

TaskOrchestrationOwner

名稱	類型	Description
_links	ReferenceLinks	表示 REST 參考連結集合的類別。
id	integer
name	string

TaskResult

名稱	類型	Description
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string

共用方式為