次の方法で共有


Deploymentgroups - Add

デプロイ グループを作成します。

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

URI パラメーター

名前 / 必須 説明
organization
path True

string

Azure DevOps 組織の名前です。

project
path True

string

プロジェクト ID またはプロジェクト名

api-version
query True

string

使う API のバージョン。 このバージョンの API を使用するには、これを '5.0-preview.1' に設定する必要があります。

要求本文

名前 説明
description

string

デプロイ グループの説明。

name

string

デプロイ グループの名前。

poolId

integer

デプロイ エージェントが登録されている展開プールの識別子。

応答

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

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

Create a deployment group

Sample Request

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

{
  "name": "MyDeploymentGroup1",
  "description": "This deployment group is created to demnostrate the client usage"
}

Sample Response

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

デプロイ グループ。

DeploymentGroupCreateParameter

デプロイ グループを作成するプロパティ。

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

名前 説明
name

string

value

string

DeploymentGroup

デプロイ グループ。

名前 説明
description

string

デプロイ グループの説明。

id

integer

デプロイ グループ識別子。

machineCount

integer

デプロイ グループ内のデプロイ ターゲットの数。

machineTags

string[]

デプロイ グループ内のすべてのデプロイ ターゲットの一意のタグの一覧。

machines

DeploymentMachine[]

デプロイ グループ内のデプロイ ターゲットの一覧。

name

string

デプロイ グループの名前。

pool

TaskAgentPoolReference

デプロイ エージェントが登録されている展開プール。

project

ProjectReference

配置グループが属するプロジェクト。

DeploymentGroupCreateParameter

デプロイ グループを作成するプロパティ。

名前 説明
description

string

デプロイ グループの説明。

name

string

デプロイ グループの名前。

poolId

integer

デプロイ エージェントが登録されている展開プールの識別子。

DeploymentMachine

デプロイ ターゲット。

名前 説明
agent

TaskAgent

デプロイ エージェント。

id

integer

デプロイ ターゲット識別子。

tags

string[]

デプロイ ターゲットのタグ。

IdentityRef

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

名前 説明
item

JToken

type

string

JToken

名前 説明
first

JToken

hasValues

boolean

item

JToken

last

JToken

next

JToken

parent

string

path

string

previous

JToken

root

JToken

type

string

PackageVersion

名前 説明
major

integer

minor

integer

patch

integer

ProjectReference

名前 説明
id

string

name

string

PropertiesCollection

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

名前 説明
count

integer

コレクション内のプロパティの数。

item

object

keys

string[]

コレクション内のキーのセット。

values

string[]

コレクション内の値のセット。

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

名前 説明
links

object

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

TaskAgent

名前 説明
_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 認証フローを使用してエージェントを承認するために必要なデータを提供します。

名前 説明
authorizationUrl

string

構成されたトークン サービスからアクセス トークンを取得するために使用するエンドポイントを取得または設定します。

clientId

string

このエージェントのクライアント識別子を取得または設定します。

publicKey

TaskAgentPublicKey

このエージェントの ID を確認するために使用する公開キーを取得または設定します。

TaskAgentCloudRequest

名前 説明
agent

TaskAgentReference

agentCloudId

integer

agentConnectedTime

string

agentData

JObject

agentSpecification

JObject

pool

TaskAgentPoolReference

provisionRequestTime

string

provisionedTime

string

releaseRequestTime

string

requestId

string

TaskAgentDelaySource

名前 説明
delays

string[]

taskAgent

TaskAgentReference

TaskAgentJobRequest

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

名前 説明
id

integer

isHosted

boolean

このプールがサービスによって管理されているかどうかを示す値を取得または設定します。

name

string

poolType

TaskAgentPoolType

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

scope

string

size

integer

プールの現在のサイズを取得します。

TaskAgentPoolType

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

名前 説明
automation

string

deployment

string

TaskAgentPublicKey

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

名前 説明
exponent

string[]

公開キーの指数を取得または設定します。

modulus

string[]

公開キーの剰余を取得または設定します。

TaskAgentReference

名前 説明
_links

ReferenceLinks

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

accessPoint

string

エージェントのアクセス ポイントを取得します。

enabled

boolean

このエージェントをジョブの実行に対して有効にするかどうかを示す値を取得または設定します。

id

integer

エージェントの識別子を取得します。

name

string

エージェントの名前を取得します。

oSDescription

string

エージェントの OS を取得します。

provisioningState

string

このエージェントの現在のプロビジョニング状態を取得または設定します

status

TaskAgentStatus

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

version

string

エージェントのバージョンを取得します。

TaskAgentStatus

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

名前 説明
offline

string

online

string

TaskAgentUpdate

名前 説明
currentState

string

このエージェント更新プログラムの現在の状態

reason

TaskAgentUpdateReason

このエージェントの更新の理由

requestTime

string

このエージェントの更新が要求された日付を取得します。

requestedBy

IdentityRef

エージェントの更新を要求する ID

sourceVersion

PackageVersion

エージェント更新プログラムのソース エージェントのバージョンを取得または設定します

targetVersion

PackageVersion

エージェント更新プログラムのターゲット エージェント バージョンを取得または設定します

TaskAgentUpdateReason

名前 説明
code

TaskAgentUpdateReasonType

TaskAgentUpdateReasonType

名前 説明
manual

string

minAgentVersionRequired

string

TaskOrchestrationOwner

名前 説明
_links

ReferenceLinks

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

id

integer

name

string

TaskResult

名前 説明
abandoned

string

canceled

string

failed

string

skipped

string

succeeded

string

succeededWithIssues

string