Targets - Get

リファレンス

サービス:: Distributed Task

API バージョン:: 7.1

デプロイグループ内の ID でデプロイターゲットを取得する

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets/{targetId}?api-version=7.1

省略可能なパラメーターを含む:

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}/targets/{targetId}?$expand={$expand}&api-version=7.1

URI パラメーター

名前	/	必須	型	説明
deploymentGroupId	path	True	integer (int32)	デプロイターゲットが属するデプロイグループの ID。
organization	path	True	string	Azure DevOps 組織の名前。
project	path	True	string	プロジェクト ID またはプロジェクト名
targetId	path	True	integer (int32)	返されるデプロイターゲットの ID。
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.1' に設定する必要があります。
$expand	query		DeploymentTargetExpands	返されるオブジェクトに、これらの追加の詳細を含めます。

応答

名前	型	説明
200 OK	DeploymentMachine	成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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

スコープ

名前	説明
vso.machinegroup_manage	デプロイグループとエージェントプールを管理する機能を提供します

例

Get a deployment target by its ID

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "tags": [
    "web"
  ],
  "id": 5,
  "agent": {
    "_links": {
      "self": {
        "href": "https://dev.azure.com/fabrikam/_apis/distributedtask/pools/17/agents/5"
      },
      "web": {
        "href": "https://dev.azure.com/fabrikam/_admin/_AgentPool#_a=agents&poolId=17&agentId=5"
      }
    },
    "maxParallelism": 1,
    "createdOn": "2018-02-19T09:19:41.053Z",
    "authorization": {
      "clientId": "0f386203-17f5-45a6-8c72-d35b54011fe3",
      "publicKey": {
        "exponent": "AQAB",
        "modulus": "6O7UGxhRniv3tmXJ/1kaEkZdbcNQabJBJxj3EhPNsBJuduYZt3OixVTI/X5r1C2ogAr0nQon2UP3HKNQ9bkY7fNAY8VfggOTytu4ZfFcTJABvc5X8pHefWfO2DVqOUJH6HpyOtP5C+b2OGuhzTlEJHv6FrJPWxbK1HEo0w6VQg4CI8VqyCY9pvT6ZTrZTSg1Hp4uGF/kDHtUk0GvYWA2hZJyk/VbX7hH1PhwpRHuIEUsT0TcJzrR+7n0gdLDGeNLYqBMmTXIMm6jv7pUdnOumI9FK9hChw3JbP44jVxlxGbV8kh+IKAX/S3+pdkCNOiKzkXIDtUu/3vWiqx6+v8mIQ=="
      }
    },
    "id": 5,
    "name": "demoTarget1",
    "version": "2.127.0",
    "osDescription": "Microsoft Windows 10.0.14393 ",
    "enabled": true,
    "status": "online"
  }
}

定義

名前	説明
Demand
DeploymentMachine	デプロイターゲット。
DeploymentTargetExpands	返されるオブジェクトに、これらの追加の詳細を含めます。
IdentityRef
JObject	JSON オブジェクトを表します。
JToken	抽象 JSON トークンを表します。
PackageVersion
PropertiesCollection	このクラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。 `DBNull` を除くすべてのプリミティブ型 (`TypeCode != TypeCode.Object`を持つ任意の型) の値が受け入れられます。 Byte[]、Int32、Double、DateType、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

Object

名前	型	説明
name	string
value	string

DeploymentMachine

Object

デプロイターゲット。

名前	型	説明
agent	TaskAgent	デプロイエージェント。
id	integer (int32)	デプロイターゲット識別子。
properties	PropertiesCollection	デプロイターゲットのプロパティ。
tags	string[]	デプロイターゲットのタグ。

DeploymentTargetExpands

列挙

返されるオブジェクトに、これらの追加の詳細を含めます。

値	説明
assignedRequest	デプロイエージェントに割り当てられたジョブ要求を含めます。
capabilities	デプロイエージェントの機能を含めます。
lastCompletedRequest	デプロイエージェントの最後に完了したジョブ要求を含めます。
none	追加のプロパティはありません。

IdentityRef

Object

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する興味深いリンクが 0 個以上含まれています。これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップや詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	非推奨 - IdentityRef "_links" ディクショナリの "自己" エントリで参照されている Graph ユーザーにクエリを実行することで取得できます
displayName	string	これは、グラフの件名の一意でない表示名です。このフィールドを変更するには、ソースプロバイダーでその値を変更する必要があります。
id	string
imageUrl	string	非推奨 - IdentityRef "_links" ディクショナリの "アバター" エントリで使用できます
inactive	boolean	非推奨 - GraphUser "_links" ディクショナリの "membershipState" エントリで参照されている Graph メンバーシップの状態を照会することで取得できます
isAadIdentity	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) から推論できます
isContainer	boolean	非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます
isDeletedInOrigin	boolean
profileUrl	string	非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません
uniqueName	string	非推奨 - 代わりに Domain+PrincipalName を使用する
url	string	この URL は、このグラフの件名のソースリソースへの完全なルートです。

