Check Configurations - Add

Reference

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Přidání konfigurace kontroly

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.1.

Text požadavku

Name	Typ	Description
_links	ReferenceLinks	Odkazy.
createdBy	IdentityRef	Identita osoby, která nakonfigurovala kontrolu.
createdOn	string	Čas, kdy byla kontrola nakonfigurována.
id	integer	Zkontrolujte ID konfigurace.
isDisabled	boolean	Je kontrola zakázaná.
issue	CheckIssue	Problém související se kontrolou konfigurace
modifiedBy	IdentityRef	Identita osoby, která změnila nakonfigurovanou kontrolu.
modifiedOn	string	Čas změny nakonfigurované kontroly
resource	Resource	Prostředek, na kterém se kontrola konfiguruje.
timeout	integer	Časový limit kontroly v minutách.
type	CheckType	Kontrola typu konfigurace
url	string	Adresa URL, ze které lze načíst nakonfigurovanou kontrolu.

Odpovědi

Name	Typ	Description
200 OK	CheckConfiguration	úspěšná operace

Zabezpečení

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

Name	Description
vso.build_execute	Uděluje možnost přístupu k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost zařadit sestavení do fronty, aktualizovat vlastnosti sestavení a přijímat oznámení o událostech sestavení prostřednictvím připojení služeb.
vso.pipelineresources_manage	Uděluje možnost spravovat chráněný prostředek nebo žádost kanálu o použití chráněného prostředku: fond agentů, prostředí, fronta, úložiště, zabezpečené soubory, připojení služby a skupina proměnných.

Příklady

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

Definice

Name	Description
CheckConfiguration
CheckIssue	Problém (chyba, upozornění) související s konfigurací kontroly
CheckIssueType	Typ problému (chyba, upozornění).
CheckType
IdentityRef
ReferenceLinks	Třída představující kolekci odkazů REST.
Resource

CheckConfiguration

Name	Typ	Description
_links	ReferenceLinks	Odkazy.
createdBy	IdentityRef	Identita osoby, která nakonfigurovala kontrolu.
createdOn	string	Čas, kdy byla kontrola nakonfigurována.
id	integer	Zkontrolujte ID konfigurace.
isDisabled	boolean	Je kontrola zakázaná.
issue	CheckIssue	Problém související se kontrolou konfigurace
modifiedBy	IdentityRef	Identita osoby, která změnila nakonfigurovanou kontrolu.
modifiedOn	string	Čas změny nakonfigurované kontroly
resource	Resource	Prostředek, na kterém se kontrola konfiguruje.
timeout	integer	Časový limit kontroly v minutách.
type	CheckType	Kontrola typu konfigurace
url	string	Adresa URL, ze které lze načíst nakonfigurovanou kontrolu.

CheckIssue

Problém (chyba, upozornění) související s konfigurací kontroly

Name	Typ	Description
description	string	Krátký souhrn kontroly – název a prostředek
detailedMessage	string	Podrobnější popis problému
message	string	Popis problému.
type	CheckIssueType	Typ problému (chyba, upozornění).

CheckIssueType

Typ problému (chyba, upozornění).

Name	Typ	Description
error	string
warning	string

CheckType

Name	Typ	Description
id	string	Získá nebo nastaví ID typu kontroly.
name	string	Název typu kontroly.

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo více zajímavých odkazů o předmětu grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu napříč účty i organizacemi.
directoryAlias	string	Zastaralé – lze načíst dotazem uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links".
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links".
inactive	boolean	Zastaralé – lze načíst dotazem na stav členství graphu, na který odkazuje položka membershipState slovníku GraphUser "_links".
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsAadUserType/Descriptor.IsAadGroupType).
isContainer	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako jen pro čtení.

Resource

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku.
type	string	Typ prostředku.

Sdílet prostřednictvím

Check Configurations - Add

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

oauth2

Scopes

Příklady

Approval

Sample Request

Sample Response

Task Check

Sample Request

Sample Response

Definice

CheckConfiguration

CheckIssue

CheckIssueType

CheckType

IdentityRef

ReferenceLinks

Resource

Další materiály