Check Evaluations - Evaluate

Référence

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Lancer une évaluation d’un case activée dans un 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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path	True	string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API.
$expand	query		CheckSuiteExpandParameter

Corps de la demande

Nom	Type	Description
context	JObject	Représente un objet JSON.
id	string
resources	Resource[]

Réponses

Nom	Type	Description
200 OK	CheckSuite	opération réussie

Sécurité

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

Nom	Description
vso.build_execute	Accorde la possibilité d’accéder aux artefacts de build, y compris les résultats de build, les définitions et les demandes, ainsi que la possibilité de mettre en file d’attente une build, de mettre à jour les propriétés de build et de recevoir des notifications sur les événements de build via des hooks de service.

Exemples

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

Définitions

Nom	Description
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckSuiteRequest
CheckType
JObject	Représente un objet JSON.
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
Resource

CheckConfigurationRef

Nom	Type	Description
id	integer	Vérifiez l’ID de configuration.
resource	Resource	Ressource sur laquelle case activée être configurés.
type	CheckType	Vérifier le type de configuration
url	string	URL à partir de laquelle vous pouvez extraire le case activée configuré.

CheckRun

Nom	Type	Description
checkConfigurationRef	CheckConfigurationRef
completedDate	string
createdDate	string
id	string
resultMessage	string
status	CheckRunStatus

CheckRunStatus

Nom	Type	Description
all	string
approved	string
canceled	string
completed	string
failed	string
none	string
queued	string
rejected	string
running	string
timedOut	string

CheckSuite

Nom	Type	Description
_links	ReferenceLinks	Liens de référence.
checkRuns	CheckRun[]	Liste des exécutions case activée associées à la demande de suite case activée donnée.
completedDate	string	Date d’achèvement de la demande de suite case activée donnée
context	JObject	Contexte d’évaluation pour la demande de la suite case activée
id	string	ID de suite unique généré par l’orchestrateur de pipeline pour le pipeline case activée exécute la demande dans la liste des ressources L’orchestrateur de pipeline utilisera cet identificateur pour mapper les requêtes case activée sur une phase
message	string	Message facultatif pour la demande de suite case activée donnée
status	CheckRunStatus	Dans l’ensemble, case activée s’exécute status pour la demande de suite donnée. Il s’agit de case activée suite status

CheckSuiteExpandParameter

Nom	Type	Description
none	string
resources	string

CheckSuiteRequest

Nom	Type	Description
context	JObject	Représente un objet JSON.
id	string
resources	Resource[]

CheckType

Nom	Type	Description
id	string	Obtient ou définit case activée’ID de type.
name	string	Nom du type case activée.

JObject

Représente un objet JSON.

Nom	Type	Description
item	string
type	string	Obtient le type de nœud pour ce JToken.

ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

Resource

Nom	Type	Description
id	string	ID de la ressource.
name	string	Nom de la ressource.
type	string	Type de la ressource.

Partager via