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 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path	True	string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為 '7.1-preview.1' 以使用此版本的 API。
$expand	query		CheckSuiteExpandParameter

要求本文

名稱	類型	Description
context	JObject	表示 JSON 物件。
id	string
resources	Resource[]

回應

名稱	類型	Description
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

名稱	Description
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
  }
}

定義

名稱	Description
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckSuiteRequest
CheckType
JObject	表示 JSON 物件。
ReferenceLinks	表示 REST 參考連結集合的類別。
Resource

CheckConfigurationRef

名稱	類型	Description
id	integer	檢查組態識別碼。
resource	Resource	檢查設定的資源。
type	CheckType	檢查組態類型
url	string	可從中擷取已設定檢查的 URL。

CheckRun

名稱	類型	Description
checkConfigurationRef	CheckConfigurationRef
completedDate	string
createdDate	string
id	string
resultMessage	string
status	CheckRunStatus

CheckRunStatus

名稱	類型	Description
all	string
approved	string
canceled	string
completed	string
failed	string
none	string
queued	string
rejected	string
running	string
timedOut	string

CheckSuite

名稱	類型	Description
_links	ReferenceLinks	參考連結。
checkRuns	CheckRun[]	與指定檢查套件要求相關聯的檢查執行清單。
completedDate	string	指定檢查套件要求的完成日期
context	JObject	檢查套件要求的評估內容
id	string	管線協調器針對管線檢查執行要求所產生的唯一套件識別碼，會在資源管線協調器清單中使用此識別碼來對應階段上的檢查要求
message	string	指定檢查套件要求的選擇性訊息
status	CheckRunStatus	給定套件要求的整體檢查執行狀態。這是檢查套件狀態

CheckSuiteExpandParameter

名稱	類型	Description
none	string
resources	string

CheckSuiteRequest

名稱	類型	Description
context	JObject	表示 JSON 物件。
id	string
resources	Resource[]

CheckType

名稱	類型	Description
id	string	取得或設定檢查類型識別碼。
name	string	檢查類型的名稱。

JObject

表示 JSON 物件。

名稱	類型	Description
item	string
type	string	取得這個 JToken 的節點類型。

ReferenceLinks

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

Resource

名稱	類型	Description
id	string	資源的識別碼。
name	string	資源名稱。
type	string	資源類型。

共用方式為