Check Configurations - Add

Référence

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Ajouter une configuration de case activée

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

Corps de la demande

Nom	Type	Description
_links	ReferenceLinks	Liens de référence.
createdBy	IdentityRef	Identité de la personne qui a configuré case activée.
createdOn	string	Heure à laquelle case activée a été configuré.
id	integer	Vérifiez l’ID de configuration.
isDisabled	boolean	Est case activée désactivé.
issue	CheckIssue	Problème lié à case activée configuration.
modifiedBy	IdentityRef	Identité de la personne qui a modifié le case activée configuré.
modifiedOn	string	Heure à laquelle case activée configuré a été modifié.
resource	Resource	Ressource sur laquelle case activée être configurés.
timeout	integer	Délai d’expiration en minutes pour le case activée.
type	CheckType	Vérifier le type de configuration
url	string	URL à partir de laquelle vous pouvez extraire le case activée configuré.

Réponses

Nom	Type	Description
200 OK	CheckConfiguration	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.
vso.pipelineresources_manage	Accorde la possibilité de gérer une ressource protégée ou la demande d’un pipeline pour utiliser une ressource protégée : pool d’agents, environnement, file d’attente, dépôt, fichiers sécurisés, connexion de service et groupe de variables

Exemples

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

Définitions

Nom	Description
CheckConfiguration
CheckIssue	Problème (erreur, avertissement) associé à une configuration case activée.
CheckIssueType	Type (erreur, avertissement) du problème.
CheckType
IdentityRef
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
Resource

CheckConfiguration

Nom	Type	Description
_links	ReferenceLinks	Liens de référence.
createdBy	IdentityRef	Identité de la personne qui a configuré case activée.
createdOn	string	Heure à laquelle case activée a été configuré.
id	integer	Vérifiez l’ID de configuration.
isDisabled	boolean	Est case activée désactivé.
issue	CheckIssue	Problème lié à case activée configuration.
modifiedBy	IdentityRef	Identité de la personne qui a modifié le case activée configuré.
modifiedOn	string	Heure à laquelle case activée configuré a été modifié.
resource	Resource	Ressource sur laquelle case activée être configurés.
timeout	integer	Délai d’expiration en minutes pour le case activée.
type	CheckType	Vérifier le type de configuration
url	string	URL à partir de laquelle vous pouvez extraire le case activée configuré.

CheckIssue

Problème (erreur, avertissement) associé à une configuration case activée.

Nom	Type	Description
description	string	Bref résumé du case activée : son nom et sa ressource.
detailedMessage	string	Description plus détaillée du problème.
message	string	Description du problème.
type	CheckIssueType	Type (erreur, avertissement) du problème.

CheckIssueType

Type (erreur, avertissement) du problème.

Nom	Type	Description
error	string
warning	string

CheckType

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

IdentityRef

Nom	Type	Description
_links	ReferenceLinks	Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.
descriptor	string	Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique dans les comptes et les organisations.
directoryAlias	string	Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « self » du dictionnaire IdentityRef « _links »
displayName	string	Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string	Déprécié : disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »
inactive	boolean	Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »
isAadIdentity	boolean	Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef
uniqueName	string	Déconseillé : utilisez à la place Domain+PrincipalName
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

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

Check Configurations - Add

Paramètres URI

Corps de la demande

Réponses

Sécurité

oauth2

Scopes

Exemples

Approval

Sample Request

Sample Response

Task Check

Sample Request

Sample Response

Définitions

CheckConfiguration

CheckIssue

CheckIssueType

CheckType

IdentityRef

ReferenceLinks

Resource

Ressources supplémentaires