JObject

Object

JSON オブジェクトを表します。

名前	型	説明
item	JToken	抽象 JSON トークンを表します。
type	string (JTokenType)	この JToken のノードの種類を取得します。

JToken

Object

抽象 JSON トークンを表します。

名前	型	説明
first	JToken	このトークンの最初の子トークンを取得します。
hasValues	boolean	このトークンに子トークンがあるかどうかを示す値を取得します。
item	JToken	抽象 JSON トークンを表します。
last	JToken	このトークンの最後の子トークンを取得します。
next	JToken	このノードの次の兄弟トークンを取得します。
parent	string (JContainer)	親を取得または設定します。
path	string	JSON トークンのパスを取得します。
previous	JToken	このノードの前の兄弟トークンを取得します。
root	JToken	この JToken のルート JToken を取得します。
type	string (JTokenType)	この JToken のノードの種類を取得します。

PackageVersion

Object

名前	型	説明
major	integer (int32)
minor	integer (int32)
patch	integer (int32)

PropertiesCollection

Object

このクラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。 DBNull を除くすべてのプリミティブ型 (TypeCode != TypeCode.Objectを持つ任意の型) の値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは文字列として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。

名前	型	説明
count	integer (int32)	コレクション内のプロパティの数。
item	object
keys	string[]	コレクション内のキーのセット。
values	string[]	コレクション内の値のセット。

ReferenceLinks

Object

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取りビュー。参照リンクは読み取り専用であるため、読み取り専用として公開する必要があります。

TaskAgent

Object

タスクエージェント。

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
accessPoint	string	このエージェントのアクセスポイント。
assignedAgentCloudRequest	TaskAgentCloudRequest	このエージェントに現在関連付けられているエージェントクラウド要求。
assignedRequest	TaskAgentJobRequest	このエージェントに現在割り当てられている要求。
authorization	TaskAgentAuthorization	このエージェントの認証情報。
createdOn	string (date-time)	このエージェントが作成された日付。
enabled	boolean	このエージェントがジョブを実行する必要があるかどうか。
id	integer (int32)	エージェントの識別子。
lastCompletedRequest	TaskAgentJobRequest	このエージェントによって完了された最後の要求。
maxParallelism	integer (int32)	このエージェントで許容される最大ジョブ並列処理。
name	string	エージェントの名前。
osDescription	string	エージェント OS。
pendingUpdate	TaskAgentUpdate	このエージェントの更新が保留中です。
properties	PropertiesCollection	このクラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。 `DBNull` を除くすべてのプリミティブ型 (`TypeCode != TypeCode.Object`を持つ任意の型) の値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは文字列として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
provisioningState	string	このエージェントのプロビジョニング状態。
status	TaskAgentStatus	エージェントがオンラインかどうか。
statusChangedOn	string (date-time)	最後の接続状態の変更が発生した日付。
systemCapabilities	object	このエージェントのホストでサポートされているシステム定義の機能。警告: PUT メソッドを使用して機能を設定するには、PUT によって既存の機能が完全に上書きされます。
userCapabilities	object	このエージェントのホストでサポートされているユーザー定義機能。警告: PUT メソッドを使用して機能を設定するには、PUT によって既存の機能が完全に上書きされます。
version	string	エージェントのバージョン。

TaskAgentAuthorization

Object

OAuth 2.0 認証フローを使用してエージェントを承認するために必要なデータを提供します。

名前	型	説明
authorizationUrl	string	構成されたトークンサービスからアクセストークンを取得するために使用されるエンドポイント。
clientId	string (uuid)	このエージェントのクライアント識別子。
publicKey	TaskAgentPublicKey	このエージェントの ID を確認するために使用される公開キー。

TaskAgentCloudRequest

Object

名前	型	説明
agent	TaskAgentReference	エージェントへの参照。
agentCloudId	integer (int32)
agentConnectedTime	string (date-time)
agentData	JObject	JSON オブジェクトを表します。
agentSpecification	JObject	JSON オブジェクトを表します。
pool	TaskAgentPoolReference
provisionRequestTime	string (date-time)
provisionedTime	string (date-time)
releaseRequestTime	string (date-time)
requestId	string (uuid)

