Udostępnij przez

Check Evaluations - Evaluate

  • Odwołanie
Usługa:
Approvals And Checks
Wersja interfejsu API:
7.1-preview.1

Inicjowanie oceny sprawdzania w potoku

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
organization
 path True

string

Nazwa organizacji usługi Azure DevOps.
project
 path True

string

Identyfikator projektu lub nazwa projektu
api-version
 query True

string

Wersja interfejsu API do użycia. Należy ustawić wartość "7.1-preview.1", aby używać tej wersji interfejsu API.
$expand
 query

CheckSuiteExpandParameter

Treść żądania

Nazwa Typ Opis
context

JObject

Reprezentuje obiekt JSON.
id

string (uuid)

resources

Resource[]

Odpowiedzi

Nazwa Typ Opis
200 OK

CheckSuite

operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa Opis
vso.build_execute Umożliwia dostęp do artefaktów kompilacji, w tym wyników kompilacji, definicji i żądań oraz możliwość kolejkowania kompilacji, aktualizowania właściwości kompilacji oraz odbierania powiadomień o zdarzeniach kompilacji za pośrednictwem punktów zaczepienia usługi.

Przykłady

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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
  }
}

Definicje

Nazwa Opis
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckSuiteRequest
CheckType
JObject

Reprezentuje obiekt JSON.
ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.
Resource

CheckConfigurationRef

Objekt
Nazwa Typ Opis
id

integer (int32)

Sprawdź identyfikator konfiguracji.
resource

Resource

Zasób, na którym sprawdź, czy skonfigurowano.
type

CheckType

Sprawdzanie typu konfiguracji
url

string

Adres URL, z którego można pobrać skonfigurowane sprawdzanie.

CheckRun

Objekt
Nazwa Typ Opis
checkConfigurationRef

CheckConfigurationRef

completedDate

string (date-time)

createdDate

string (date-time)

id

string (uuid)

resultMessage

string

status

CheckRunStatus

CheckRunStatus

Wyliczanie
Wartość Opis
all
approved
canceled
completed
failed
none
queued
rejected
running
timedOut

CheckSuite

Objekt
Nazwa Typ Opis
_links

ReferenceLinks

Linki referencyjne.
checkRuns

CheckRun[]

Lista przebiegów sprawdzania skojarzonych z danym żądaniem pakietu kontrolnego.
completedDate

string (date-time)

Data ukończenia danego żądania pakietu kontrolnego
context

JObject

Kontekst oceny dla żądania pakietu sprawdzania
id

string (uuid)

Unikatowy identyfikator pakietu wygenerowany przez koordynatora potoku dla żądania uruchomienia potoku na liście zasobów Orkiestrator potoku będzie używać tego identyfikatora do mapowania żądań sprawdzania na etapie
message

string

Opcjonalna wiadomość dla danego żądania pakietu kontrolnego
status

CheckRunStatus

Ogólny stan przebiegów sprawdzania dla danego żądania pakietu. To jest sprawdzanie stanu pakietu

CheckSuiteExpandParameter

Wyliczanie
Wartość Opis
none
resources

CheckSuiteRequest

Objekt
Nazwa Typ Opis
context

JObject

Reprezentuje obiekt JSON.
id

string (uuid)

resources

Resource[]

CheckType

Objekt
Nazwa Typ Opis
id

string (uuid)

Pobiera lub ustawia identyfikator typu sprawdzania.
name

string

Nazwa typu sprawdzania.

JObject

Objekt

Reprezentuje obiekt JSON.

Nazwa Typ Opis
item

string (JToken)

type

string (JTokenType)

Pobiera typ węzła dla tego tokenu JToken.
Objekt

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa Typ Opis
links

object

Czytelny widok linków. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

Resource

Objekt
Nazwa Typ Opis
id

string

Identyfikator zasobu.
name

string

Nazwa zasobu.
type

string

Typ zasobu.