Freigeben über

Check Evaluations - Evaluate

  • Referenz
Dienst:
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
Mit optionalen Parametern: 
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 (uuid)

resources

Resource[]

Antworten

Name Typ Beschreibung
200 OK

CheckSuite

Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name Beschreibung
vso.build_execute Gewährt die Möglichkeit, auf Build-Artefakte zuzugreifen, einschließlich Build-Ergebnisse, Definitionen und Anfragen, sowie die Möglichkeit, einen Build in die Warteschlange zu stellen, Build-Eigenschaften zu aktualisieren und über Dienst-Hooks Benachrichtigungen über Build-Ereignisse zu erhalten.

Beispiele

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
200 
request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context
{
  "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-Referenzverknüpfungslinks darstellt.
Resource

CheckConfigurationRef

Objekt
Name Typ Beschreibung
id

integer (int32)

Ü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 eine die konfigurierte Prüfung abrufen kann.

CheckRun

Objekt
Name Typ Beschreibung
checkConfigurationRef

CheckConfigurationRef

completedDate

string (date-time)

createdDate

string (date-time)

id

string (uuid)

resultMessage

string

status

CheckRunStatus

CheckRunStatus

Enumeration
Wert Beschreibung
all
approved
canceled
completed
failed
none
queued
rejected
running
timedOut

CheckSuite

Objekt
Name Typ Beschreibung
_links

ReferenceLinks

Referenzlinks.
checkRuns

CheckRun[]

Liste der Überprüfungsläufe, die der angegebenen Check Suite-Anforderung zugeordnet sind.
completedDate

string (date-time)

Abschlussdatum der angegebenen Check-Suite-Anforderung
context

JObject

Auswertungskontext für die Check Suite-Anforderung
id

string (uuid)

Die eindeutige Suite-ID, die vom Pipeline-Orchestrator für die Pipelineüberprüfung generiert wird, führt Anforderungen in der Liste der Ressourcenpipeline-Orchestrator aus, die diesen Bezeichner verwendet, um die Überprüfungsanforderungen in einer Phase zuzuordnen.
message

string

Optionale Nachricht für die angegebene Check Suite-Anforderung
status

CheckRunStatus

Die Überprüfung führt den Status für die angegebene Suite-Anforderung insgesamt aus. Dies ist der Status der Suite überprüfen

CheckSuiteExpandParameter

Enumeration
Wert Beschreibung
none
resources

CheckSuiteRequest

Objekt
Name Typ Beschreibung
context

JObject

Stellt ein JSON-Objekt dar.
id

string (uuid)

resources

Resource[]

CheckType

Objekt
Name Typ Beschreibung
id

string (uuid)

Ruft die Überprüfungstyp-ID ab oder legt sie fest.
name

string

Name des Überprüfungstyps.

JObject

Objekt

Stellt ein JSON-Objekt dar.

Name Typ Beschreibung
item

string (JToken)

type

string (JTokenType)

Ruft den Knotentyp für dieses JToken ab.
Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

Resource

Objekt
Name Typ Beschreibung
id

string

ID der Ressource.
name

string

Der Name der Ressource.
type

string

Typ der Ressource.