共用方式為

Project Enablement - Update

服務:
Advanced Security
API 版本:
7.2-preview.3

更新專案的進階安全性狀態

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

URI 參數

名稱 位於 必要 類型 Description
organization
 path True

string

Azure DevOps 組織的名稱。
project
 path True

string

項目識別碼或項目名稱
api-version
 query True

string

要使用的 API 版本。 這應該設定為 『7.2-preview.3』，才能使用此版本的 API。

要求本文

名稱 類型 Description
codeSecurityFeatures

CodeSecurityFeatures

包含可啟用的程式代碼安全性功能。
enablementOnCreateSettings

EnablementOnCreateSettings

新建立存放庫的自動啟用設定。
reposEnablementStatus

RepoEnablementSettings[]

指定組織或專案記憶體存放庫的啟用狀態清單。
secretProtectionFeatures

SecretProtectionFeatures

包含可啟用的秘密保護功能。

回應

名稱 類型 Description
200 OK

成功作業

安全性

oauth2

類型: oauth2
Flow: 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

範圍

名稱 Description
vso.advsec_manage 授與存取 sarif 上傳資訊、刪除分析和更新警示的能力

定義

名稱 Description
CodeSecurityFeatures
EnablementOnCreateSettings
ProjectEnablementSettings
RepoEnablementSettings
SecretProtectionFeatures

CodeSecurityFeatures

Object
名稱 類型 Description
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

Object
名稱 類型 Description
enableBlockPushesOnCreate

boolean

當秘密保護自動啟用時，會自動啟用阻擋包含秘密的推送。 如果 EnableSecretProtectionOnCreate 不成立，這個旗標會被忽略。
enableCodeQLOnCreate

boolean

當代碼安全自動啟用時，請自動啟用 CodeQL。 若 EnableCodeSecurityOnCreate 不成立，則忽略此標記。
enableCodeSecurityOnCreate

boolean

在新建立的存放庫上自動啟用程式代碼安全性。
enableDependabotOnCreate

boolean

當程式碼安全自動啟用時，請自動啟用 Dependabot。 若 EnableCodeSecurityOnCreate 不成立，則忽略此標記。
enableDependencyScanningInjectionOnCreate

boolean

當程式碼安全自動啟用時，自動啟用相依掃描注入。 若 EnableCodeSecurityOnCreate 不成立，則忽略此標記。
enableSecretProtectionOnCreate

boolean

在新建立的存放庫上自動啟用秘密保護。

ProjectEnablementSettings

Object
名稱 類型 Description
codeSecurityFeatures

CodeSecurityFeatures

包含可啟用的程式代碼安全性功能。
enablementOnCreateSettings

EnablementOnCreateSettings

新建立存放庫的自動啟用設定。
reposEnablementStatus

RepoEnablementSettings[]

指定組織或專案記憶體存放庫的啟用狀態清單。
secretProtectionFeatures

SecretProtectionFeatures

包含可啟用的秘密保護功能。

RepoEnablementSettings

Object
名稱 類型 Description
codeSecurityFeatures

CodeSecurityFeatures

包含可啟用的程式代碼安全性功能。
projectId

string (uuid)

專案ID
repositoryId

string (uuid)

倉庫ID
secretProtectionFeatures

SecretProtectionFeatures

包含可啟用的秘密保護功能。

SecretProtectionFeatures

Object
名稱 類型 Description
blockPushes

boolean

若為 true，則會封鎖包含秘密的推送。
若為 false，則會掃描推送以取得秘密，且不會遭到封鎖。
如果要求中的 includeAllProperties 為 false，這個值會是 Null。
secretProtectionChangedBy

string (uuid)

上次修改秘密保護啟用狀態的使用者 VSID。
secretProtectionEnabled

boolean

啟用秘密保護狀態設定為 False 時停用，啟用時為 True;Null 永遠不會明確設定。
secretProtectionEnablementLastChangedDate

string (date-time)

上次更新此存放庫的秘密保護狀態