Builds - Queue

リファレンス

サービス:: Build

API バージョン:: 7.1

ビルドをキューに入れます

POST https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=7.1

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

POST https://dev.azure.com/{organization}/{project}/_apis/build/builds?ignoreWarnings={ignoreWarnings}&checkInTicket={checkInTicket}&sourceBuildId={sourceBuildId}&definitionId={definitionId}&api-version=7.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使用する API のバージョン。このバージョンの API を使用するには、これを '7.1' に設定する必要があります。
checkInTicket	query		string
definitionId	query		integer (int32)	本文なしでビルドをキューに格納するための省略可能な定義 ID。有効な本文がある場合は無視されます
ignoreWarnings	query		boolean
sourceBuildId	query		integer (int32)

要求本文

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
agentSpecification	AgentSpecification	ビルドのエージェント仕様。
appendCommitMessageToRunName	boolean	UI の BuildNumber にコミットメッセージを追加します。
buildNumber	string	ビルドのビルド番号/名前。
buildNumberRevision	integer (int32)	ビルド番号のリビジョン。
controller	BuildController	ビルドコントローラー。これは、定義の種類が Xaml の場合にのみ設定されます。
definition	DefinitionReference	ビルドに関連付けられている定義。
deleted	boolean	ビルドが削除されたかどうかを示します。
deletedBy	IdentityRef	ビルドを削除したプロセスまたはユーザーの ID。
deletedDate	string (date-time)	ビルドが削除された日付。
deletedReason	string	ビルドが削除された方法の説明。
demands	Demand[]	このビルドに必要なエージェント機能を表す要求の一覧。
finishTime	string (date-time)	ビルドが完了した時刻。
id	integer (int32)	ビルドの ID。
lastChangedBy	IdentityRef	ビルドを最後に変更したプロセスまたはユーザーを表す ID。
lastChangedDate	string (date-time)	ビルドが最後に変更された日付。
logs	BuildLogReference	ビルドログに関する情報。
orchestrationPlan	TaskOrchestrationPlanReference	ビルドのオーケストレーション計画。
parameters	string	ビルドのパラメーター。
plans	TaskOrchestrationPlanReference[]	ビルドに関連付けられているオーケストレーションプラン (ビルド、クリーンアップ)
priority	QueuePriority	ビルドの優先順位。
project	TeamProjectReference	チームプロジェクト。
properties	PropertiesCollection	このクラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。 `TypeCode != TypeCode.Object` を除くすべてのプリミティブ型 (`DBNull`を持つ任意の型) の値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは文字列として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
quality	string	xaml ビルドの品質 (良い、悪いなど)
queue	AgentPoolQueue	キュー。これは、定義の種類が Build の場合にのみ設定されます。警告: このフィールドは非推奨であり、ジョブキューには対応していません。
queueOptions	QueueOptions	ビルドをキューに入るための追加のオプション。
queuePosition	integer (int32)	キュー内のビルドの現在位置。
queueTime	string (date-time)	ビルドがキューに登録された時刻。
reason	BuildReason	ビルドが作成された理由。
repository	BuildRepository	リポジトリ。
requestedBy	IdentityRef	ビルドをキューに入れた ID。
requestedFor	IdentityRef	ビルドの代わりにキューに登録された ID。
result	BuildResult	ビルド結果。
retainedByRelease	boolean	ビルドがリリースによって保持されるかどうかを示します。
sourceBranch	string	ソースブランチ。
sourceVersion	string	ソースバージョン。
startTime	string (date-time)	ビルドが開始された時刻。
status	BuildStatus	ビルドの状態。
tags	string[]
templateParameters	object	テンプレート式の評価に対するパラメーター
triggerInfo	object	ビルドのトリガーに関する Sourceprovider 固有の情報
triggeredByBuild	Build	ビルド完了トリガーを使用してこのビルドをトリガーしたビルド。
uri	string	ビルドの URI。
url	string	ビルドの REST URL。
validationResults	BuildRequestValidationResult[]	ビルド要求を検証した結果を表します。

応答

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

セキュリティ

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.build_execute	ビルドの結果、定義、要求など、ビルド成果物にアクセスする機能と、ビルドをキューに入れ、ビルドプロパティを更新する機能、およびサービスフックを介してビルドイベントに関する通知を受信する機能を付与します。

定義

