通过

Evaluations - Get

  • 参考
服务:
Policy
API 版本:
7.1-preview.1

获取策略的当前评估状态。

应用于拉取请求的每个策略都将具有特定于在该拉取请求上下文中运行的该策略的评估状态。 每个评估都通过 Guid 唯一标识。 可以使用此控制器的“列出”操作查找特定拉取请求的所有策略评估。

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

URI 参数

名称 在 必需 类型 说明
evaluationId
 path True

string

uuid

要检索的策略评估的 ID。
organization
 path True

string

Azure DevOps 组织的名称。
project
 path True

string

项目 ID 或项目名称
api-version
 query True

string

要使用的 API 版本。 应将其设置为“7.1-preview.1”才能使用此版本的 API。

响应

名称 类型 说明
200 OK

PolicyEvaluationRecord

成功的操作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称 说明
vso.code 授予读取有关提交、更改集、分支和其他版本控制项目的源代码和元数据的能力。 此外，还允许通过服务挂钩搜索代码并获取有关版本控制事件的通知。

定义

名称 说明
IdentityRef
JObject

表示 JSON 对象。
PolicyConfiguration

包含设置的完整策略配置。
PolicyEvaluationRecord

此记录封装策略的当前状态，因为它适用于一个特定的拉取请求。 每个拉取请求针对策略适用的每个拉取请求都有唯一的 PolicyEvaluationRecord。
PolicyEvaluationStatus

策略的状态 (正在运行、已批准、失败等)

PolicyTypeRef

策略类型引用。
ReferenceLinks

表示 REST 引用链接集合的类。

IdentityRef

Object
名称 类型 说明
_links

ReferenceLinks

此字段包含有关图形主题的零个或多个相关链接。 可以调用这些链接来获取有关此图主题的其他关系或更多详细信息。
descriptor

string

描述符是在系统运行时引用图形主题的主要方式。 此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias

string

已弃用 - 可通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName

string

这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。
id

string

imageUrl

string

已弃用 - 在 IdentityRef“_links”字典的“头像”条目中可用
inactive

boolean

已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity

boolean

已弃用 - 可以从描述符的主题类型推断 (描述符.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

已弃用 - 可以从描述符的主题类型推断 (描述符.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

已弃用 - 未在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName

string

已弃用 - 改用 Domain+PrincipalName
url

string

此 URL 是此图主题的源资源的完整路由。

JObject

Object

表示 JSON 对象。

名称 类型 说明
item

string

type

string

获取此 JToken 的节点类型。

PolicyConfiguration

Object

包含设置的完整策略配置。

名称 类型 说明
_links

ReferenceLinks

指向与此对象相关的其他对象的链接。
createdBy

IdentityRef

对创建策略的标识的引用。
createdDate

string

创建策略的日期和时间。
id

integer

策略配置 ID。
isBlocking

boolean

指示策略是否正在阻止。
isDeleted

boolean

指示策略是否已 (软) 删除。
isEnabled

boolean

指示是否启用策略。
isEnterpriseManaged

boolean

如果已设置，此策略需要“管理企业策略”权限才能创建、编辑或删除。
revision

integer

策略配置修订 ID。
settings

JObject

策略配置设置。
type

PolicyTypeRef

策略配置类型。
url

string

可在其中检索策略配置的 URL。

PolicyEvaluationRecord

Object

此记录封装策略的当前状态，因为它适用于一个特定的拉取请求。 每个拉取请求针对策略适用的每个拉取请求都有唯一的 PolicyEvaluationRecord。

名称 类型 说明
_links

ReferenceLinks

指向其他相关对象的链接
artifactId

string

唯一标识策略评估目标的字符串。
completedDate

string

此策略对此拉取请求完成评估的时间。
configuration

PolicyConfiguration

包含正在评估的策略的所有配置数据。
context

JObject

此策略评估的内部上下文数据。
evaluationId

string

Guid，它唯一标识此评估记录 (一个策略在一个拉取请求) 上运行。
startedDate

string

首次在此拉取请求评估此策略的时间。
status

PolicyEvaluationStatus

策略的状态 (正在运行、已批准、失败等)

PolicyEvaluationStatus

Enumeration

策略的状态 (正在运行、已批准、失败等)

值 说明
approved

此拉取请求已实现策略。
broken

策略遇到意外错误。
notApplicable

策略不适用于此拉取请求。
queued

策略要么排队等待运行，要么正在等待某些事件，然后再进行。
rejected

策略已拒绝此拉取请求。
running

策略当前正在运行。

PolicyTypeRef

Object

策略类型引用。

名称 类型 说明
displayName

string

策略类型的显示名称。
id

string

策略类型 ID。
url

string

可在其中检索策略类型的 URL。
Object

表示 REST 引用链接集合的类。

名称 类型 说明
links

object

链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读。