SearchCriteria interface
屬性
alert |
如果提供,則只會傳回具有指定標識碼的警示。 <br />否則,傳回任何警示。 |
alert |
如果提供,則只會傳回此類型的警示。 否則,傳回所有類型的警示。 |
confidence |
如果提供,則只會傳回這些信賴等級的警示。 <br />否則,傳回任何信賴等級的警示。 |
dependency |
如果提供,只會傳回此相依性警示。 <br />否則,傳回所有相依性的警示。 <br />在 sarif 提交中,會產生相依性(或元件)。RelatedLocations[].logicalLocation。 |
from |
如果提供,則只會傳回上次在此日期之後看到的警示。 <br />否則會傳回所有警示。 |
keywords | 如果提供,則只會傳回標題符合此模式的警示。 |
license |
如果提供,只會傳回針對具有此授權之相依性而建立的警示。 <br />否則,傳回所有授權的警示。 <br />在 sarif 提交中,會產生相依性 (或元件) 的授權。RelatedLocations[].logicalLocation.properties.license。 |
modified |
如果提供,則只會傳回自此日期以來已修改的警示。 <br />否則會傳回所有警示。 |
only |
如果為 true,則只會傳回存放庫預設分支上找到的警示。 <br />如果預設分支上沒有執行完成,則會改用最後一次執行,而不論用於該執行的分支為何。 <br />如果提供 ref,則會忽略此選項。 |
phase |
如果提供pipelineName,則只會傳回在此管線階段中偵測到的警示,<br />否則,傳回在所有階段中偵測到的警示。 |
phase |
如果提供pipelineName,則只會傳回在此管線階段中偵測到的警示,<br />否則,傳回在所有階段中偵測到的警示。 |
pipeline |
如果提供,則只會傳回在此管線中偵測到的警示。 <br />否則,傳回所有管線中偵測到的警示。 |
ref | 如果提供,則只包含此 ref 的警示。<br />如果未提供且 OnlyDefaultBranch 為 true,則只有在沒有預設分支的分析組態時,才包含在預設分支或上次執行分支上找到的警示。 <br />否則,請包含來自所有分支的警示。 |
rule |
如果提供,則只會傳回此規則的警示。 <br />否則,傳回所有規則的警示。 |
rule |
如果提供,則只會傳回此規則的警示。 <br />否則,傳回所有規則的警示。 |
severities | 如果提供,則只會傳回這些嚴重性警示。 <br />否則,在任何伺服器傳回警示。 |
states | 如果提供,則只會傳回這些狀態中的警示。 <br />否則,傳回任何狀態的警示。 |
to |
如果提供,則只會傳回上次在此日期之前看到的警示。 <br />否則會傳回所有警示。 |
tool |
如果提供 toolName,則只會傳回此工具偵測到的警示。 <br />否則,傳回所有工具偵測到的警示。 |
屬性詳細資料
alertIds
如果提供,則只會傳回具有指定標識碼的警示。 <br />否則,傳回任何警示。
alertIds: number[]
屬性值
number[]
alertType
confidenceLevels
dependencyName
如果提供,只會傳回此相依性警示。 <br />否則,傳回所有相依性的警示。 <br />在 sarif 提交中,會產生相依性(或元件)。RelatedLocations[].logicalLocation。
dependencyName: string
屬性值
string
fromDate
如果提供,則只會傳回上次在此日期之後看到的警示。 <br />否則會傳回所有警示。
fromDate: Date
屬性值
Date
keywords
如果提供,則只會傳回標題符合此模式的警示。
keywords: string
屬性值
string
licenseName
如果提供,只會傳回針對具有此授權之相依性而建立的警示。 <br />否則,傳回所有授權的警示。 <br />在 sarif 提交中,會產生相依性 (或元件) 的授權。RelatedLocations[].logicalLocation.properties.license。
licenseName: string
屬性值
string
modifiedSince
如果提供,則只會傳回自此日期以來已修改的警示。 <br />否則會傳回所有警示。
modifiedSince: Date
屬性值
Date
onlyDefaultBranchAlerts
如果為 true,則只會傳回存放庫預設分支上找到的警示。 <br />如果預設分支上沒有執行完成,則會改用最後一次執行,而不論用於該執行的分支為何。 <br />如果提供 ref,則會忽略此選項。
onlyDefaultBranchAlerts: boolean
屬性值
boolean
phaseId
如果提供pipelineName,則只會傳回在此管線階段中偵測到的警示,<br />否則,傳回在所有階段中偵測到的警示。
phaseId: string
屬性值
string
phaseName
如果提供pipelineName,則只會傳回在此管線階段中偵測到的警示,<br />否則,傳回在所有階段中偵測到的警示。
phaseName: string
屬性值
string
pipelineName
如果提供,則只會傳回在此管線中偵測到的警示。 <br />否則,傳回所有管線中偵測到的警示。
pipelineName: string
屬性值
string
ref
如果提供,則只包含此 ref 的警示。<br />如果未提供且 OnlyDefaultBranch 為 true,則只有在沒有預設分支的分析組態時,才包含在預設分支或上次執行分支上找到的警示。 <br />否則,請包含來自所有分支的警示。
ref: string
屬性值
string
ruleId
如果提供,則只會傳回此規則的警示。 <br />否則,傳回所有規則的警示。
ruleId: string
屬性值
string
ruleName
如果提供,則只會傳回此規則的警示。 <br />否則,傳回所有規則的警示。
ruleName: string
屬性值
string
severities
states
toDate
如果提供,則只會傳回上次在此日期之前看到的警示。 <br />否則會傳回所有警示。
toDate: Date
屬性值
Date
toolName
如果提供 toolName,則只會傳回此工具偵測到的警示。 <br />否則,傳回所有工具偵測到的警示。
toolName: string
屬性值
string