Compartilhar via

Check Evaluations - Evaluate

  • Referência
Serviço:
Approvals And Checks
Versão da API:
7.1-preview.1

Iniciar uma avaliação para uma verificação em um pipeline

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/runs?api-version=7.1-preview.1
Com parâmetros opcionais: 
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/runs?$expand={$expand}&api-version=7.1-preview.1

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
 path True

string

O nome da organização do Azure DevOps.
project
 path True

string

ID do projeto ou nome do projeto
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar esta versão da api.
$expand
 query

CheckSuiteExpandParameter

Corpo da solicitação

Nome Tipo Description
context

JObject

Representa um objeto JSON.
id

string (uuid)

resources

Resource[]

Respostas

Nome Tipo Description
200 OK

CheckSuite

operação bem-sucedida

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

Nome Description
vso.build_execute Concede a capacidade de acessar artefatos de compilação, incluindo resultados de compilação, definições e solicitações, e a capacidade de enfileirar uma compilação, atualizar propriedades de compilação e a capacidade de receber notificações sobre eventos de compilação por meio de hooks de serviço.

Exemplos

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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
  }
}

Definições

Nome Description
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckSuiteRequest
CheckType
JObject

Representa um objeto JSON.
ReferenceLinks

A classe para representar uma coleção de links de referência REST.
Resource

CheckConfigurationRef

Objeto
Nome Tipo Description
id

integer (int32)

Verifique a ID da configuração.
resource

Resource

Recurso no qual a verificação é configurada.
type

CheckType

Verificar o tipo de configuração
url

string

A URL da qual é possível buscar a verificação configurada.

CheckRun

Objeto
Nome Tipo Description
checkConfigurationRef

CheckConfigurationRef

completedDate

string (date-time)

createdDate

string (date-time)

id

string (uuid)

resultMessage

string

status

CheckRunStatus

CheckRunStatus

Enumeração
Valor Description
all
approved
canceled
completed
failed
none
queued
rejected
running
timedOut

CheckSuite

Objeto
Nome Tipo Description
_links

ReferenceLinks

Links de referência.
checkRuns

CheckRun[]

Lista de execuções de verificação associadas à solicitação do pacote de seleção fornecida.
completedDate

string (date-time)

Data concluída da solicitação do pacote de seleção fornecida
context

JObject

Contexto de avaliação para a solicitação do pacote de seleção
id

string (uuid)

ID de pacote exclusivo gerada pelo orquestrador de pipeline para a solicitação de execuções de verificação de pipeline na lista de recursos O orquestrador de pipeline usará esse identificador para mapear as solicitações de verificação em um estágio
message

string

Mensagem opcional para a solicitação do pacote de seleção fornecida
status

CheckRunStatus

A verificação geral executa o status da solicitação de pacote fornecida. Esse é o status do pacote de seleção

CheckSuiteExpandParameter

Enumeração
Valor Description
none
resources

CheckSuiteRequest

Objeto
Nome Tipo Description
context

JObject

Representa um objeto JSON.
id

string (uuid)

resources

Resource[]

CheckType

Objeto
Nome Tipo Description
id

string (uuid)

Obtém ou define a ID do tipo de verificação.
name

string

Nome do tipo de verificação.

JObject

Objeto

Representa um objeto JSON.

Nome Tipo Description
item

string (JToken)

type

string (JTokenType)

Obtém o tipo de nó para este JToken.
Objeto

A classe para representar uma coleção de links de referência REST.

Nome Tipo Description
links

object

A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

Resource

Objeto
Nome Tipo Description
id

string

ID do recurso.
name

string

Nome do recurso.
type

string

Tipo do recurso.