Check Evaluations - Evaluate

リファレンス

Service:: Approvals And Checks

API Version:: 7.1-preview.1

パイプライン内のチェックの評価を開始する

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/runs?api-version=7.1-preview.1

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/runs?$expand={$expand}&api-version=7.1-preview.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。
$expand	query		CheckSuiteExpandParameter

要求本文

名前	型	説明
context	JObject	JSON オブジェクトを表します。
id	string
resources	Resource[]

応答

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

セキュリティ

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

例

Sample Request

HTTP

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/runs?api-version=7.1-preview.1

{
  "id": "64dc0df7-f224-4b3b-a251-f67cbe9cf7a3",
  "resources": [
    {
      "type": "queue",
      "id": "1",
      "name": "Default"
    }
  ],
  "context": {
    "PlanId": 1,
    "Pipeline.Id": 2,
    "GraphNode.Id": 3
  }
}

Sample Response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

{
  "status": "canceled",
  "message": "",
  "completedDate": "2020-11-19T12:59:09.6567354Z",
  "checkRuns": [
    {
      "id": "c579b5e1-9722-42e1-981e-63e004e6cb69",
      "createdDate": "2020-11-19T12:59:09.6567354Z",
      "completedDate": "2020-11-19T12:59:09.6567354Z",
      "checkConfigurationRef": {
        "id": 15,
        "type": {
          "id": "e1a1fc6c-c278-4492-ae1c-c42f8697612c",
          "name": "Authorization"
        },
        "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/15",
        "resource": {
          "type": "queue",
          "id": "1"
        }
      },
      "status": "canceled",
      "resultMessage": "Check aborted. This could be because the run was canceled or another check on the stage failed."
    }
  ],
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/runs"
    }
  },
  "id": "64dc0df7-f224-4b3b-a251-f67cbe9cf7a3",
  "context": {
    "PlanId": 1,
    "Pipeline.Id": 2,
    "GraphNode.Id": 3
  }
}

定義

名前	説明
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckSuiteRequest
CheckType
JObject	JSON オブジェクトを表します。
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。
Resource

CheckConfigurationRef

名前	型	説明
id	integer	構成 ID を確認します。
resource	Resource	チェック構成されるリソース。
type	CheckType	構成の種類を確認する
url	string	構成されたチェックをフェッチできる URL。

CheckRun

名前	型	説明
checkConfigurationRef	CheckConfigurationRef
completedDate	string
createdDate	string
id	string
resultMessage	string
status	CheckRunStatus

CheckRunStatus

名前	型	説明
all	string
approved	string
canceled	string
completed	string
failed	string
none	string
queued	string
rejected	string
running	string
timedOut	string

CheckSuite

名前	型	説明
_links	ReferenceLinks	参照リンク。
checkRuns	CheckRun[]	特定のチェックスイート要求に関連付けられているチェック実行の一覧。
completedDate	string	特定のチェックスイート要求の完了日
context	JObject	チェックスイート要求の評価コンテキスト
id	string	パイプラインオーケストレーターによってパイプラインオーケストレーターによって生成された一意のスイート ID チェックパイプラインオーケストレーターがこの識別子を使用してステージ上のチェック要求をマップするリソースの一覧で要求を実行します
message	string	指定されたチェックスイート要求の省略可能なメッセージ
status	CheckRunStatus	特定のスイート要求の全体的なチェック実行状態。これはスイートの状態チェックです

CheckSuiteExpandParameter

名前	型	説明
none	string
resources	string

CheckSuiteRequest

名前	型	説明
context	JObject	JSON オブジェクトを表します。
id	string
resources	Resource[]

CheckType

名前	型	説明
id	string	型 ID チェック取得または設定します。
name	string	チェック型の名前。

JObject

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

名前	型	説明
item	string
type	string	この JToken のノードの種類を取得します。

ReferenceLinks

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

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

Resource

名前	型	説明
id	string	リソースの ID。
name	string	リソースの名前。
type	string	リソースの種類。

次の方法で共有