Policy Configurations - List

服务:

Git

API 版本:

5.0-preview.1

按一组给定的范围/筛选条件检索策略配置列表。

下面是所有查询参数如何相互交互的简短说明：

• repositoryId set，refName set：返回 应用于 存储库中特定分支的所有策略配置
• repositoryId set，refName unset：返回 应用于 特定存储库的所有策略配置
• repositoryId unset， refName unset： 返回在项目级别 定义 的所有策略配置
• repositoryId 未设置，refName set：返回所有项目级分支策略，以及项目级别配置 对于上述所有示例，设置 policyType 时，它将结果限制为给定的策略类型

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

具有可选参数:

GET https://dev.azure.com/{organization}/{project}/_apis/git/policy/configurations?repositoryId={repositoryId}&refName={refName}&policyType={policyType}&api-version=5.0-preview.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。 应将其设置为“5.0-preview.1”才能使用此版本的 API。
policyType	query		string uuid	策略类型筛选器。
refName	query		string	完全限定的 Git ref 名称 (例如 refs/heads/master) 。
repositoryId	query		string uuid	存储库 ID。

响应

名称	类型	说明
200 OK	PolicyConfiguration[]	成功的操作

安全性

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
PolicyConfiguration	包含设置的完整策略配置。
PolicyTypeRef	策略类型引用。
ReferenceLinks	表示 REST 引用链接集合的类。

IdentityRef

Object

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个相关链接。 可以调用这些链接来获取有关此图主题的其他关系或更多详细信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方式。 此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string
displayName	string	这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	此 URL 是此图主题的源资源的完整路由。

PolicyConfiguration

Object

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

名称	类型	说明
_links	ReferenceLinks	指向与此对象相关的其他对象的链接。
createdBy	IdentityRef	对创建策略的标识的引用。
createdDate	string	创建策略的日期和时间。
id	integer	策略配置 ID。
isBlocking	boolean	指示策略是否正在阻止。
isDeleted	boolean	指示策略是否已 (软) 删除。
isEnabled	boolean	指示是否启用策略。
revision	integer	策略配置修订 ID。
settings	string	策略配置设置。
type	PolicyTypeRef	策略配置类型。
url	string	可在其中检索策略配置的 URL。

PolicyTypeRef

Object

策略类型引用。

名称	类型	说明
displayName	string	策略类型的显示名称。
id	string	策略类型 ID。
url	string	可在其中检索策略类型的 URL。

ReferenceLinks

Object

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

名称	类型	说明
links	object	链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读。