名前	説明
AgentPoolQueue	ビルドを実行するためのキューを表します。
AgentSpecification	プールプロバイダーによって定義されたエージェントの仕様。
Build	ビルドのデータ表現。
BuildController
BuildLogReference	ビルドログへの参照を表します。
BuildReason	ビルドが作成された理由。
BuildRepository	ビルド定義で使用されるリポジトリを表します。
BuildRequestValidationResult	ビルド要求を検証した結果を表します。
BuildResult	ビルド結果。
BuildStatus	ビルドの状態。
ControllerStatus	コントローラーの状態。
DefinitionQueueStatus	ビルドをこの定義に対してキューに登録できるかどうかを示す値。
DefinitionReference	定義への参照を表します。
DefinitionType	定義の型。
Demand	定義またはビルドで使用される要求を表します。
IdentityRef
ProjectState	プロジェクトの状態。
ProjectVisibility	プロジェクトの可視性。
PropertiesCollection	このクラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。 `TypeCode != TypeCode.Object` を除くすべてのプリミティブ型 (`DBNull`を持つ任意の型) の値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは文字列として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
QueueOptions	ビルドをキューに入るための追加のオプション。
QueuePriority	ビルドの優先順位。
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
TaskAgentPoolReference	エージェントプールへの参照を表します。
TaskOrchestrationPlanReference	オーケストレーション計画への参照を表します。
TeamProjectReference	TeamProject への浅い参照を表します。
ValidationResult	結果。

AgentPoolQueue

Object

ビルドを実行するためのキューを表します。

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
id	integer (int32)	キューの ID。
name	string	キューの名前。
pool	TaskAgentPoolReference	このキューで使用されるプール。
url	string	リソースへの完全な http リンク。

AgentSpecification

Object

プールプロバイダーによって定義されたエージェントの仕様。

名前	型	説明
identifier	string	エージェント仕様の一意識別子。

Build

Object

ビルドのデータ表現。

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
agentSpecification	AgentSpecification	ビルドのエージェント仕様。
appendCommitMessageToRunName	boolean	UI の BuildNumber にコミットメッセージを追加します。
buildNumber	string	ビルドのビルド番号/名前。
buildNumberRevision	integer (int32)	ビルド番号のリビジョン。
controller	BuildController	ビルドコントローラー。これは、定義の種類が Xaml の場合にのみ設定されます。
definition	DefinitionReference	ビルドに関連付けられている定義。
deleted	boolean	ビルドが削除されたかどうかを示します。
deletedBy	IdentityRef	ビルドを削除したプロセスまたはユーザーの ID。
deletedDate	string (date-time)	ビルドが削除された日付。
deletedReason	string	ビルドが削除された方法の説明。
demands	Demand[]	このビルドに必要なエージェント機能を表す要求の一覧。
finishTime	string (date-time)	ビルドが完了した時刻。
id	integer (int32)	ビルドの ID。
lastChangedBy	IdentityRef	ビルドを最後に変更したプロセスまたはユーザーを表す ID。
lastChangedDate	string (date-time)	ビルドが最後に変更された日付。
logs	BuildLogReference	ビルドログに関する情報。
orchestrationPlan	TaskOrchestrationPlanReference	ビルドのオーケストレーション計画。
parameters	string	ビルドのパラメーター。
plans	TaskOrchestrationPlanReference[]	ビルドに関連付けられているオーケストレーションプラン (ビルド、クリーンアップ)
priority	QueuePriority	ビルドの優先順位。
project	TeamProjectReference	チームプロジェクト。
properties	PropertiesCollection	このクラスは、キーと値のペアのコレクションとしてプロパティバッグを表します。 `TypeCode != TypeCode.Object` を除くすべてのプリミティブ型 (`DBNull`を持つ任意の型) の値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは文字列として再調整されます。 Byte[] は base64 でエンコードされた文字列として必要です。
quality	string	xaml ビルドの品質 (良い、悪いなど)
queue	AgentPoolQueue	キュー。これは、定義の種類が Build の場合にのみ設定されます。警告: このフィールドは非推奨であり、ジョブキューには対応していません。
queueOptions	QueueOptions	ビルドをキューに入るための追加のオプション。
queuePosition	integer (int32)	キュー内のビルドの現在位置。
queueTime	string (date-time)	ビルドがキューに登録された時刻。
reason	BuildReason	ビルドが作成された理由。
repository	BuildRepository	リポジトリ。
requestedBy	IdentityRef	ビルドをキューに入れた ID。
requestedFor	IdentityRef	ビルドの代わりにキューに登録された ID。
result	BuildResult	ビルド結果。
retainedByRelease	boolean	ビルドがリリースによって保持されるかどうかを示します。
sourceBranch	string	ソースブランチ。
sourceVersion	string	ソースバージョン。
startTime	string (date-time)	ビルドが開始された時刻。
status	BuildStatus	ビルドの状態。
tags	string[]
templateParameters	object	テンプレート式の評価に対するパラメーター
triggerInfo	object	ビルドのトリガーに関する Sourceprovider 固有の情報
triggeredByBuild	Build	ビルド完了トリガーを使用してこのビルドをトリガーしたビルド。
uri	string	ビルドの URI。
url	string	ビルドの REST URL。
validationResults	BuildRequestValidationResult[]	ビルド要求を検証した結果を表します。

