Check Evaluations - Evaluate

Referência

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Iniciar uma avaliação para um marcar em um 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

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 essa versão da API.
$expand	query		CheckSuiteExpandParameter

Corpo da solicitação

Nome	Tipo	Description
context	JObject	Representa um objeto JSON.
id	string
resources	Resource[]

Respostas

Nome	Tipo	Description
200 OK	CheckSuite	operação bem-sucedida

Segurança

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

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

Exemplos

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

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

Nome	Tipo	Description
id	integer	Verifique a ID de configuração.
resource	Resource	Recurso no qual marcar ser configurado.
type	CheckType	Verificar tipo de configuração
url	string	A URL da qual é possível buscar o marcar configurado.

CheckRun

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

CheckRunStatus

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

CheckSuite

Nome	Tipo	Description
_links	ReferenceLinks	Links de referência.
checkRuns	CheckRun[]	Lista de execuções de marcar associadas à solicitação de pacote de marcar fornecida.
completedDate	string	Data de conclusão da solicitação de pacote de marcar fornecida
context	JObject	Contexto de avaliação para a solicitação do pacote de marcar
id	string	ID de pacote exclusiva gerada pelo orquestrador de pipeline para o pipeline marcar executa a solicitação na lista de recursos O orquestrador de pipeline usará esse identificador para mapear as solicitações de marcar em um estágio
message	string	Mensagem opcional para a solicitação de pacote de marcar fornecida
status	CheckRunStatus	O marcar geral é executado status para a solicitação de pacote fornecida. Este é marcar pacote status

CheckSuiteExpandParameter

Nome	Tipo	Description
none	string
resources	string

CheckSuiteRequest

Nome	Tipo	Description
context	JObject	Representa um objeto JSON.
id	string
resources	Resource[]

CheckType

Nome	Tipo	Description
id	string	Obtém ou define marcar id do tipo.
name	string	Nome do tipo marcar.

JObject

Representa um objeto JSON.

Nome	Tipo	Description
item	string
type	string	Obtém o tipo de nó para este JToken.

ReferenceLinks

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

Nome	Tipo	Description
id	string	ID do recurso.
name	string	Nome do recurso.
type	string	Tipo do recurso.

Compartilhar via