Azure DevOps

  • リファレンス

Azure DevOps は、チームがコードを共有し、作業を追跡し、ソフトウェアを出荷するためのサービスを、あらゆる言語ですべて 1 つのパッケージで提供します。 これは、IDE を完全に補完するものです。

このコネクタは、次の製品および地域で利用可能です。

サービス クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure China の地域
     -   米国国防総省 (DoD)
Power Automate Premium 以下を除くすべての Power Automate 地域 :
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Power Apps Premium 以下を除くすべての Power Apps 地域 :
     -   US Government (GCC High)
     -   21 Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
Connector Metadata
発行者 マイクロソフト

この統合を使用するには、API アクセスが有効になっている Azure DevOps アカウントにアクセスする必要があります。 接続するには、サインインを選択します。 次に、Azure DevOps Services アカウントを指定するように求められます。 画面の残りの部分に従って接続を作成します。

接続を使用しているときに、期待するプロジェクトのリストが表示されない場合は、接続を作成したアカウントを確認して、再試行してください。 詳細については、Visual Studio Marketplace を参照してください。

これで、この統合の使用を開始する準備が整いました。

添付ファイルの送信

HTTP 要求を Azure DevOps に送信するアクションを使用し、次の手順に従うことで、添付ファイルを作成できます:

  1. ファイルの内容を Base64 文字列に変換し、「Body」パラメータに入れます。
  2. 「Body is Base64」パラメータを、はいに設定します。

テスト計画を作成

作業項目の作成アクションを使用してテスト計画を作成する前に、まず Test Suite を作成する必要があります。 同じ 作業項目の作成 アクションを使用して Test Suites を作成してから、Test Suite へのリンクを含むテスト計画を作成できます。

最も簡単なオプションは、HTTP 要求を Azure DevOps に送信アクションを使用して、直接、テスト計画 - API を作成を呼び出すことです。 API は、関連する Test Suite を自動的に作成します。

Other Fields パラメータ

作業項目を作成する および 作業項目を更新する アクションは Other Fields パラメーターをサポートしています。 これらのフィールドは、作業項目を更新するときに追加の柔軟性を提供します。 キーと値のペアは、次の JSON に変換されます :

{
  "op": "add",
  "path": "/fields/<key>",
  "value": <value>
}

op は定数であり、<key> は DevOps の /fields 列挙で有効なフィールド名であることが期待されていることに注意してください。

