Check Configurations - List
Získání kontroly konfigurace podle typu prostředku a ID
GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations?api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations?resourceType={resourceType}&resourceId={resourceId}&$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 | |||
resource
|
query |
string |
ID prostředku |
|
resource
|
query |
string |
typ prostředku |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
ú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
GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations?resourceType=queue&resourceId=1&api-version=7.1-preview.1
Sample Response
request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context
{
"count": 4,
"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: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"
}
},
{
"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:42:31.3318475Z",
"modifiedBy": {
"displayName": "User Name",
"id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
"uniqueName": "uniqueName",
"descriptor": "Descriptor"
},
"modifiedOn": "2020-11-19T11:42:31.3318475Z",
"timeout": 43200,
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/25"
}
},
"id": 25,
"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/25",
"resource": {
"type": "queue",
"id": "1",
"name": "Default"
}
}
]
}
Definice
Name | Description |
---|---|
Check |
|
Check |
|
Check |
Problém (chyba, upozornění) související s konfigurací kontroly |
Check |
Typ problému (chyba, upozornění) |
Check |
|
Identity |
|
Reference |
Třída představující kolekci odkazů REST. |
Resource |
CheckConfiguration
Name | Typ | Description |
---|---|---|
_links |
Odkazy. |
|
createdBy |
Identita osoby, která nakonfigurovala kontrolu. |
|
createdOn |
string |
Čas, kdy se kontrola nakonfigurovala. |
id |
integer |
Zkontrolujte ID konfigurace. |
isDisabled |
boolean |
Je kontrola zakázaná. |
issue |
Problém spojený se kontrolou konfigurace |
|
modifiedBy |
Identita osoby, která změnila nakonfigurovanou kontrolu |
|
modifiedOn |
string |
Čas změny nakonfigurované kontroly |
resource |
Prostředek, u kterého se kontrola nakonfiguruje. |
|
timeout |
integer |
Časový limit kontroly je v minutách. |
type |
Kontrola typu konfigurace |
|
url |
string |
Adresa URL, ze které lze načíst nakonfigurovanou kontrolu. |
CheckConfigurationExpandParameter
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 |
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 |
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. |
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro