Targets - Update

參考

Service:: Distributed Task

API Version:: 7.1-preview.1

更新部署群組中部署目標清單的標記。

PATCH https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets?api-version=7.1-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 版本。這應該設定為 '7.1-preview.1' 以使用此版本的 API。

要求本文

名稱	類型	Description
body	DeploymentTargetUpdateParameter[]	部署目標，其中包含要 udpdate 的標籤。

回應

名稱	類型	Description
200 OK	DeploymentMachine[]	成功作業

安全性

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 tags of a deployment target

Sample Request

HTTP

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

[
  {
    "tags": [
      "db",
      "web",
      "newTag5248232320667898861"
    ],
    "id": 7
  },
  {
    "tags": [
      "db",
      "newTag5248232320667898861"
    ],
    "id": 6
  }
]

Sample Response

Status code:: 200

{
  "count": 2,
  "value": [
    {
      "tags": [
        "db",
        "newTag5248232320667898861"
      ],
      "id": 6,
      "agent": {
        "_links": {
          "self": {
            "href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/6"
          },
          "web": {
            "href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=6"
          }
        },
        "maxParallelism": 1,
        "createdOn": "2018-02-19T09:23:58.267Z",
        "id": 6,
        "name": "demoTarget2",
        "version": "2.127.0",
        "osDescription": "Microsoft Windows 10.0.14393 ",
        "enabled": true,
        "status": "offline"
      }
    },
    {
      "tags": [
        "db",
        "newTag5248232320667898861",
        "web"
      ],
      "id": 7,
      "agent": {
        "_links": {
          "self": {
            "href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/7"
          },
          "web": {
            "href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=7"
          }
        },
        "maxParallelism": 1,
        "createdOn": "2018-02-19T09:26:48.11Z",
        "id": 7,
        "name": "demoTarget11",
        "version": "2.127.0",
        "osDescription": "Microsoft Windows 10.0.14393 ",
        "enabled": true,
        "status": "offline"
      }
    }
  ]
}

定義

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

Demand

名稱	類型	Description
name	string
value	string

DeploymentMachine

部署目標。

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

DeploymentTargetUpdateParameter

部署目標更新參數。

名稱	類型	Description
id	integer	部署目標的識別碼。
tags	string[]

IdentityRef

名稱	類型	Description
_links	ReferenceLinks	此欄位包含圖表主旨的相關零或更多有趣連結。您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
descriptor	string	描述項是在系統執行時參考圖形主旨的主要方式。此欄位可唯一識別帳戶和組織之間的相同圖表主旨。
directoryAlias	string	已被取代 - 您可以藉由查詢 IdentityRef 「_links」字典的「self」專案中參考的 Graph 使用者來擷取
displayName	string	這是圖形主體的非唯一顯示名稱。若要變更此欄位，您必須變更來源提供者中的值。
id	string
imageUrl	string	已淘汰 - 可在 IdentityRef 「_links」字典的「avatar」專案中使用
inactive	boolean	已被取代 - 您可以藉由查詢 GraphUser 「_links」字典的「membershipState」專案中所參考的 Graph 成員資格狀態來擷取
isAadIdentity	boolean	已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已被取代 - 不在 ToIdentityRef 的大部分預先存在實作中使用
uniqueName	string	已被取代 - 請改用 Domain+PrincipalName
url	string	此 URL 是此圖形主體來源資源的完整路由。

JObject

表示 JSON 物件。

名稱	類型	Description
item	JToken	表示抽象 JSON 權杖。
type	string	取得這個 JToken 的節點類型。

JToken

表示抽象 JSON 權杖。

名稱	類型	Description
first	JToken	取得此權杖的第一個子權杖。
hasValues	boolean	取得值，指出這個權杖是否有子權杖。
item	JToken	表示抽象 JSON 權杖。
last	JToken	取得這個權杖的最後一個子權杖。
next	JToken	取得這個節點的下一個同層級權杖。
parent	string	取得或設定父系。
path	string	取得 JSON 權杖的路徑。
previous	JToken	取得這個節點的上一個同層級權杖。
root	JToken	取得這個 JToken 的根 JToken。
type	string	取得這個 JToken 的節點類型。

PackageVersion

名稱	類型	Description
major	integer
minor	integer
patch	integer

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	此代理程式主機所支援的系統定義功能。警告：若要設定功能，請使用 PUT 方法，PUT 將會完全覆寫現有的功能。
userCapabilities	object	此代理程式主機所支援的使用者定義功能。警告：若要設定功能，請使用 PUT 方法，PUT 將會完全覆寫現有的功能。
version	string	代理程式版本。

TaskAgentAuthorization

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

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

TaskAgentCloudRequest

名稱	類型	Description
agent	TaskAgentReference	代理程式的參考。
agentCloudId	integer
agentConnectedTime	string
agentData	JObject	表示 JSON 物件。
agentSpecification	JObject	表示 JSON 物件。
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentJobRequest

代理程式的作業要求。

名稱	類型	Description
agentSpecification	JObject	表示 JSON 物件。
assignTime	string	指派此要求的日期/時間。
data	object	關於要求的其他資料。
definition	TaskOrchestrationOwner	與此要求相關聯的管線定義
demands	Demand[]	滿足此要求所需的要求清單。
finishTime	string	完成此要求的日期/時間。
hostId	string	觸發此要求的主機。
jobId	string	此要求所產生的作業識別碼。
jobName	string	此要求所產生的作業名稱。
lockedUntil	string	代理程式更新鎖定的期限。
matchedAgents	TaskAgentReference[]	代理程式的參考。
matchesAllAgentsInPool	boolean
orchestrationId	string
owner	TaskOrchestrationOwner	與此要求相關聯的管線
planGroup	string
planId	string	與此要求連線之協調流程計畫的內部識別碼。
planType	string	代表協調流程計畫類型的內部詳細資料。
poolId	integer	此要求目標集區的識別碼
priority	integer
queueId	integer	此要求目標之佇列的識別碼
queueTime	string	此要求的排入佇列的日期/時間。
receiveTime	string	代理程式已修正此要求的日期/時間。
requestId	integer	要求的識別碼。
reservedAgent	TaskAgentReference	配置給這個要求的代理程式。
result	TaskResult	此要求的結果。
scopeId	string	管線的範圍;符合專案識別碼。
serviceOwner	string	擁有此要求的服務。
statusMessage	string
userDelayed	boolean

TaskAgentPoolOptions

其他集區設定和詳細資料

名稱	類型	Description
elasticPool	string	彈性集區服務支援的 TaskAgentPool
none	string
preserveAgentOnJobFailure	string	如果代理程式在 TaskAgentJobRequest 失敗之後保留調查，請將設定為 true
singleUseAgents	string	如果代理程式在每個 TaskAgentJobRequest 之後重新製作映射，請將設定為 true

TaskAgentPoolReference

名稱	類型	Description
id	integer
isHosted	boolean	取得或設定值，指出此集區是否由服務管理。
isLegacy	boolean	判斷集區是否為舊版。
name	string
options	TaskAgentPoolOptions	其他集區設定和詳細資料
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
downgrade	string
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

共用方式為