BuildController

Object

名前	型	説明
_links	ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
createdDate	string (date-time)	コントローラーが作成された日付。
description	string	コントローラーの説明。
enabled	boolean	コントローラーが有効かどうかを示します。
id	integer (int32)	リソースの ID
name	string	リンクされたリソースの名前 (定義名、コントローラー名など)
status	ControllerStatus	コントローラーの状態。
updatedDate	string (date-time)	コントローラーが最後に更新された日付。
uri	string	コントローラーの URI。
url	string	リソースへの完全な http リンク

BuildLogReference

Object

ビルドログへの参照を表します。

名前	型	説明
id	integer (int32)	ログの ID。
type	string	ログの場所の種類。
url	string	ログリソースへの完全なリンク。

BuildReason

列挙

ビルドが作成された理由。

値	説明
all	すべての理由。
batchedCI	TriggerType.BatchedContinuousIntegration のビルドが開始されました。
buildCompletion	ビルドは、別のビルドが完了したときに開始されました。
checkInShelveset	トリガー ContinuousIntegrationType.Gated のビルドが開始されました。
individualCI	TriggerType.ContinuousIntegration のビルドが開始されました。
manual	ビルドは手動で開始されました。
none	理由はありません。この値は使用しないでください。
pullRequest	ビルドはプル要求によって開始されました。リソースバージョン 3 で追加されました。
resourceTrigger	パイプライン内のリソースによってトリガーされたときにビルドが開始されました
schedule	triggerType.Schedule のビルドが開始されました。
scheduleForced	TriggerType.ScheduleForced のビルドが開始されました。
triggered	ビルドはアイテム保持ポリシーの目的でトリガーされました。
userCreated	ビルドはユーザーによって作成されました。
validateShelveset	プライベート検証のためにビルドが手動で開始されました。

BuildRepository

Object

ビルド定義で使用されるリポジトリを表します。

名前	型	説明
checkoutSubmodules	boolean	サブモジュールをチェックアウトするかどうかを示します。
clean	string	リポジトリからコードを取得するときにターゲットフォルダーをクリーンアップするかどうかを示します。
defaultBranch	string	既定のブランチの名前。
id	string	リポジトリの ID。
name	string	リポジトリのフレンドリ名。
properties	object
rootFolder	string	ルートフォルダー。
type	string	リポジトリの型。
url	string	リポジトリの URL。

BuildRequestValidationResult

Object

ビルド要求を検証した結果を表します。

名前	型	説明
message	string	結果に関連付けられているメッセージ。
result	ValidationResult	結果。

BuildResult

列挙

ビルド結果。

値	説明
canceled	開始する前にビルドが取り消されました。
failed	ビルドが正常に完了しませんでした。
none	結果なし
partiallySucceeded	ビルドは正常にコンパイルを完了しましたが、他のエラーが発生しました。
succeeded	ビルドが正常に完了しました。

BuildStatus

列挙

ビルドの状態。

値	説明
all	すべての状態。
cancelling	ビルドが取り消されている
completed	ビルドが完了しました。
inProgress	ビルドは現在進行中です。
none	状態なし。
notStarted	ビルドはまだ開始されていません。
postponed	ビルドはキュー内で非アクティブです。

ControllerStatus

列挙

コントローラーの状態。

値	説明
available	ビルドコントローラーが現在使用可能であることを示します。
offline	ビルドコントローラーがそれ自体をオフラインにしたことを示します。
unavailable	ビルドコントローラーに接続できないことを示します。

DefinitionQueueStatus

列挙

ビルドをこの定義に対してキューに登録できるかどうかを示す値。