TaskAgentJobRequest

Object

エージェントのジョブ要求。

名前	型	説明
agentSpecification	JObject	JSON オブジェクトを表します。
assignTime	string (date-time)	この要求が割り当てられた日付/時刻。
data	object	要求に関する追加データ。
definition	TaskOrchestrationOwner	この要求に関連付けられているパイプライン定義
demands	Demand[]	この要求を満たすために必要な要求の一覧。
finishTime	string (date-time)	この要求が完了した日付/時刻。
hostId	string (uuid)	この要求をトリガーしたホスト。
jobId	string (uuid)	この要求の結果として得られるジョブの ID。
jobName	string	この要求の結果として得られるジョブの名前。
lockedUntil	string (date-time)	エージェントがロックを更新する期限。
matchedAgents	TaskAgentReference[]	エージェントへの参照。
matchesAllAgentsInPool	boolean
orchestrationId	string
owner	TaskOrchestrationOwner	この要求に関連付けられているパイプライン
planGroup	string
planId	string (uuid)	この要求に接続されているオーケストレーション計画の内部 ID。
planType	string	オーケストレーション計画の種類を表す内部詳細。
poolId	integer (int32)	この要求が対象とするプールの ID
priority	integer (int32)
queueId	integer (int32)	この要求が対象とするキューの ID
queueTime	string (date-time)	この要求がキューに登録された日付/時刻。
receiveTime	string (date-time)	この要求がエージェントによって再要求された日付/時刻。
requestId	integer (int64)	要求の ID。
reservedAgent	TaskAgentReference	この要求に割り当てられたエージェント。
result	TaskResult	この要求の結果。
scopeId	string (uuid)	パイプラインのスコープ。はプロジェクト ID と一致します。
serviceOwner	string (uuid)	この要求を所有するサービス。
statusMessage	string
userDelayed	boolean

TaskAgentPoolOptions

列挙

追加のプールの設定と詳細

値	説明
elasticPool	エラスティックプールサービスによってサポートされる TaskAgentPool
none
preserveAgentOnJobFailure	TaskAgentJobRequest エラーの後にエージェントが調査のために保持されている場合は true に設定します
singleUseAgents	各 TaskAgentJobRequest の後にエージェントを再イメージ化する場合は true に設定します

TaskAgentPoolReference

Object

名前	型	説明
id	integer (int32)
isHosted	boolean	このプールがサービスによって管理されているかどうかを示す値を取得または設定します。
isLegacy	boolean	プールがレガシであるかどうかを判断します。
name	string
options	TaskAgentPoolOptions	追加のプールの設定と詳細
poolType	TaskAgentPoolType	プールの種類を取得または設定します。
scope	string (uuid)
size	integer (int32)	プールの現在のサイズを取得します。

TaskAgentPoolType

列挙

プールの種類を取得または設定します。

値	説明
automation	タスクエージェントの一般的なプール
deployment	デプロイプール

TaskAgentPublicKey

Object

RSA 非対称キーの公開キー部分を表します。

名前	型	説明
exponent	string[] (byte)	公開キーの指数を取得または設定します。
modulus	string[] (byte)	公開キーの剰余を取得または設定します。

TaskAgentReference

Object

エージェントへの参照。

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
accessPoint	string	このエージェントのアクセスポイント。
enabled	boolean	このエージェントがジョブを実行する必要があるかどうか。
id	integer (int32)	エージェントの識別子。
name	string	エージェントの名前。
osDescription	string	エージェント OS。
provisioningState	string	このエージェントのプロビジョニング状態。
status	TaskAgentStatus	エージェントがオンラインかどうか。
version	string	エージェントのバージョン。

TaskAgentStatus

列挙

エージェントがオンラインかどうか。

値	説明
offline
online

TaskAgentUpdate

Object

エージェントの更新に関する詳細。

名前	型	説明
currentState	string	このエージェント更新プログラムの現在の状態。
reason	TaskAgentUpdateReason	この更新プログラムの理由。
requestTime	string (date-time)	この更新プログラムが要求された日付。
requestedBy	IdentityRef	この更新プログラムを要求した ID。
sourceVersion	PackageVersion	更新プログラムのソースエージェントバージョン。
targetVersion	PackageVersion	更新プログラムのターゲットエージェントバージョン。

TaskAgentUpdateReason

Object

名前	型	説明
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

列挙

値	説明
downgrade
manual
minAgentVersionRequired

TaskOrchestrationOwner

Object

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
id	integer (int32)
name	string

TaskResult

列挙

この要求の結果。

値	説明
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues