Check Evaluations - Evaluate

Referenz

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Initiieren einer Auswertung für eine Überprüfung in einer Pipeline

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-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path	True	string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.
$expand	query		CheckSuiteExpandParameter

Anforderungstext

Name	Typ	Beschreibung
context	JObject	Stellt ein JSON-Objekt dar.
id	string
resources	Resource[]

Antworten

Name	Typ	Beschreibung
200 OK	CheckSuite	Erfolgreicher Vorgang

Sicherheit

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

Name	Beschreibung
vso.build_execute	Ermöglicht den Zugriff auf Buildartefakte, einschließlich Buildergebnissen, Definitionen und Anforderungen, sowie die Möglichkeit, einen Build in eine Warteschlange zu stellen, Buildeigenschaften zu aktualisieren und Benachrichtigungen über Buildereignisse über Diensthaken zu empfangen.

Beispiele

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
  }
}

Definitionen

Name	Beschreibung
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckSuiteRequest
CheckType
JObject	Stellt ein JSON-Objekt dar.
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
Resource

CheckConfigurationRef

Name	Typ	Beschreibung
id	integer	Überprüfen Sie die Konfigurations-ID.
resource	Resource	Ressource, für die die Überprüfung konfiguriert wird.
type	CheckType	Überprüfen des Konfigurationstyps
url	string	Die URL, aus der die konfigurierte Überprüfung abgerufen werden kann.

CheckRun

Name	Typ	Beschreibung
checkConfigurationRef	CheckConfigurationRef
completedDate	string
createdDate	string
id	string
resultMessage	string
status	CheckRunStatus

CheckRunStatus

Name	Typ	Beschreibung
all	string
approved	string
canceled	string
completed	string
failed	string
none	string
queued	string
rejected	string
running	string
timedOut	string

CheckSuite

Name	Typ	Beschreibung
_links	ReferenceLinks	Verweislinks.
checkRuns	CheckRun[]	Liste der Prüfausführungen, die der angegebenen Check Suite-Anforderung zugeordnet sind.
completedDate	string	Abgeschlossenes Datum der angegebenen Check Suite-Anforderung
context	JObject	Auswertungskontext für die Check Suite-Anforderung
id	string	Eindeutige Suite-ID, die vom Pipelineororor für die Anforderung zur Ausführung der Pipelineüberprüfung für die Liste der Ressourcen generiert wurde. Pipeline orchestrator verwendet diesen Bezeichner, um die Überprüfungsanforderungen in einer Phase zuzuordnen.
message	string	Optionale Nachricht für die angegebene Check Suite-Anforderung
status	CheckRunStatus	Die Gesamtüberprüfung wird status für die angegebene Suiteanforderung ausgeführt. Dies ist check suite status

CheckSuiteExpandParameter

Name	Typ	Beschreibung
none	string
resources	string

CheckSuiteRequest

Name	Typ	Beschreibung
context	JObject	Stellt ein JSON-Objekt dar.
id	string
resources	Resource[]

CheckType

Name	Typ	Beschreibung
id	string	Ruft die Überprüfungstyp-ID ab oder legt diese fest.
name	string	Name des Überprüfungstyps.

JObject

Stellt ein JSON-Objekt dar.

Name	Typ	Beschreibung
item	string
type	string	Ruft den Knotentyp für dieses JToken ab.

ReferenceLinks

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

Resource

Name	Typ	Beschreibung
id	string	Id der Ressource.
name	string	Der Name der Ressource.
type	string	Der Typ der Ressource.

Freigeben über