Check Configurations - Get

Ссылка

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Получение конфигурации проверки по идентификатору

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

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations/{id}?$expand={$expand}&api-version=7.1-preview.1

Параметры URI

Имя	В	Обязательно	Тип	Описание
id	path	True	integer int32
organization	path	True	string	Название организации Azure DevOps.
project	path	True	string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.
$expand	query		CheckConfigurationExpandParameter

Ответы

Имя	Тип	Описание
200 OK	CheckConfiguration	успешная операция

Безопасность

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

Имя	Описание
vso.build	Предоставляет возможность доступа к артефактам сборки, включая результаты сборки, определения и запросы, а также возможность получать уведомления о событиях сборки с помощью перехватчиков служб.

Примеры

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Response Body

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

Определения

Имя	Описание
CheckConfiguration
CheckConfigurationExpandParameter
CheckIssue	Проблема (ошибка, предупреждение), связанная с конфигурацией проверка.
CheckIssueType	Тип проблемы (ошибка, предупреждение).
CheckType
IdentityRef
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
Resource

CheckConfiguration

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки на справочные материалы.
createdBy	IdentityRef	Удостоверение пользователя, настроившего проверка.
createdOn	string	Время настройки проверка.
id	integer	Проверьте идентификатор конфигурации.
isDisabled	boolean	Отключено проверка.
issue	CheckIssue	Проблема, связанная с конфигурацией проверка.
modifiedBy	IdentityRef	Удостоверение пользователя, изменившего настроенную проверка.
modifiedOn	string	Время изменения настроенного проверка.
resource	Resource	Ресурс, для которого проверка настроить.
timeout	integer	Время ожидания для проверка в минутах.
type	CheckType	Проверка типа конфигурации
url	string	URL-адрес, по которому можно получить настроенный проверка.

CheckConfigurationExpandParameter

Имя	Тип	Описание
none	string
settings	string

CheckIssue

Проблема (ошибка, предупреждение), связанная с конфигурацией проверка.

Имя	Тип	Описание
description	string	Краткая сводка по проверка — его имени и ресурсу.
detailedMessage	string	Более подробное описание проблемы.
message	string	Описание проблемы.
type	CheckIssueType	Тип проблемы (ошибка, предупреждение).

CheckIssueType

Тип проблемы (ошибка, предупреждение).

Имя	Тип	Описание
error	string
warning	string

CheckType

Имя	Тип	Описание
id	string	Возвращает или задает идентификатор типа проверка.
name	string	Имя типа проверка.

IdentityRef

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемый — можно получить, запросив пользователя Graph, на который ссылается запись self словаря IdentityRef _links.
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string	Не рекомендуется — доступно в записи "аватар" словаря IdentityRef "_links"
inactive	boolean	Не рекомендуется — можно получить, запросив состояние членства Graph, указанное в записи membershipState словаря GraphUser _links.
isAadIdentity	boolean	Не рекомендуется — может выводиться из типа субъекта дескриптора (descriptor.IsAadUserType/descriptor.IsAadGroupType).
isContainer	boolean	Не рекомендуется — может выводиться из типа субъекта дескриптора (Descriptor.IsGroupType).
isDeletedInOrigin	boolean
profileUrl	string	Нерекомендуемый — не используется в большинстве уже существовающих реализаций ToIdentityRef.
uniqueName	string	Нерекомендуемый — используйте вместо этого домен+имя_субъекта
url	string	Этот URL-адрес является полным маршрутом к исходному ресурсу этого субъекта графа.

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

Resource

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
type	string	Тип ресурса.

Поделиться через