Check Evaluations - Evaluate

Service:

Approvals And Checks

API Version:

7.1-preview.1

Inicio de una evaluación para una comprobación en una canalización

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	El nombre de la organización de Azure DevOps.
project	path	True	string	Id. de proyecto o nombre del proyecto
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1-preview.1" para usar esta versión de la API.
$expand	query		CheckSuiteExpandParameter

Cuerpo de la solicitud

Nombre	Tipo	Description
context	JObject	Representa un objeto JSON.
id	string
resources	Resource[]

Respuestas

Nombre	Tipo	Description
200 OK	CheckSuite	operación correcta

Seguridad

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

Nombre	Description
vso.build_execute	Concede la capacidad de acceder a los artefactos de compilación, incluidos los resultados de compilación, las definiciones y las solicitudes, y la capacidad de poner en cola una compilación, actualizar las propiedades de compilación y la capacidad de recibir notificaciones sobre eventos de compilación a través de enlaces de servicio.

Ejemplos

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

Definiciones

Nombre	Description
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckSuiteRequest
CheckType
JObject	Representa un objeto JSON.
ReferenceLinks	Clase que representa una colección de vínculos de referencia de REST.
Resource

CheckConfigurationRef

Nombre	Tipo	Description
id	integer	Compruebe el identificador de configuración.
resource	Resource	Recurso en el que se configura la comprobación.
type	CheckType	Comprobación del tipo de configuración
url	string	Dirección URL desde la que se puede capturar la comprobación configurada.

CheckRun

Nombre	Tipo	Description
checkConfigurationRef	CheckConfigurationRef
completedDate	string
createdDate	string
id	string
resultMessage	string
status	CheckRunStatus

CheckRunStatus

Nombre	Tipo	Description
all	string
approved	string
canceled	string
completed	string
failed	string
none	string
queued	string
rejected	string
running	string
timedOut	string

CheckSuite

Nombre	Tipo	Description
_links	ReferenceLinks	Vínculos de referencia.
checkRuns	CheckRun[]	Lista de ejecuciones de comprobación asociadas a la solicitud de conjunto de comprobación especificada.
completedDate	string	Fecha de finalización de la solicitud de conjunto de comprobación especificada
context	JObject	Contexto de evaluación para la solicitud del conjunto de comprobación
id	string	Identificador de conjunto único generado por el orquestador de canalización para la solicitud de ejecución de comprobación de canalización en la lista de recursos Orquestador de canalización usará este identificador para asignar las solicitudes de comprobación en una fase.
message	string	Mensaje opcional para la solicitud de conjunto de comprobación especificada
status	CheckRunStatus	La comprobación general ejecuta el estado de la solicitud de conjunto de aplicaciones especificada. Se trata de la comprobación del estado del conjunto de aplicaciones

CheckSuiteExpandParameter

Nombre	Tipo	Description
none	string
resources	string

CheckSuiteRequest

Nombre	Tipo	Description
context	JObject	Representa un objeto JSON.
id	string
resources	Resource[]

CheckType

Nombre	Tipo	Description
id	string	Obtiene o establece el identificador de tipo de comprobación.
name	string	Nombre del tipo de comprobación.

JObject

Representa un objeto JSON.

Nombre	Tipo	Description
item	string
type	string	Obtiene el tipo de nodo para este JToken.

ReferenceLinks

Clase que representa una colección de vínculos de referencia de REST.

Nombre	Tipo	Description
links	object	Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

Resource

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
type	string	Tipo de recurso.