Deploymentgroups - Get

リファレンス

サービス:: Task Agent

API バージョン:: 5.0-preview.1

ID でデプロイグループを取得します。

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

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

GET https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?actionFilter={actionFilter}&$expand={$expand}&api-version=5.0-preview.1

URI パラメーター

名前	/	必須	型	説明
deploymentGroupId	path	True	integer int32	デプロイグループの ID。
organization	path	True	string	Azure DevOps 組織の名前です。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '5.0-preview.1' に設定する必要があります。
$expand	query		DeploymentGroupExpands	返されるオブジェクトにこれらの追加の詳細を含めます。
actionFilter	query		DeploymentGroupActionFilter	このアクションを実行できる場合にのみ、デプロイグループを取得します。

応答

名前	型	説明
200 OK	DeploymentGroup	正常な操作

セキュリティ

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 group by its ID

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

定義

名前	説明
Demand
DeploymentGroup	デプロイグループ。
DeploymentGroupActionFilter	このアクションを実行できる場合にのみ、デプロイグループを取得します。
DeploymentGroupExpands	返されるオブジェクトにこれらの追加の詳細を含めます。
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

Object

名前	型	説明
name	string
value	string

DeploymentGroup

Object

デプロイグループ。

名前	型	説明
description	string	デプロイグループの説明。
id	integer	デプロイグループ識別子。
machineCount	integer	デプロイグループ内のデプロイターゲットの数。
machineTags	string[]	デプロイグループ内のすべてのデプロイターゲットの一意のタグの一覧。
machines	DeploymentMachine[]	デプロイグループ内のデプロイターゲットの一覧。
name	string	デプロイグループの名前。
pool	TaskAgentPoolReference	デプロイエージェントが登録されている展開プール。
project	ProjectReference	配置グループが属するプロジェクト。

DeploymentGroupActionFilter

列挙

このアクションを実行できる場合にのみ、デプロイグループを取得します。

値	説明
manage	呼び出し元が管理アクセス許可を持つデプロイグループのみ。
none	すべてのデプロイグループ。
use	呼び出し元がアクセス許可を使用しているデプロイグループのみ。

DeploymentGroupExpands

列挙

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

値	説明
machines	非推奨: すべてのデプロイターゲットを含めます。
none	追加のプロパティはありません。
tags	すべてのデプロイターゲットにタグの一意の一覧を含めます。

DeploymentMachine

Object

デプロイターゲット。

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

IdentityRef

Object

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。
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

Object

名前	型	説明
item	JToken
type	string

JToken

Object

名前	型	説明
first	JToken
hasValues	boolean
item	JToken
last	JToken
next	JToken
parent	string
path	string
previous	JToken
root	JToken
type	string

PackageVersion

Object

名前	型	説明
major	integer
minor	integer
patch	integer

ProjectReference

Object

名前	型	説明
id	string
name	string

PropertiesCollection

Object

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

名前	型	説明
count	integer	コレクション内のプロパティの数。
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	このエージェントが作成された日付を取得します。
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

Object

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

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

TaskAgentCloudRequest

Object

名前	型	説明
agent	TaskAgentReference
agentCloudId	integer
agentConnectedTime	string
agentData	JObject
agentSpecification	JObject
pool	TaskAgentPoolReference
provisionRequestTime	string
provisionedTime	string
releaseRequestTime	string
requestId	string

TaskAgentDelaySource

Object

名前	型	説明
delays	string[]
taskAgent	TaskAgentReference

TaskAgentJobRequest

Object

名前	型	説明
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

Object

名前	型	説明
id	integer
isHosted	boolean	このプールがサービスによって管理されているかどうかを示す値を取得または設定します。
name	string
poolType	TaskAgentPoolType	プールの種類を取得または設定します
scope	string
size	integer	プールの現在のサイズを取得します。

TaskAgentPoolType

列挙

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

値	説明
automation
deployment

TaskAgentPublicKey

Object

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

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

TaskAgentReference

Object

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
accessPoint	string	エージェントのアクセスポイントを取得します。
enabled	boolean	このエージェントをジョブの実行に対して有効にするかどうかを示す値を取得または設定します。
id	integer	エージェントの識別子を取得します。
name	string	エージェントの名前を取得します。
oSDescription	string	エージェントの OS を取得します。
provisioningState	string	このエージェントの現在のプロビジョニング状態を取得または設定します
status	TaskAgentStatus	エージェントの現在の接続状態を取得します。
version	string	エージェントのバージョンを取得します。

TaskAgentStatus

列挙

エージェントの現在の接続状態を取得します。

値	説明
offline
online

TaskAgentUpdate

Object

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

TaskAgentUpdateReason

Object

名前	型	説明
code	TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

列挙

値	説明
manual
minAgentVersionRequired

TaskOrchestrationOwner

Object

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

TaskResult

列挙

値	説明
abandoned
canceled
failed
skipped
succeeded
succeededWithIssues

次の方法で共有

Deploymentgroups - Get

URI パラメーター

応答

セキュリティ

oauth2

スコープ

例

Get a deployment group by its ID

要求のサンプル

応答のサンプル

定義

Demand

DeploymentGroup

DeploymentGroupActionFilter

DeploymentGroupExpands

DeploymentMachine

IdentityRef

JObject

JToken

PackageVersion

ProjectReference

PropertiesCollection

ReferenceLinks

TaskAgent

TaskAgentAuthorization

TaskAgentCloudRequest

TaskAgentDelaySource

TaskAgentJobRequest

TaskAgentPoolReference

TaskAgentPoolType

TaskAgentPublicKey

TaskAgentReference

TaskAgentStatus

TaskAgentUpdate

TaskAgentUpdateReason

TaskAgentUpdateReasonType

TaskOrchestrationOwner

TaskResult