Project Enablement - Get

服务:: Advanced Security

API 版本:: 7.2-preview.3

获取项目的“高级安全性”的当前状态

GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement?api-version=7.2-preview.3

具有可选参数:

GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement?includeAllProperties={includeAllProperties}&api-version=7.2-preview.3

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.2-preview.3”才能使用此版本的 API。
includeAllProperties	query		boolean	如果为 true，还确定推送是否被阻止（如果它们包含机密）

响应

名称	类型	说明
200 OK	ProjectEnablementSettings	成功操作

安全性

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.advsec	授予读取警报、结果实例、分析结果实例的功能

定义

名称	说明
CodeSecurityFeatures
EnablementOnCreateSettings
ProjectEnablementSettings
RepoEnablementSettings
SecretProtectionFeatures

CodeSecurityFeatures

对象

名称	类型	说明
codeQLEnabled	boolean	当禁用时，CodeQL 启用状态设置为 False;启用时为 True;从不显式设置 Null。
codeSecurityChangedBy	string (uuid)	上次修改代码安全性启用状态的用户的 VSID。
codeSecurityEnabled	boolean	禁用时将代码安全启用状态设置为 False;启用时为 True;从不显式设置 Null。
codeSecurityEnablementLastChangedDate	string (date-time)	上次更新此存储库的代码安全性状态
dependencyScanningInjectionEnabled	boolean	在禁用时将依赖项扫描注入启用状态设置为 False;启用时为 True;从不显式设置 Null。如果尚未启用高级安全，行为将取决于是否要启用/禁用高级安全。 DependencyScanningInjectionEnabled 不会影响此方案中的任何内容。如果要禁用高级安全性，DependencyScanningInjectionEnabled 的值将不起作用。

EnablementOnCreateSettings

对象

名称	类型	说明
enableBlockPushesOnCreate	boolean	自动启用“机密保护”时，自动启用包含机密的推送。如果 EnableSecretProtectionOnCreate 不为 true，则忽略此标志。
enableCodeQLOnCreate	boolean	自动启用代码安全性时自动启用 CodeQL。如果 EnableCodeSecurityOnCreate 不为 true，则忽略此标志。
enableCodeSecurityOnCreate	boolean	在新创建的存储库上自动启用代码安全性。
enableDependabotOnCreate	boolean	自动启用 Code Security 时自动启用 Dependabot。如果 EnableCodeSecurityOnCreate 不为 true，则忽略此标志。
enableDependencyScanningInjectionOnCreate	boolean	自动启用代码安全性时自动启用依赖关系扫描注入。如果 EnableCodeSecurityOnCreate 不为 true，则忽略此标志。
enableSecretProtectionOnCreate	boolean	在新创建的存储库上自动启用机密保护。

ProjectEnablementSettings

对象

名称	类型	说明
codeSecurityFeatures	CodeSecurityFeatures	包括可启用的代码安全功能。
enablementOnCreateSettings	EnablementOnCreateSettings	新创建的存储库的自动启用设置。
reposEnablementStatus	RepoEnablementSettings[]	指定组织或项目中存储库的启用状态列表。
secretProtectionFeatures	SecretProtectionFeatures	包括可以启用的机密保护功能。

RepoEnablementSettings

对象

名称	类型	说明
codeSecurityFeatures	CodeSecurityFeatures	包括可启用的代码安全功能。
projectId	string (uuid)	项目 ID
repositoryId	string (uuid)	仓库 ID
secretProtectionFeatures	SecretProtectionFeatures	包括可以启用的机密保护功能。

SecretProtectionFeatures

对象

名称	类型	说明
blockPushes	boolean	如果为 true，将阻止包含机密的推送。如果为 false，将扫描推送以获取机密，并且不会阻止。如果请求中的 includeAllProperties 为 false，则此值将为 null。
secretProtectionChangedBy	string (uuid)	上次修改机密保护启用状态的用户的 VSID。
secretProtectionEnabled	boolean	启用机密保护状态设置为 False（禁用时为 False）;启用时为 True;从不显式设置 Null。
secretProtectionEnablementLastChangedDate	string (date-time)	上次更新此存储库的机密保护状态

通过