次にいくつか使用例を挙げます。 作業項目 - REST API の更新でさらに多くの例を見つけることができます。

  1. 履歴の更新 key = System.History value = Moving to the right area path`
  2. 作業項目の移動 : key = System.TeamProject value = Fabrikam-Scrum

既知の問題と制限事項

以下の一覧は、Azure DevOps コネクタを使用する際の既知の制限の一部です。

  1. トリガー 作業項目が更新されたとき は、新規/既存のリンクが作業項目に追加/削除されたときにスキップされます。

  2. アクション 作業項目の詳細を取得 および作業項目ベースのトリガーは、Azure DevOps REST API の制限であるため、応答の一部のフィールド (System.AttachedFileCount など) を見逃す可能性があります。 この問題を回避するには、次のいずれかを実行できます :

  3. アクション HTTP リクエストを Azure DevOps に送信するは、アクションによってアクセスできるリソースと、アクションがそれらのリソースに対して実行できる操作を制御するスコープのセットが制限されています。

    スコープ :

    • vso.agentpools_manage
    • vso.build_execute
    • vso.chat_manage
    • vso.code_manage
    • vso.code_status
    • vso.connected_server
    • vso.dashboards_manage
    • vso.entitlements
    • vso.extension.data_write
    • vso.extension_manage
    • vso.identity
    • vso.loadtest_write
    • vso.packaging_manage
    • vso.project_manage
    • vso.release_manage
    • vso.test_write
    • vso.work_write

  4. Azure DevOps コネクタは、現在のユーザー資格情報に代わってのみ機能するように設計されています。 接続を変更したり、アカウントを切り替えたりすることはできません。

  5. Azure DevOps アカウントでパスワードを変更しても、既存の接続には影響しません。

  6. Azure DevOps 個人用アクセス トークンは、コネクタを使用した認証ではサポートされていません。

  7. アクション作業項目を作成するには Repro Steps パラメーターに対する制限があります - 30 KB を超える画像が作成された項目に正しく表示されない可能性があります。 500Kb を超える画像は要求から削除される可能性があります。 推奨される画像サイズは 30 KB 未満である必要があります。

  8. アクション作業項目の作成 は、ごくまれに 404 応答コードを返すことがあります。 ほとんどの場合、これはアイテムが作成された直後に、そのすべてのフィールドが要求されたために発生します。 コピーしたデータベースにリクエストを送信できます。 変更はほぼリアルタイムで同期されましたが、数秒かかる場合もあります。 このため、GET リクエストは、レスポンスで 404 ステータス コードとして表される、空の結果を返す場合があります。 この例外を回避するには、「すべてのフィールドを返す」フラグを使用して、「No」値に設定します。

  9. 複数のディレクトリで作業しているときに期待した組織が得られない場合は、Azure DevOpsプロフィールページから期待する組織を選択し、新しい接続をセットアップしてください。

注意

アクショ中ン 作業項目の作成

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 300 60 秒

アクション

Git リポジトリの一覧表示

プロジェクト内の Git リポジトリのリストを取得します。
HTTP リクエストを Azure DevOps に送信します

呼び出す Azure DevOps REST API リクエストを作成します。 利用可能なすべてのエンドポイントについては、次のリンクを参照してください : https://docs.microsoft.com/rest/api/azure/devops
イテレーションをリストする

プロジェクトのイテレーションのリストを取得します。
クエリ結果を取得する

作業項目クエリの結果を取得します。
クエリ結果を取得する [非推奨]

このアクションは非推奨になりました。 代わりにクエリ結果を取得するを使用してください。

作業項目クエリの結果を取得します。
パイプラインの一覧

プロジェクトが含むパイプラインのリストを取得します。
パイプラインの実行を一覧にする

特定のパイプラインが含む上位 10000 件の実行を取得する
フォルダ内のクエリを一覧表示します

特定のプロジェクトのフォルダー内の作業項目クエリのリストを取得します。
プロジェクトを一覧表示する

組織内のプロジェクトの一覧を取得します。
ユーザー プロファイルを取得する

ユーザー プロファイルを取得します。
リリース定義のリスト

プロジェクトに関連付けられているリリース定義のリストを取得します。
ルート レベルのクエリを一覧表示する

プロジェクト内のルート レベルの作業項目クエリのリストを取得します。
作業項目の一覧

作業項目のリストを返します。
作業項目の作成

指定された属性を使用して新しい作業項目を作成します。
作業項目の子を取得する

単一の作業項目の子 (最大サイズ 1000) のリストを取得します。
作業項目の種類の一覧

特定の Azure DevOps プロジェクトでアクセス可能な作業項目タイプのリストを取得します。
作業項目の詳細を取得する

単一の作業項目の詳細を取得します。
作業項目を更新する

ID で既存の作業項目を更新します。
新しいビルドをキューに入れる

既存のビルド定義に基づいてビルドを作成し、ビルド キューに追加します。
新しいリリースを作成する

既存のリリース定義に基づいてリリースを作成します。
組織を一覧表示する

ユーザーがメンバーになっているチームまたは組織のリスト。

Git リポジトリの一覧表示

操作 ID:
ListGitRepositories

プロジェクト内の Git リポジトリのリストを取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。

戻り値

VSTS モデルの一覧。

本文​​
VstsList[GitRepository]

HTTP リクエストを Azure DevOps に送信します

操作 ID:
HttpRequest

呼び出す Azure DevOps REST API リクエストを作成します。 利用可能なすべてのエンドポイントについては、次のリンクを参照してください : https://docs.microsoft.com/rest/api/azure/devops

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
メソッド
 Method True string

HTTP メソッド。
相対 URI
 Uri True string

相対 URI。 例 : {project}/{team}/_apis/wit/templates?api-version=5.0-preview.1.
ヘッダー
 Headers object

要求ヘッダー。
Body
 Body string

リクエスト内容。 JSON オブジェクトまたは Base64 文字列としてエンコードされたバイナリ データにすることができます。
本文 は Base64 です
 IsBase64 boolean

リクエスト コンテンツが Base64 文字列としてエンコードされている場合は true である必要があります。

戻り値

応答
ObjectWithoutType

イテレーションをリストする

操作 ID:
ListIterations

プロジェクトのイテレーションのリストを取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
チーム名
 team True string

プロジェクト内のチームの名前。

戻り値

VSTS モデルの一覧。

本文​​
VstsList[TeamSettingsIteration]

クエリ結果を取得する

操作 ID:
GetQueryResultsV2

作業項目クエリの結果を取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
クエリ ID
 queryId True string

実行する保存済みクエリの ID。
返される作業項目の数
 workItemsCount integer

取得する最大作業項目数 (1〜20000)
クエリ結果が変更された場合は失敗します
 throwIfQueryChanged boolean

フローの実行中にクエリ結果が変更された場合、フローの実行は不整合を回避できないはずです。

戻り値

この操作の出力は状況に応じて変わります。

クエリ結果を取得する [非推奨]

操作 ID:
GetQueryResults

このアクションは非推奨になりました。 代わりにクエリ結果を取得するを使用してください。

作業項目クエリの結果を取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
クエリ ID
 queryId True string

実行する保存済みクエリの ID。

戻り値

VSTS モデルの一覧。

Body
VstsList[JObject]

パイプラインの一覧

操作 ID:
ListPipelines

プロジェクトが含むパイプラインのリストを取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。

戻り値

Body
Pipeline

パイプラインの実行を一覧にする

操作 ID:
ListPipelineRuns

特定のパイプラインが含む上位 10000 件の実行を取得する

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
パイプライン ID
 pipelineId True integer

パイプライン ID

戻り値

Body
Run

フォルダ内のクエリを一覧表示します

操作 ID:
ListQueriesInFolder

特定のプロジェクトのフォルダー内の作業項目クエリのリストを取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
フォルダのパス
 folderPath True string

クエリを検索するフォルダ パス。

戻り値

VSTS モデルの一覧。

本文​​
VstsList[QueryHierarchyItem]

プロジェクトを一覧表示する

操作 ID:
ListProjects

組織内のプロジェクトの一覧を取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。

戻り値

VSTS モデルの一覧。

本文​​
VstsList[Project]

ユーザー プロファイルを取得する

操作 ID:
GetProfile

ユーザー プロファイルを取得します。

パラメーター

名前 キー 必須 型 説明
プロファイル ID
 id True string

同じ組織内のプロファイルの ID、または現在認証済みであるユーザーのプロファイルを取得する '自分' です。

戻り値

Profile

Body
Profile

リリース定義のリスト

操作 ID:
ListReleaseDefinitions

プロジェクトに関連付けられているリリース定義のリストを取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。

戻り値

VSTS モデルの一覧。

本文​​
VstsList[ReleaseDefinition]

ルート レベルのクエリを一覧表示する

操作 ID:
ListRootQueryFolders

プロジェクト内のルート レベルの作業項目クエリのリストを取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。

戻り値

VSTS モデルの一覧。

本文​​
VstsList[QueryHierarchyItem]

作業項目の一覧

操作 ID:
ListWorkItems

作業項目のリストを返します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
作業項目 ID
 workItemIds True string

要求された作業項目 ID のコンマ区切りのリスト。
作業項目タイプ
 workItemType string

スキーマを生成する作業項目タイプ。

戻り値

この操作の出力は状況に応じて変わります。

作業項目の作成

操作 ID:
CreateWorkItem

指定された属性を使用して新しい作業項目を作成します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
作業項目タイプ
 type True string

この作業項目のタイプ
すべてのフィールドを返す
 shouldReturnAllFields boolean

値を「No」に設定すると、作業項目 ID のみが返されます。 値が「Yes」の場合、作成されたアイテムのすべてのフィールドと ID が返されます。 既定値は「Yes」です
作業項目の詳細
 workItem True dynamic

新しい作業項目に含める情報

戻り値

この操作の出力は状況に応じて変わります。

作業項目の子を取得する

操作 ID:
GetWorkItemChildren

単一の作業項目の子 (最大サイズ 1000) のリストを取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
作業項目 ID
 id True string

子を取得するための作業項目の一意の ID。
子の作業項目タイプ
 workItemType string

子の作業項目のタイプ

戻り値

この操作の出力は状況に応じて変わります。

作業項目の種類の一覧

操作 ID:
ListWorkItemTypes

特定の Azure DevOps プロジェクトでアクセス可能な作業項目タイプのリストを取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。

戻り値

VSTS モデルの一覧。

本文​​
VstsList[WorkItemType]

作業項目の詳細を取得する

操作 ID:
GetWorkItemDetails

単一の作業項目の詳細を取得します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
作業項目タイプ
 typeName True string

作業項目の作業項目タイプ。
作業項目 ID
 id True string

詳細を取得する作業項目の一意の ID。作業項目は、「作業項目タイプ」で指定されたタイプである必要があります。

戻り値

この操作の出力は状況に応じて変わります。

作業項目を更新する

操作 ID:
UpdateWorkItem

ID で既存の作業項目を更新します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
作業項目 ID
 id True string

更新する作業項目の一意の ID。
プロジェクト名
 project string

指定した組織内のプロジェクトの名前です。
作業項目タイプ
 type string

スキーマを生成する作業項目タイプ。
作業項目の詳細
 workItem True dynamic

作業項目の詳細。

戻り値

この操作の出力は状況に応じて変わります。

新しいビルドをキューに入れる

操作 ID:
QueueNewBuild

既存のビルド定義に基づいてビルドを作成し、ビルド キューに追加します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
ビルドの定義 ID
 buildDefId True string

使用するビルド定義の識別子。
ソース ブランチ
 sourceBranch string

ビルドのソース ブランチ。
パラメーター
 parameters string

オプションのビルド パラメーターの JSON 辞書。

戻り値

ビルド結果

本文​​
BuildResult

新しいリリースを作成する

操作 ID:
CreateRelease

既存のリリース定義に基づいてリリースを作成します。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
リリース定義 ID
 releaseDefId True string

使用するリリース定義の識別子。
内容
 Description string

リリース開始メタデータの説明。
ドラフトである
 IsDraft boolean

リリースがドラフトであるかどうかを指定します。
理由
 Reason string

リリース開始メタデータの理由。
件名
 Name True string

構成変数の名前。
値
 Value string

構成変数の値。

戻り値

リリース

本文
Release

組織を一覧表示する

操作 ID:
ListAccounts

ユーザーがメンバーになっているチームまたは組織のリスト。

戻り値

VSTS モデルの一覧。

Body
VstsList[Account]

トリガー

コードがチェック インされたとき (TFVC)

コードが Team Foundation バージョン管理にチェックインされると、フローがトリガーされます。
コードがプッシュされたとき (Git)

コードが Git リポジトリにプッシュされると、フローがトリガーされます。
ビルドが完了したとき

ビルドが完了すると、フローがトリガーされます。
プル要求がクローズしたとき (Git)

指定された基準に一致するプル要求がクローズしたときにフローをトリガーします。
プル要求が作成されたとき (Git)

指定された基準に一致するプル要求が作成されたときにフローをトリガーします。
作業項目が作成されたとき

指定された基準に一致する作業項目が作成されると、フローがトリガーされます。
作業項目が作成されたとき [非推奨]

このアクションは非推奨になりました。 代わりに、作業項目を作成するときにを使用してください。

指定された基準に一致する作業項目が作成されると、フローがトリガーされます。
作業項目が割り当てられたとき

指定された基準に一致する作業項目が指定されたユーザーに割り当てられると、フローがトリガーされます。
作業項目が割り当てられた場合 [非推奨]

このアクションは非推奨になりました。 代わりに、作業項目が割り当てられたときを使用してください。

指定された基準に一致する作業項目が指定されたユーザーに割り当てられると、フローがトリガーされます。
作業項目が更新されたとき

指定された基準に一致する作業項目が更新されると、フローがトリガーされます。
作業項目が更新されたとき [非推奨]

このアクションは非推奨になりました。 代わりに、作業項目が更新されたときを使用してください。

指定された基準に一致する作業項目が更新されると、フローがトリガーされます。
作業項目が閉じられたとき

指定された基準に一致する作業項目が閉じられると、フローがトリガーされます。
作業項目が閉じられたとき [非推奨]

このアクションは非推奨になりました。 代わりに、作業項目が閉じているときを使用してください。

指定された基準に一致する作業項目が閉じられると、フローがトリガーされます。

コードがチェック インされたとき (TFVC)

操作 ID:
OnTfvcCheckIn

コードが Team Foundation バージョン管理にチェックインされると、フローがトリガーされます。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
チーム名
 team string

著者を選択するチームの名前。
チーム メンバー
 author string

チェック インを作成したチーム メンバーの一意の名前。

戻り値

VSTS モデルの一覧。

本文​​
VstsList[TfvcChangeset]

コードがプッシュされたとき (Git)

操作 ID:
OnGitPush

コードが Git リポジトリにプッシュされると、フローがトリガーされます。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
リポジトリ名
 repository True string

指定したプロジェクト内のリポジトリの名前です。
参照名
 refName string

ブランチまたはタグなどの Git 参照の名前です。

戻り値

VSTS モデルの一覧。

本文​​
VstsList[GitPush]

ビルドが完了したとき

操作 ID:
OnBuildCompleted

ビルドが完了すると、フローがトリガーされます。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
結果でフィルター
 resultFilter string

トリガーするビルド結果を示すオプション。 有効なオプションには、'succeeded'、'partiallySucceeded'、failed'、または 'canceled' があります。
定義 ID でフィルター
 definitions string

トリガーするビルド定義 ID を示すオプション。

戻り値

VSTS モデルの一覧。

本文​​
VstsList[BuildResult]

プル要求がクローズしたとき (Git)

操作 ID:
OnGitPullClosed

指定された基準に一致するプル要求がクローズしたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
リポジトリ名
 repository True string

指定したプロジェクト内のリポジトリの名前です。
ソース参照名
 sourceRefName string

ブランチまたはタグなどの Git 参照の名前です。
ターゲット参照名
 targetRefName string

ブランチまたはタグなどの Git 参照の名前です。

戻り値

VSTS モデルの一覧。

本文​​
VstsList[GitPullRequest]

プル要求が作成されたとき (Git)

操作 ID:
OnGitPullCreated

指定された基準に一致するプル要求が作成されたときにフローをトリガーします。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
リポジトリ名
 repository True string

指定したプロジェクト内のリポジトリの名前です。
ソース参照名
 sourceRefName string

ブランチまたはタグなどの Git 参照の名前です。
ターゲット参照名
 targetRefName string

ブランチまたはタグなどの Git 参照の名前です。

戻り値

VSTS モデルの一覧。

Body
VstsList[GitPullRequest]

作業項目が作成されたとき

操作 ID:
OnWorkItemCreatedV2

指定された基準に一致する作業項目が作成されると、フローがトリガーされます。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
チーム名 (割り当て先ユーザー/グループを選択するため)
 team string

割り当て先を選択するチームの名前。
割り当て先
 wiql__System_AssignedTo string

現在作業項目を所有しているチーム メンバーの名前。
タイプ
 wiql__System_WorkItemType string

作業項目タイプの名前。
領域パス
 wiql__System_AreaPath string

作業項目が含まれる製品機能またはチーム領域。
領域パスの比較
 areaPathComparison string

領域パス フィールドの比較時に使用されるルール。
イテレーション パス
 wiql__System_IterationPath string

作業項目が含まれる名前付きスプリントまたは期間。
イテレーション パスの比較
 iterationPathComparison string

イテレーション パス フィールドの比較時に使用されるルール。
優先順位
 wiql__Microsoft_VSTS_Common_Priority string

ビジネスに関連するバグ、問題、タスク、またはテスト ケースの主観的な評価。
作成者
wiql__System_CreatedBy string

作業項目を作成したチーム メンバーの名前。

戻り値

この操作の出力は状況に応じて変わります。

作業項目が作成されたとき [非推奨]

操作 ID:
OnWorkItemCreated

このアクションは非推奨になりました。 代わりに、作業項目を作成するときにを使用してください。

指定された基準に一致する作業項目が作成されると、フローがトリガーされます。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
チーム名 (割り当て先ユーザー/グループを選択するため)
 team string

割り当て先を選択するチームの名前。
割り当て先
 wiql__System_AssignedTo string

現在作業項目を所有しているチーム メンバーの名前。
タイプ
 wiql__System_WorkItemType string

作業項目タイプの名前。
領域パス
 wiql__System_AreaPath string

作業項目が含まれる製品機能またはチーム領域。
領域パスの比較
 areaPathComparison string

領域パス フィールドの比較時に使用されるルール。
イテレーション パス
 wiql__System_IterationPath string

作業項目が含まれる名前付きスプリントまたは期間。
イテレーション パスの比較
 iterationPathComparison string

イテレーション パス フィールドの比較時に使用されるルール。
優先順位
 wiql__Microsoft_VSTS_Common_Priority string

ビジネスに関連するバグ、問題、タスク、またはテスト ケースの主観的な評価。
チーム プロジェクト
 wiql__System_TeamProject string

この作業項目が属するチーム プロジェクト。
作成者
wiql__System_CreatedBy string

作業項目を作成したチーム メンバーの名前。

戻り値

この操作の出力は状況に応じて変わります。

作業項目が割り当てられたとき

操作 ID:
OnWorkItemAssignedV2

指定された基準に一致する作業項目が指定されたユーザーに割り当てられると、フローがトリガーされます。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
チーム名 (割り当て先ユーザー/グループを選択するため)
 team True string

メンバーを選択するチームの名前。
割り当て先
 wiql__System_AssignedTo True string

現在作業項目を所有しているチーム メンバーの名前。
タイプ
 wiql__System_WorkItemType string

作業項目タイプの名前。
領域パス
 wiql__System_AreaPath string

作業項目が含まれる製品機能またはチーム領域。
領域パスの比較
 areaPathComparison string

領域パス フィールドの比較時に使用されるルール。
イテレーション パス
 wiql__System_IterationPath string

作業項目が含まれる名前付きスプリントまたは期間。
イテレーション パスの比較
 iterationPathComparison string

イテレーション パス フィールドの比較時に使用されるルール。
優先順位
 wiql__Microsoft_VSTS_Common_Priority string

ビジネスに関連するバグ、問題、タスク、またはテスト ケースの主観的な評価。
作成者
wiql__System_CreatedBy string

作業項目を作成したチーム メンバーの名前。

戻り値

この操作の出力は状況に応じて変わります。

作業項目が割り当てられた場合 [非推奨]

操作 ID:
OnWorkItemAssigned

このアクションは非推奨になりました。 代わりに、作業項目が割り当てられたときを使用してください。

指定された基準に一致する作業項目が指定されたユーザーに割り当てられると、フローがトリガーされます。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
割り当て先
 wiql__System_AssignedTo True string

現在作業項目を所有しているチーム メンバーの名前。
チーム名 (割り当て先ユーザー/グループを選択するため)
 team string

メンバーを選択するチームの名前。
タイプ
 wiql__System_WorkItemType string

作業項目タイプの名前。
領域パス
 wiql__System_AreaPath string

作業項目が含まれる製品機能またはチーム領域。
領域パスの比較
 areaPathComparison string

領域パス フィールドの比較時に使用されるルール。
イテレーション パス
 wiql__System_IterationPath string

作業項目が含まれる名前付きスプリントまたは期間。
イテレーション パスの比較
 iterationPathComparison string

イテレーション パス フィールドの比較時に使用されるルール。
優先順位
 wiql__Microsoft_VSTS_Common_Priority string

ビジネスに関連するバグ、問題、タスク、またはテスト ケースの主観的な評価。
チーム プロジェクト
 wiql__System_TeamProject string

この作業項目が属するチーム プロジェクト。
作成者
wiql__System_CreatedBy string

作業項目を作成したチーム メンバーの名前。

戻り値

この操作の出力は状況に応じて変わります。

作業項目が更新されたとき

操作 ID:
OnWorkItemUpdatedV2

指定された基準に一致する作業項目が更新されると、フローがトリガーされます。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
チーム名 (割り当て先ユーザー/グループを選択するため)
 team string

割り当て先を選択するチームの名前。
割り当て先
 wiql__System_AssignedTo string

現在作業項目を所有しているチーム メンバーの名前。
タイプ
 wiql__System_WorkItemType string

作業項目タイプの名前。
領域パス
 wiql__System_AreaPath string

作業項目が含まれる製品機能またはチーム領域。
領域パスの比較
 areaPathComparison string

領域パス フィールドの比較時に使用されるルール。
イテレーション パス
 wiql__System_IterationPath string

作業項目が含まれる名前付きスプリントまたは期間。
イテレーション パスの比較
 iterationPathComparison string

イテレーション パス フィールドの比較時に使用されるルール。
優先順位
 wiql__Microsoft_VSTS_Common_Priority string

ビジネスに関連するバグ、問題、タスク、またはテスト ケースの主観的な評価。
作成者
wiql__System_CreatedBy string

作業項目を作成したチーム メンバーの名前。

戻り値

この操作の出力は状況に応じて変わります。

作業項目が更新されたとき [非推奨]

操作 ID:
OnWorkItemUpdated

このアクションは非推奨になりました。 代わりに、作業項目が更新されたときを使用してください。

指定された基準に一致する作業項目が更新されると、フローがトリガーされます。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
チーム名 (割り当て先ユーザー/グループを選択するため)
 team string

割り当て先を選択するチームの名前。
割り当て先
 wiql__System_AssignedTo string

現在作業項目を所有しているチーム メンバーの名前。
タイプ
 wiql__System_WorkItemType string

作業項目タイプの名前。
領域パス
 wiql__System_AreaPath string

作業項目が含まれる製品機能またはチーム領域。
領域パスの比較
 areaPathComparison string

領域パス フィールドの比較時に使用されるルール。
イテレーション パス
 wiql__System_IterationPath string

作業項目が含まれる名前付きスプリントまたは期間。
イテレーション パスの比較
 iterationPathComparison string

イテレーション パス フィールドの比較時に使用されるルール。
優先順位
 wiql__Microsoft_VSTS_Common_Priority string

ビジネスに関連するバグ、問題、タスク、またはテスト ケースの主観的な評価。
チーム プロジェクト
 wiql__System_TeamProject string

この作業項目が属するチーム プロジェクト。
作成者
wiql__System_CreatedBy string

作業項目を作成したチーム メンバーの名前。

戻り値

この操作の出力は状況に応じて変わります。

作業項目が閉じられたとき

操作 ID:
OnWorkItemClosedV2

指定された基準に一致する作業項目が閉じられると、フローがトリガーされます。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
チーム名 (割り当て先ユーザー/グループを選択するため)
 team string

割り当て先を選択するチームの名前。
割り当て先
 wiql__System_AssignedTo string

現在作業項目を所有しているチーム メンバーの名前。
タイプ
 wiql__System_WorkItemType string

作業項目タイプの名前。
クローズ状態
 closedState string

作業項目がどのように閉じられたか (完了、終了、完了、非アクティブ) を示す状態フィールドの値のコンマ区切りのリスト。
領域パス
 wiql__System_AreaPath string

作業項目が含まれる製品機能またはチーム領域。
領域パスの比較
 areaPathComparison string

領域パス フィールドの比較時に使用されるルール。
イテレーション パス
 wiql__System_IterationPath string

作業項目が含まれる名前付きスプリントまたは期間。
イテレーション パスの比較
 iterationPathComparison string

イテレーション パス フィールドの比較時に使用されるルール。
優先順位
 wiql__Microsoft_VSTS_Common_Priority string

ビジネスに関連するバグ、問題、タスク、またはテスト ケースの主観的な評価。
作成者
wiql__System_CreatedBy string

作業項目を作成したチーム メンバーの名前。

戻り値

この操作の出力は状況に応じて変わります。

作業項目が閉じられたとき [非推奨]

操作 ID:
OnWorkItemClosed

このアクションは非推奨になりました。 代わりに、作業項目が閉じているときを使用してください。

指定された基準に一致する作業項目が閉じられると、フローがトリガーされます。

パラメーター

名前 キー 必須 型 説明
組織名
 account True string

組織の名前。 これは、{Organization}.visualstudio.com などのインスタンス URL にあります。 組織では、操作のエラーを防ぐために、「OAuth を介したサード パーティ アプリケーション アクセス」を有効にする必要があります。
プロジェクト名
 project True string

指定した組織内のプロジェクトの名前です。
チーム名 (割り当て先ユーザー/グループを選択するため)
 team string

割り当て先を選択するチームの名前。
割り当て先
 wiql__System_AssignedTo string

現在作業項目を所有しているチーム メンバーの名前。
タイプ
 wiql__System_WorkItemType string

作業項目タイプの名前。
領域パス
 wiql__System_AreaPath string

作業項目が含まれる製品機能またはチーム領域。
領域パスの比較
 areaPathComparison string

領域パス フィールドの比較時に使用されるルール。
イテレーション パス
 wiql__System_IterationPath string

作業項目が含まれる名前付きスプリントまたは期間。
イテレーション パスの比較
 iterationPathComparison string

イテレーション パス フィールドの比較時に使用されるルール。
優先順位
 wiql__Microsoft_VSTS_Common_Priority string

ビジネスに関連するバグ、問題、タスク、またはテスト ケースの主観的な評価。
チーム プロジェクト
 wiql__System_TeamProject string

この作業項目が属するチーム プロジェクト。
作成者
wiql__System_CreatedBy string

作業項目を作成したチーム メンバーの名前。

戻り値

この操作の出力は状況に応じて変わります。

定義

VstsList[Account]

VSTS モデルの一覧。

名前 パス 型 説明
価値
 value array of Account

VSTS モデル

アカウント

アカウント

名前 パス 型 説明
取引先企業 ID
 accountId string

アカウントの ID。
アカウント URI
 accountUri string

アカウントの URI。
アカウント名
 accountName string

アカウントの名前。
アカウント オーナー
 accountOwner string

アカウントの設定所有者です。
組織名
 organizationName string

アカウントに対応する組織名。
口座の種類
 accountType string

口座の種類。

Profile

Profile

名前 パス 型 説明
displayName
 displayName string

ユーザーの表示名
id
 id string

プロファイルを表す一意識別子です。
publicAlias
 publicAlias string

パブリック エイリアスです。
電子メールアドレス
 emailAddress string

取引先担当者のメール アドレスです。
timeStamp
 timeStamp date-time

このプロファイルが前回変更された時刻です。
revision
 revision integer

任意の属性の最大リビジョン番号です。
CoreRevision
 coreRevision integer

CoreRevision

VstsList[TeamSettingsIteration]

VSTS モデルの一覧。

名前 パス 型 説明
価値
 value array of TeamSettingsIteration

VSTS モデル

TeamSettingsIteration

作業 (アジャイル) イテレーション

名前 パス 型 説明
属性
 Attributes TeamIterationAttributes

チームのイテレーション属性
ID
 Id string

リソースの ID。
件名
 Name string

リソースの名前です。
パス
 Path string

イテレーションへの相対パス。
リンク
 _links object

リソースに関連するリンクのコレクション。
URL
 Url string

リソースへの完全な HTTP リンク。

TeamIterationAttributes

チームのイテレーション属性

名前 パス 型 説明
終了日
 FinishDate date-time

終了日のチーム イテレーション属性。
開始日
 StartDate date-time

開始日のチーム イテレーション属性。

リンク

リンク

名前 パス 型 説明
ウェブ
 web WebLinks

Web リンク

Web リンク

名前 パス 型 説明
HTML リンク
 href string

ビルドの詳細のウェブ URL

BuildResult

ビルド結果

名前 パス 型 説明
ビルド ID
 id integer

ビルドの一意識別子。
ビルド番号
 buildNumber string

ビルド番号。
ソース ブランチ
 sourceBranch string

使用されたビルドのソース管理ブランチ。
ソース バージョン
 sourceVersion string

ビルドで使用されたソース管理バージョン。
ステータス
 status string

ビルドの状態。
優先順位
 priority string

ビルドの優先度。
キュー時間
 queueTime date-time

ビルドがキューに入れられた時刻。
開始時間
 startTime date-time

ビルドが開始された時刻。
終了時間
 finishTime date-time

ビルドが終了した時間。
理由
 reason string

ビルドの理由。
結果
 result string

ビルドの結果。
requestedFor
 requestedFor BuildRequestUser

ビルド リクエスト ユーザー
パラメーター
 parameters string

ビルドに渡されるパラメーター (存在する場合)。
定義
 definition BuildResultDefinition

ビルド結果の定義
_links
 _links Links

リンク

BuildRequestUser

ビルド リクエスト ユーザー

名前 パス 型 説明
リクエスト対象
 uniqueName string

ビルドが要求されたユーザーの一意の名前。

BuildResultDefinition

ビルド結果の定義

名前 パス 型 説明
ビルドの定義 ID
 id integer

ビルド定義の識別子。
ビルド定義名
 name string

ビルド定義の名前。

VstsList[BuildResult]

VSTS モデルの一覧。

名前 パス 型 説明
価値
 value array of BuildResult

VSTS モデル

VstsList[GitRepository]

VSTS モデルの一覧。

名前 パス 型 説明
価値
 value array of GitRepository

VSTS モデル

GitRepository

Git リポジトリ

名前 パス 型 説明
リポジトリ ID
 id string

リポジトリの一意の ID。
リポジトリ名
 name string

リポジトリの名前。
リポジトリ ブラウザーの URL
 url string

この URL はリポジトリの API エンドポイントです。
リポジトリのリモート URL
 remoteUrl string

git がこのリポジトリと同期できる URL。

VstsList[GitPush]

VSTS モデルの一覧。

名前 パス 型 説明
値
 value array of GitPush

VSTS モデル

GitPush

Git プッシュ

名前 パス 型 説明
リポジトリ
 repository GitRepository

Git リポジトリ
pushedBy
 pushedBy GitPushUser

Git プッシュ ユーザー
参照の更新
 refUpdates array of GitRefUpdate

このプッシュの一部として更新された参照。
プッシュ ID
 pushId integer

プッシュの一意 ID です。
日
 date date-time

プッシュが作成された日付。

GitPushUser

Git プッシュ ユーザー

名前 パス 型 説明
プッシャー ID
 id string

プッシュを作成したユーザーの一意識別子。
プッシャー名
 displayName string

プッシュを作成したユーザーの名前。
プッシャーの一意の名前
 uniqueName string

プッシュを作成したユーザーの一意の名前。
プッシャー イメージ URL
 imageUrl string

このユーザーの画像への URL。

VstsList[GitPullRequest]

VSTS モデルの一覧。

名前 パス 型 説明
値
 value array of GitPullRequest

VSTS モデル

GitPullRequest

Git のプル要求

名前 パス 型 説明
リポジトリ
 repository GitRepository

Git リポジトリ
プル要求 ID
 pullRequestId integer

プル要求の一意の ID です。
createdBy
 createdBy PullRequestCreatedBy

プル要求を作成したユーザー
作成日
 creationDate date-time

プル要求が作成された日付
クローズ日
 closedDate date-time

プル要求がクローズされた日付 (完了、破棄、または外部マージ)
敬称
 title string

プル要求のタイトル
内容
 description string

プル要求の説明
ソース参照名
 sourceRefName string

プル要求のソースのブランチの名前
ターゲット参照名
 targetRefName string

プル要求のターゲット ブランチの名前
ドラフトである
 isDraft boolean

ドラフト/WIP プル要求
レビューアー
 reviewers array of PullRequestReviewer

このレビューアーが貢献したグループまたはチームです。
レビューアー一覧
 reviewerList string

レビューアーの一意の名前である有効な電子メールをセミコロンで区切った一覧
必須のレビューアー一覧
 requiredReviewerList string

レビューアーの一意の名前 (必須) である有効な電子メールをセミコロンで区切った一覧
コミット
 commits array of GitCommitRef

プル要求に含まれているコミットです。
completionOptions
 completionOptions PullRequestCompletionOptions

プル要求完了オプション
mergeOptions
 mergeOptions PullRequestMergeOptions

プル要求のマージ オプション
マージ失敗メッセージ
 mergeFailureMessage string

設定されている場合、プル要求のマージに失敗した理由です。
closedBy
 closedBy PullRequestClosedBy

プル要求をクローズしたユーザー
autoCompleteSetBy
 autoCompleteSetBy PullRequestAutoCompleteSetBy

プル要求の自動完了を設定したユーザー
URL
 url string

プル要求の URLです。
リモート URL
 remoteUrl string

プル要求へのリモート URL です。
アーティファクト ID
 artifactId string

このプル要求を一意に識別する文字列です。
マージ ID
 mergeId string

プル要求のマージ ID。
コード レビュー ID
 codeReviewId integer

プル要求のコード レビュー ID です。
キュー完了時刻
 completionQueueTime string

キューに登録されたプル要求が完了した最新の日付です。
繰り返しをサポートする
 supportsIterations boolean

True の場合、このプル要求は複数の繰り返しをサポートします。

PullRequestCreatedBy

プル要求を作成したユーザー

名前 パス 型 説明
作成したユーザーの表示名
 displayName string

プル要求を作成したユーザーの表示名です。
作成したユーザーの一意の名前
 uniqueName string

プル要求を作成したユーザーの一意の名前です。
作成したユーザーの ID
 id string

プル要求を作成したユーザーの ID です。
作成したユーザーの画像 URL
 imageUrl string

プル要求を作成したユーザーの画像 URL です。
作成したユーザーの URL
 url string

プル要求を作成したユーザーの URL です。

PullRequestClosedBy

プル要求をクローズしたユーザー

名前 パス 型 説明
クローズしたユーザーの表示名
 displayName string

プル要求をクローズしたユーザーの表示名です。
クローズしたユーザーの一意の名前
 uniqueName string

プル要求をクローズしたユーザーの一意の名前です。
クローズしたユーザーの ID
 id string

プル要求をクローズしたユーザーの ID です。
クローズしたユーザーの画像 URL
 imageUrl string

プル要求をクローズしたユーザーの画像 URL です。
クローズしたユーザーの URL
 url string

プル要求をクローズしたユーザーの URL です。

PullRequestAutoCompleteSetBy

プル要求の自動完了を設定したユーザー

名前 パス 型 説明
自動完了を設定したユーザーの表示名
 displayName string

自動完了を有効にしたユーザーの表示名です。
自動完了を設定したユーザーの一意の名前
 uniqueName string

自動完了を有効にしたユーザーの一意の名前です。
自動完了を設定したユーザーの ID
 id string

自動完了を有効にしたユーザーの ID です。
自動完了を設定したユーザーの画像 URL
 imageUrl string

自動完了を有効にしたユーザーの画像 URL です。
自動完了を設定したユーザーの URL
 url string

自動完了を有効にしたユーザーの URL です。

PullRequestReviewer

プル要求レビューアー

名前 パス 型 説明
レビューアーの表示名
 displayName string

プル要求レビューアーの表示名です。
レビューアーの一意の名前
 uniqueName string

プル要求レビューアーの一意の名前です。
レビューアーの ID
 id string

プル要求レビューアーの ID です。
レビューアーの URL
 url string

プル要求レビューアーの URL です。
辞退した
 hasDeclined boolean

このレビューアーがこのプル要求のレビューを辞退したかどうかを示します。
フラグが設定されている
 isFlagged boolean

このプル要求で、このレビューアーに注意のフラグが設定されているかを示します。
必要
 isRequired boolean

このプル要求に必要なレビューアーかどうかを示します。
投票
 vote integer

プル要求に対する投票: 承認 (10)。提案ありで承認 (5)、投票なし (0)、作成者の待機中 (-5)、拒否 (-10)。
投票の対象
 votedFor array of PullRequestReviewer

このレビューアーが貢献したグループまたはチームです。

PullRequestMergeOptions

プル要求のマージ オプション

名前 パス 型 説明
早送りなし
 noFastForward string

2 つの親、早送りなしの統合。 ソース ブランチは変更されていません。 これが既定の動作です。
リベース
 rebase string

ソース ブランチをターゲット ブランチの HEAD コミットの上にリベースし、ターゲット ブランチを早送りします。
マージをリベースする
 rebaseMerge string

ソース ブランチをターゲット ブランチの HEAD コミットの上にリベースし、2 つの親を持つ早送りなしのマージを作成します。
スカッシュ
 squash string

プル要求のすべての変更を、1 つの親を持つコミットに移動します。

PullRequestMergeStrategy

プル要求のマージ戦略

名前 パス 型 説明
競合作成者コミット
 conflictAuthorshipCommits boolean

True の場合、Git の成者情報を保持するために、マージ中に適用された競合解決を個別のコミットに移動します。
名前変更の誤検知を検出する
 detectRenameFalsePositives boolean

True の場合、名前変更の誤検知を検出します。
名前変更を無効にする
 disableRenames boolean

True の場合、マージ中に名前変更の検出は実行されません。

PullRequestCompletionOptions

プル要求完了オプション

名前 パス 型 説明
自動完了を無視する構成 ID
 autoCompleteIgnoreConfigIds array of integer

自動完了が待機し得ないポリシー構成 ID の一覧
ポリシーを無視する
 bypassPolicy boolean

True の場合、プル要求の実行中にポリシーが明示的に無視されます。
無視の理由
 bypassReason string

ポリシーを無視する場合、これが無視を使用する理由として保存されます。
ソース ブランチを削除する
 deleteSourceBranch boolean

True の場合、完了後にプル要求のソース ブランチが削除されます。
マージ コミット メッセージ
 mergeCommitMessage string

設定されている場合、マージ コミットのコミット メッセージとして、これが使用されます。
mergeStrategy
 mergeStrategy PullRequestMergeStrategy

プル要求のマージ戦略
スクワッシュ マージ
 squashMerge boolean

MergeStrategy を設定しない場合のマージ戦略は、このフラグが False であれば早送りなしになり、True であればスクワッシュになります。
作業項目を移行する
 transitionWorkItems boolean

True の場合、プル要求にリンクされた作業項目を次の論理状態 (たとえば Active から Resolved など) に移行します。

CommitGitUserDate

Git ユーザーの日付のコミット

名前 パス 型 説明
ユーザー日付のコミット
 date string

Git 操作の日付です。
ユーザーの電子メールのコミット
 email string

Git 操作を実行しているユーザーの電子メール アドレスです。
イメージの URL のコミット
 imageUrl string

ユーザーのアバターの URL です。
ユーザー名のコミット
 name string

Git 操作を実行しているユーザーの名前です。

GitCommitRef

Git のコミット参照

名前 パス 型 説明
作成者
 author CommitGitUserDate

Git ユーザーの日付のコミット
コメントのコミット
 comment string

コミットのコメントまたはメッセージです。
コミットのコメントが切り詰められました
 commentTruncated string

Git コミット の完全なコメント メッセージのコメントが切り詰められたかどうかを示します。
コミット ID
 commitId string

コミットの ID です。
コミッター
 committer CommitGitUserDate

Git ユーザーの日付のコミット
親
 parents array of string

このコミットの親コミットの ID の列挙です。
リモート URL のコミット
 remoteUrl string

リモートのコミットへの URL パスです。
URL のコミット
 url string

このリソースの REST URL です。

GitRefUpdate

Git 参照の更新

名前 パス 型 説明
参照名
 name string

更新された Git 参照の名前。
リポジトリ ID
 repositoryId string

リポジトリの一意の ID。
古いコミット ID
 oldObjectId string

更新前にこの参照が指していた前のコミットの ID。
新しいコミット ID
 newObjectId string

この参照が更新前に指し示した新しいコミットの ID。

VstsList[Project]

VSTS モデルの一覧。

名前 パス 型 説明
価値
 value array of Project

VSTS モデル

Project

Project

名前 パス 型 説明
プロジェクト ID
 id string

プロジェクトの一意識別子です。
プロジェクト名
 name string

プロジェクトの名前です。
プロジェクト URL
 url string

プロジェクトの API URL です。

VstsList[ReleaseDefinition]

VSTS モデルの一覧。

名前 パス 型 説明
価値
 value array of ReleaseDefinition

VSTS モデル

ReleaseDefinition

リリース定義

名前 パス 型 説明
コメント
 Comment string

リリース定義のコメント。
作成日
CreatedOn date-time

リリース定義が作成された日付。
内容
 Description string

リリース定義の説明。
ID
 Id integer

リリース定義の一意識別子。
ModifiedBy
 ModifiedBy IdentityRef

ID 参照
変更日
 ModifiedOn date-time

リリース定義が変更された日付。
件名
 Name string

リリース定義の名前。
パス
 Path string

リリース定義のパス。
リリース名の形式
 ReleaseNameFormat string

リリース定義のリリース名の形式。
改訂
 Revision integer

リリース定義のリビジョン番号。
ソース
 Source string

リリース定義のソース。
タグ
 Tags array of string

リリース定義のタグのリスト。
URL
 Url string

リリース定義にアクセスするための URL。

IdentityRef

ID 参照

名前 パス 型 説明
ディレクトリ エイリアス
 DirectoryAlias string

ID 参照のディレクトリ エイリアス。
表示名
 DisplayName string

ID 参照の表示名。
一意の名前
 UniqueName string

ID 参照の一意の名前。
URL
 Url string

ID 参照の URL。
ID
 Id string

ID 参照の ID です。

ReleaseDefinitionShallowReference

リリース定義シャロー参照

名前 パス 型 説明
ID
 Id integer

リリース定義の一意識別子。
件名
 Name string

リリース定義の名前。
URL
 Url string

リリース定義にアクセスするための REST API URL。

オブジェクト

ObjectWithoutType

リリース

リリース

名前 パス 型 説明
コメント
 Comment string

リリースのコメント。
CreatedBy
 CreatedBy IdentityRef

ID 参照
作成日
CreatedOn date-time

リリースが作成された日付。
内容
 Description string

リリースの説明。
ID
 Id integer

リリースの一意識別子。
キープし続ける
 KeepForever boolean

リリースを保持ポリシーから除外するかどうか。
ログ コンテナの URL
 LogsContainerUrl string

このリリースのログ コンテナ URL。
ModifiedBy
 ModifiedBy IdentityRef

ID 参照
変更日
 ModifiedOn date-time

リリースが変更された日付。
件名
 Name string

リリースの名前。
理由
 Reason string

リリースの理由。
ReleaseDefinition
 ReleaseDefinition ReleaseDefinitionShallowReference

リリース定義シャロー参照
ステータス
 Status string

リリースの状態。
URL
 Url string

リリースの URL。

VstsList[TfvcChangeset]

VSTS モデルの一覧。

名前 パス 型 説明
値
 value array of TfvcChangeset

VSTS モデル

TfvcChangeset

Team Foundation バージョン管理変更セット

名前 パス 型 説明
変更セット ID
 changesetId integer

変更セットの一意 ID です。
作成者
 author ChangesetAuthor

変更セット作成者
checkedInBy
 checkedInBy ChangesetCheckedInBy

チェック イン者による変更セット
作成日
 createdDate date-time

変更セットが作成された日時です。
コメント
 comment string

変更セットを説明するコメント。

ChangesetAuthor

変更セット作成者

名前 パス 型 説明
作成者名
 displayName string

変更セットを作成したユーザーの名前。
著者の一意の名前
 uniqueName string

変更セットを作成したユーザーの名前。

ChangesetCheckedInBy

チェック イン者による変更セット

名前 パス 型 説明
名前でチェック イン
 displayName string

変更セットをチェック インしたユーザーの名前。
一意の名前でチェック イン
 uniqueName string

変更セットを作成したユーザーの名前。

VstsList[WorkItemType]

VSTS モデルの一覧。

名前 パス 型 説明
値
 value array of WorkItemType

VSTS モデル。

WorkItemType

作業項目タイプ

名前 パス 型 説明
内容
 Description string

タイプの説明。
件名
 Name string

タイプの名前。
XML フォーム
 XmlForm string

タイプの XML 表現。
Fields
 FieldInstances array of WorkItemTypeFieldInstance

タイプに関連付けられているフィールド インスタンスのリスト。
アイコン ID
 icon.id string

アイコンの識別子
アイコンの URL
 icon.url string

リソースの REST URL

WorkItemTypeFieldInstance

作業項目タイプ フィールド インスタンス

名前 パス 型 説明
常に必要
 AlwaysRequired boolean

フィールド インスタンスが常に必要かどうかを指定します。
参照名
 ReferenceName string

フィールド インスタンスの参照名。
件名
 Name string

フィールド インスタンスの名前。
URL
 Url string

フィールド インスタンスの詳細を指す URL。

VstsList[JObject]

VSTS モデルの一覧。

名前 パス 型 説明
値
 value array of Object

VSTS モデル

VstsList[QueryHierarchyItem]

VSTS モデルの一覧。

名前 パス 型 説明
値
 value array of QueryHierarchyItem

VSTS モデル

QueryHierarchyItem

クエリ階層アイテム

名前 パス 型 説明
子
 Children array of QueryHierarchyItem

クエリ階層アイテムに関連付けられている子アイテムのリスト。
条項
 Clauses WorkItemQueryClause

作業項目クエリ句
列
 Columns array of WorkItemFieldReference

クエリ階層アイテムに関連付けられている作業項目フィールド列のリスト。
フィルター オプション
 FilterOptions string

クエリ階層アイテムのフィルター オプション。
子供あり
 HasChildren boolean

クエリ階層アイテムに子があるかどうかを指定します。
ID
 Id string

クエリ階層アイテムの一意識別子。
削除済み
 IsDeleted boolean

クエリ階層アイテムを削除するかどうかを指定します。
フォルダー
 IsFolder boolean

クエリ階層アイテムがフォルダーであるかどうかを指定します。
無効な構文です
 IsInvalidSyntax boolean

クエリ階層アイテムの構文が無効かどうかを指定します。
パブリックである
 IsPublic boolean

クエリ階層アイテムを公開にするかどうかを指定します。
LinkClauses
 LinkClauses WorkItemQueryClause

作業項目クエリ句
件名
 Name string

クエリ階層アイテムの名前。
パス
 Path string

クエリ階層アイテムのパス。
クエリの種類
 QueryType string

クエリ階層アイテムのクエリ タイプ。
列を並べ替える
 SortColumns array of WorkItemQuerySortColumn

クエリ階層アイテムの並べ替え列のリスト。
SourceClauses
 SourceClauses WorkItemQueryClause

作業項目クエリ句
TargetClauses
 TargetClauses WorkItemQueryClause

作業項目クエリ句
Wiql
 Wiql string

クエリ階層アイテムの WIQL。
リンク
 _links object

クエリ階層アイテムに関連するリンクのコレクション。
URL
 Url string

クエリ階層アイテムへの完全な HTTP リンク。

WorkItemQueryClause

作業項目クエリ句

名前 パス 型 説明
条項
 Clauses WorkItemQueryClause

作業項目クエリ句
フィールド
 Field WorkItemFieldReference

作業項目フィールド参照
FieldValue
 FieldValue WorkItemFieldReference

作業項目フィールド参照
フィールド値
 IsFieldValue boolean

作業項目のクエリ句がフィールド値であるかどうかを指定します。
論理演算子
 LogicalOperator string

作業項目クエリ句の論理演算子。
演算子
 Operator WorkItemFieldOperation

作業項目フィールド操作
値
 Value string

作業項目クエリ句の値。

WorkItemFieldReference

作業項目フィールド参照

名前 パス 型 説明
件名
 Name string

作業項目フィールドの参照。
参照名
 ReferenceName string

作業項目フィールド参照の参照名。
URL
 Url string

作業項目フィールド参照の URL。

WorkItemQuerySortColumn

作業項目クエリの並べ替え列

名前 パス 型 説明
降順
 Descending boolean

作業項目のクエリの並べ替え列が降順であるかどうかを指定します。
フィールド
 Field WorkItemFieldReference

作業項目フィールド参照

WorkItemFieldOperation

作業項目フィールド操作

名前 パス 型 説明
件名
 Name string

作業項目フィールド操作の名前。
参照名
 ReferenceName string

作業項目フィールド操作の参照名。

パイプライン

名前 パス 型 説明
件数
 count integer

件数
価値
 value array of object

すべてのパイプラインのリストを含む配列
href
 value._links.self.href string

href
href
 value._links.web.href string

href
フォルダー
 value.folder string

フォルダー
id
 value.id integer

id
name
 value.name string

name
revision
 value.revision integer

revision
url
 value.url string

url

[ファイル名を指定して実行]

名前 パス 型 説明
件数
 count integer

件数
価値
 value array of object

パイプラインの実行
href
 value._links.self.href string
href
 value._links.web.href string
href
 value._links.pipeline.web.href string
href
 value._links.pipeline.href string
url
 value.pipeline.url string
id
 value.pipeline.id integer
revision
 value.pipeline.revision integer
name
 value.pipeline.name string
フォルダー
 value.pipeline.folder string
都道府県
 value.state RunState

実行状態
createdDate
 value.createdDate string

作成日
url
 value.url string

パイプラインの URL
id
 value.id integer

パイプライン ID
name
 value.name string

name
result
 value.result RunResult

実行結果
finishedDate
 value.finishedDate string

実行の終了日

RunResult

実行結果

実行結果

string

RunState

実行状態

実行状態

string