Configurations - Get

Ссылка

Service:: Policy

API Version:: 7.1-preview.1

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
configurationId	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.

Ответы

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

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

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.code	Предоставляет возможность чтения исходного кода и метаданных о фиксациях, наборах изменений, ветвях и других артефактах управления версиями. Кроме того, предоставляет возможность поиска кода и получения уведомлений о событиях управления версиями с помощью перехватчиков служб.

Имя

Описание

vso.code

Предоставляет возможность чтения исходного кода и метаданных о фиксациях, наборах изменений, ветвях и других артефактах управления версиями. Кроме того, предоставляет возможность поиска кода и получения уведомлений о событиях управления версиями с помощью перехватчиков служб.

Примеры

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/fabrikam-fiber-git/_apis/policy/configurations/17?api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "createdBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "createdDate": "2015-02-23T12:51:06.85754Z",
  "isEnabled": true,
  "isBlocking": true,
  "isDeleted": false,
  "settings": {
    "requiredReviewerIds": [
      "1d1dad71-f27c-4370-810d-838ec41efd41",
      "13272ea3-92ef-46d1-b77e-608ebbf3428b"
    ],
    "filenamePatterns": [
      "*/API*.cs",
      "sql/tables/*"
    ],
    "addedFilesOnly": false,
    "message": null,
    "scope": [
      {
        "refName": "refs/heads/master",
        "matchKind": "Exact",
        "repositoryId": null
      },
      {
        "refName": "refs/heads/releases/",
        "matchKind": "Prefix",
        "repositoryId": null
      },
      {
        "refName": "refs/heads/adventureworks",
        "matchKind": "Exact",
        "repositoryId": "49c1d4d0-be28-4f20-9e0a-4ecfafc39257"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/policy/configurations/17"
    },
    "type": {
      "href": "https://dev.azure.com/fabrikam/1be3fc5b-c58c-4173-8fd7-6647d11eccd1/_apis/policy/types/fd2167ab-b0be-447a-8ec8-39368250530e"
    }
  },
  "revision": 2,
  "id": 17,
  "url": "https://dev.azure.com/fabrikam/_apis/policy/configurations/17",
  "type": {
    "id": "fd2167ab-b0be-447a-8ec8-39368250530e",
    "url": "https://dev.azure.com/fabrikam/1be3fc5b-c58c-4173-8fd7-6647d11eccd1/_apis/policy/types/fd2167ab-b0be-447a-8ec8-39368250530e",
    "displayName": "Required reviewers"
  }
}

Определения

Имя	Описание
IdentityRef
JObject	Представляет объект JSON.
PolicyConfiguration	Полная конфигурация политики с параметрами.
PolicyTypeRef	Справочник по типу политики.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.

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	Не рекомендуется использовать вместо него домен+principalName.
url	string	Этот URL-адрес представляет собой полный маршрут к исходному ресурсу этого субъекта графа.

JObject

Представляет объект JSON.

Имя	Тип	Описание
item	string
type	string	Возвращает тип узла для этого JToken.

PolicyConfiguration

Полная конфигурация политики с параметрами.

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки на другие объекты, связанные с этим объектом.
createdBy	IdentityRef	Ссылка на удостоверение, создающее политику.
createdDate	string	Дата и время создания политики.
id	integer	Идентификатор конфигурации политики.
isBlocking	boolean	Указывает, блокируется ли политика.
isDeleted	boolean	Указывает, удалена ли политика (обратимо).
isEnabled	boolean	Указывает, включена ли политика.
isEnterpriseManaged	boolean	Если этот параметр задан, для этой политики требуется разрешение "Управление корпоративными политиками" для создания, изменения или удаления.
revision	integer	Идентификатор редакции конфигурации политики.
settings	JObject	Параметры конфигурации политики.
type	PolicyTypeRef	Тип конфигурации политики.
url	string	URL-адрес, по которому можно получить конфигурацию политики.

PolicyTypeRef

Справочник по типу политики.

Имя	Тип	Описание
displayName	string	Отображаемое имя типа политики.
id	string	Идентификатор типа политики.
url	string	URL-адрес, по которому можно получить тип политики.

ReferenceLinks

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

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

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