Check Configurations - Add

Referencia

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Adición de una configuración de comprobación

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations?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.

Cuerpo de la solicitud

Nombre	Tipo	Description
_links	ReferenceLinks	Vínculos de referencia.
createdBy	IdentityRef	Identidad de la persona que configuró la comprobación.
createdOn	string	Hora a la que se configuró la comprobación.
id	integer	Compruebe el identificador de configuración.
isDisabled	boolean	Está deshabilitada.
issue	CheckIssue	Problema conectado para comprobar la configuración.
modifiedBy	IdentityRef	Identidad de la persona que modificó la comprobación configurada.
modifiedOn	string	Hora a la que se modificó la comprobación configurada.
resource	Resource	Recurso en el que se configura la comprobación.
timeout	integer	Tiempo de espera en minutos para 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.

Respuestas

Nombre	Tipo	Description
200 OK	CheckConfiguration	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.
vso.pipelineresources_manage	Concede la capacidad de administrar un recurso protegido o una solicitud de canalización para usar un recurso protegido: grupo de agentes, entorno, cola, repositorio, archivos seguros, conexión de servicio y grupo de variables.

Ejemplos

Approval

Task Check

Approval

Sample Request

HTTP

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations?api-version=7.1-preview.1

{
  "settings": {
    "approvers": [
      {
        "displayName": null,
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1"
      }
    ],
    "executionOrder": "anyOrder",
    "minRequiredApprovers": 0,
    "instructions": "Instructions",
    "blockedApprovers": []
  },
  "timeout": 43200,
  "type": {
    "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
    "name": "Approval"
  },
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Sample Response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

{
  "settings": {
    "approvers": [
      {
        "displayName": null,
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1"
      }
    ],
    "executionOrder": "anyOrder",
    "minRequiredApprovers": 0,
    "instructions": "Instructions",
    "blockedApprovers": []
  },
  "createdBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "createdOn": "2020-11-19T10:50:46.0110496Z",
  "modifiedBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "modifiedOn": "2020-11-19T10:50:46.0110496Z",
  "timeout": 43200,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/19"
    }
  },
  "id": 19,
  "type": {
    "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
    "name": "Approval"
  },
  "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/19",
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Task Check

Sample Request

HTTP

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations?api-version=7.1-preview.1

{
  "settings": {
    "displayName": "Business Hours",
    "definitionRef": {
      "id": "445fde2f-6c39-441c-807f-8a59ff2e075f",
      "name": "evaluateBusinessHours",
      "version": "0.0.1"
    },
    "inputs": {
      "businessDays": "Monday,Tuesday,Wednesday,Thursday,Friday",
      "timeZone": "UTC",
      "startTime": "04:00",
      "endTime": "11:00"
    },
    "retryInterval": 5
  },
  "timeout": 43200,
  "type": {
    "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
    "name": "Task Check"
  },
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Sample Response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

{
  "settings": {
    "displayName": "Business Hours",
    "definitionRef": {
      "id": "445fde2f-6c39-441c-807f-8a59ff2e075f",
      "name": "evaluateBusinessHours",
      "version": "0.0.1"
    },
    "inputs": {
      "businessDays": "Monday,Tuesday,Wednesday,Thursday,Friday",
      "timeZone": "UTC",
      "startTime": "04:00",
      "endTime": "11:00"
    },
    "retryInterval": 5
  },
  "createdBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "createdOn": "2020-11-19T11:21:11.312742Z",
  "modifiedBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "modifiedOn": "2020-11-19T11:21:11.312742Z",
  "timeout": 43200,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/23"
    }
  },
  "id": 23,
  "type": {
    "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
    "name": "Task Check"
  },
  "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/23",
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Definiciones

Nombre	Description
CheckConfiguration
CheckIssue	Un problema (error, advertencia) asociado a una configuración de comprobación.
CheckIssueType	Tipo (error, advertencia) del problema.
CheckType
IdentityRef
ReferenceLinks	Clase que representa una colección de vínculos de referencia de REST.
Resource

CheckConfiguration

Nombre	Tipo	Description
_links	ReferenceLinks	Vínculos de referencia.
createdBy	IdentityRef	Identidad de la persona que configuró la comprobación.
createdOn	string	Hora a la que se configuró la comprobación.
id	integer	Compruebe el identificador de configuración.
isDisabled	boolean	Está deshabilitada.
issue	CheckIssue	Problema conectado para comprobar la configuración.
modifiedBy	IdentityRef	Identidad de la persona que modificó la comprobación configurada.
modifiedOn	string	Hora a la que se modificó la comprobación configurada.
resource	Resource	Recurso en el que se configura la comprobación.
timeout	integer	Tiempo de espera en minutos para 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.

CheckIssue

Un problema (error, advertencia) asociado a una configuración de comprobación.

Nombre	Tipo	Description
description	string	Breve resumen de la comprobación: su nombre y recurso.
detailedMessage	string	Descripción más detallada del problema.
message	string	Descripción del problema.
type	CheckIssueType	Tipo (error, advertencia) del problema.

CheckIssueType

Tipo (error, advertencia) del problema.

Nombre	Tipo	Description
error	string
warning	string

CheckType

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

IdentityRef

Nombre	Tipo	Description
_links	ReferenceLinks	Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor	string	El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias	string	En desuso: se puede recuperar consultando el usuario de Graph al que se hace referencia en la entrada "self" del diccionario IdentityRef "_links".
displayName	string	Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
id	string
imageUrl	string	En desuso: disponible en la entrada "avatar" del diccionario "_links" de IdentityRef
inactive	boolean	En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario GraphUser "_links".
isAadIdentity	boolean	En desuso: se puede deducir del tipo de asunto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef
uniqueName	string	En desuso: use Domain+PrincipalName en su lugar.
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

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.

Compartir a través de

Check Configurations - Add

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

oauth2

Scopes

Ejemplos

Approval

Sample Request

Sample Response

Task Check

Sample Request

Sample Response

Definiciones

CheckConfiguration

CheckIssue

CheckIssueType

CheckType

IdentityRef

ReferenceLinks

Resource

Recursos adicionales