Check Configurations - Query

Reference

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Získejte kontrolu konfigurací pro více prostředků podle typu prostředku a ID.

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

With optional parameters:

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/queryconfigurations?$expand={$expand}&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. Tato verze rozhraní API by měla být nastavená na 7.1-preview.1.
$expand	query		CheckConfigurationExpandParameter	Vlastnosti, které by měly být rozbalené v seznamu konfigurací kontroly.

Text požadavku

Name	Typ	Description
body	Resource[]	Seznam prostředků

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	Uděluje možnost přístupu k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost přijímat oznámení o událostech sestavení prostřednictvím volání služeb.

Příklady

Sample Request

HTTP

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

[
  {
    "type": "queue",
    "id": "1",
    "name": "Default"
  },
  {
    "type": "environment",
    "id": "1",
    "name": "SampleEnv"
  }
]

Sample Response

Status code:: 200

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

Response Body

{
  "count": 12,
  "value": [
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:21:11.1408948Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T11:21:11.1408948Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/22"
        }
      },
      "id": 22,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/22",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "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:52:52.3335458Z",
      "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"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:42:31.1912383Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T11:42:31.1912383Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/24"
        }
      },
      "id": 24,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/24",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:50:29.2550665Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T12:26:25.7610862Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/27"
        }
      },
      "id": 27,
      "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/27",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:52:03.1146399Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T11:52:03.1146399Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/28"
        }
      },
      "id": 28,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/28",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:53:33.1149141Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T11:53:33.1149141Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/30"
        }
      },
      "id": 30,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/30",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:53:33.2555259Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T11:53:33.2555259Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/31"
        }
      },
      "id": 31,
      "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/31",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T12:26:25.3548409Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T12:26:25.3548409Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/32"
        }
      },
      "id": 32,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/32",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T12:26:25.5267095Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T12:26:25.5267095Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/33"
        }
      },
      "id": 33,
      "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/33",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-09-21T07:29:09.749198Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T12:23:28.1356019Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/12"
        }
      },
      "id": 12,
      "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/12",
      "resource": {
        "type": "environment",
        "id": "1",
        "name": "SampleEnv"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-09-30T12:46:12.6159149Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T08:12:49.2665218Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/14"
        }
      },
      "id": 14,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/14",
      "resource": {
        "type": "environment",
        "id": "1",
        "name": "SampleEnv"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T10:28:46.4136508Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T10:28:46.4136508Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/16"
        }
      },
      "id": 16,
      "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/16",
      "resource": {
        "type": "environment",
        "id": "1",
        "name": "SampleEnv"
      }
    }
  ]
}

Definice

Name	Description
CheckConfiguration
CheckConfigurationExpandParameter	Vlastnosti, které by měly být rozbalené v seznamu konfigurací kontroly.
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 se kontrola nakonfigurovala.
id	integer	Zkontrolujte ID konfigurace.
isDisabled	boolean	Je kontrola zakázaná.
issue	CheckIssue	Problém spojený se kontrolou konfigurace
modifiedBy	IdentityRef	Identita osoby, která změnila nakonfigurovanou kontrolu
modifiedOn	string	Čas změny nakonfigurované kontroly
resource	Resource	Prostředek, u kterého se kontrola nakonfiguruje.
timeout	integer	Časový limit kontroly je v minutách.
type	CheckType	Kontrola typu konfigurace
url	string	Adresa URL, ze které lze načíst nakonfigurovanou kontrolu.

CheckConfigurationExpandParameter

Vlastnosti, které by měly být rozbalené v seznamu konfigurací kontroly.

Name	Typ	Description
none	string
settings	string

CheckIssue

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

Name	Typ	Description
description	string	Krátký souhrn kontroly – její 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 neobsahuje žádný nebo více zajímavých odkazů na téma 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 v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Dá se načíst dotazem na uživatele Graphu odkazovaného v položce "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é – Můžete ho načíst dotazem na stav členství v Graphu, na který odkazuje položka membershipState slovníku _links GraphUser.
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ě dříve existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL představuje úplnou trasu 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 odkazy 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