値	説明
disabled	無効にした場合、定義キューはビルドをユーザーがキューに登録することを許可せず、システムはスケジュールされたビルド、ゲートビルド、または継続的インテグレーションビルドをキューに入れなくなります。キューに既に存在するビルドは、システムによって開始されません。
enabled	定義キューを有効にすると、ビルドをユーザーがキューに入れ、システムはスケジュールされた、ゲートされた継続的インテグレーションビルドをキューに入れ、キューに登録されたビルドがシステムによって開始されます。
paused	定義キューを一時停止すると、ビルドをユーザーがキューに入れ、システムはスケジュールされた、ゲートされた継続的インテグレーションビルドをキューに入れます。キュー内のビルドはシステムによって開始されません。

DefinitionReference

Object

定義への参照を表します。

名前	型	説明
createdDate	string (date-time)	このバージョンの定義が作成された日付。
id	integer (int32)	参照先の定義の ID。
name	string	参照先の定義の名前。
path	string	定義のフォルダーパス。
project	TeamProjectReference	プロジェクトへの参照。
queueStatus	DefinitionQueueStatus	ビルドをこの定義に対してキューに登録できるかどうかを示す値。
revision	integer (int32)	定義リビジョン番号。
type	DefinitionType	定義の型。
uri	string	定義の URI。
url	string	定義の REST URL。

DefinitionType

列挙

定義の型。

値	説明
build
xaml

Demand

Object

定義またはビルドで使用される要求を表します。

名前	型	説明
name	string	需要によって参照される機能の名前。
value	string	要求された値。

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 は、このグラフの件名のソースリソースへの完全なルートです。

ProjectState

列挙

プロジェクトの状態。

値	説明
all	[削除済み] を除く、状態に関係なく、すべてのプロジェクト。
createPending	プロジェクトは作成のためにキューに登録されていますが、プロセスはまだ開始されていません。
deleted	プロジェクトが削除されました。
deleting	プロジェクトは削除中です。
new	プロジェクトは作成中です。
unchanged	プロジェクトは変更されていません。
wellFormed	プロジェクトが完全に作成され、使用する準備が整いました。

ProjectVisibility

列挙

プロジェクトの可視性。

値	説明
private	プロジェクトは、明示的なアクセス権を持つユーザーにのみ表示されます。
public	プロジェクトはすべてのユーザーに表示されます。

PropertiesCollection

Object

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

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

QueueOptions

列挙

ビルドをキューに入るための追加のオプション。

値	説明
doNotRun	ビルドのプラン ID を作成し、実行しないでください
none	キューオプションなし

QueuePriority

列挙

ビルドの優先順位。

値	説明
aboveNormal	通常の優先度を超えています。
belowNormal	通常の優先度を下回る。
high	優先度が高い。
low	優先順位が低い。
normal	通常の優先度。

ReferenceLinks

Object

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

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

TaskAgentPoolReference

Object

エージェントプールへの参照を表します。

名前	型	説明
id	integer (int32)	プール ID。
isHosted	boolean	このプールがサービスによって管理されているかどうかを示す値。
name	string	プール名。

TaskOrchestrationPlanReference

Object

オーケストレーション計画への参照を表します。

名前	型	説明
orchestrationType	integer (int32)	プランの種類。
planId	string (uuid)	プランの ID。

TeamProjectReference

Object

TeamProject への浅い参照を表します。

名前	型	説明
abbreviation	string	プロジェクトの省略形。
defaultTeamImageUrl	string	既定のチーム ID イメージの URL。
description	string	プロジェクトの説明 (ある場合)。
id	string (uuid)	プロジェクト識別子。
lastUpdateTime	string (date-time)	プロジェクトの最終更新時刻。
name	string	プロジェクト名。
revision	integer (int64)	プロジェクトのリビジョン。
state	ProjectState	プロジェクトの状態。
url	string	オブジェクトの完全なバージョンへの URL。
visibility	ProjectVisibility	プロジェクトの可視性。

ValidationResult

列挙

結果。

値	説明
error
ok
warning

次の方法で共有

Builds - Queue

URI パラメーター

要求本文

応答

セキュリティ

oauth2

スコープ

定義

AgentPoolQueue

AgentSpecification

Build

BuildController

BuildLogReference

BuildReason

BuildRepository

BuildRequestValidationResult

BuildResult

BuildStatus

ControllerStatus

DefinitionQueueStatus

DefinitionReference

DefinitionType

Demand

IdentityRef

ProjectState

ProjectVisibility

PropertiesCollection

QueueOptions

QueuePriority

ReferenceLinks

TaskAgentPoolReference

TaskOrchestrationPlanReference

TeamProjectReference

ValidationResult