SearchCriteria interface

属性

alertIds

如果提供,则仅返回具有指定 ID 的警报。 <br />否则,返回任何警报。

alertType

如果提供,则仅返回此类型的警报。 否则,返回所有类型的警报。

confidenceLevels

如果提供,则仅返回这些置信级别的警报。 <br />否则,返回任何置信级别的警报。

dependencyName

如果提供,则仅返回此依赖项的警报。 <br />否则,返回所有依赖项的警报。 <br />在 sarif 提交中,结果中指定依赖项 (或易受攻击的组件) 。RelatedLocations[].logicalLocation。

fromDate

如果提供,则仅返回在此日期之后上次看到的警报。 <br />否则返回所有警报。

keywords

如果提供,则仅返回其游戏与此模式匹配的警报。

modifiedSince

如果提供,则仅返回自此日期以来修改的警报。 <br />否则返回所有警报。

onlyDefaultBranchAlerts

如果为 true,则仅返回在存储库默认分支上找到的警报。 <br />如果默认分支上未完成任何运行,则改用最后一次运行,而不考虑用于该运行的分支。 <br />如果提供 ref,则忽略此选项。

phaseId

如果随 pipelineName 一起提供,则仅返回在此管道阶段 <中检测到的警报 br />否则,返回在所有阶段检测到的警报。

phaseName

如果随 pipelineName 一起提供,则仅返回在此管道阶段 <中检测到的警报 br />否则,返回在所有阶段检测到的警报。

pipelineName

如果提供,则仅返回在此管道中检测到的警报。 <br />否则,返回在所有管道中检测到的警报。

ref

如果提供,则仅包含此参考的警报。 <如果未提供 br />,并且 OnlyDefaultBranch 为 true,则仅包含默认分支或上次运行分支上找到的警报(如果没有默认分支的分析配置)。 <br />否则,包括来自所有分支的警报。

ruleId

如果提供,则仅返回此规则的警报。 <br />否则,返回所有规则的警报。

ruleName

如果提供,则仅返回此规则的警报。 <br />否则,返回所有规则的警报。

severities

如果提供,则仅返回这些严重级别的警报。 <br />否则,在任何服务器上返回警报。

states

如果提供,则仅返回处于这些状态的警报。 <br />否则,返回处于任何状态的警报。

toDate

如果提供,则仅返回在此日期之前上次看到的警报。 <br />否则返回所有警报。

toolName

如果随 toolName 一起提供,则仅返回此工具检测到的警报。 <br />否则,返回所有工具检测到的警报。

属性详细信息

alertIds

如果提供,则仅返回具有指定 ID 的警报。 <br />否则,返回任何警报。

alertIds: number[]

属性值

number[]

alertType

如果提供,则仅返回此类型的警报。 否则,返回所有类型的警报。

alertType: AlertType

属性值

confidenceLevels

如果提供,则仅返回这些置信级别的警报。 <br />否则,返回任何置信级别的警报。

confidenceLevels: Confidence[]

属性值

dependencyName

如果提供,则仅返回此依赖项的警报。 <br />否则,返回所有依赖项的警报。 <br />在 sarif 提交中,结果中指定依赖项 (或易受攻击的组件) 。RelatedLocations[].logicalLocation。

dependencyName: string

属性值

string

fromDate

如果提供,则仅返回在此日期之后上次看到的警报。 <br />否则返回所有警报。

fromDate: Date

属性值

Date

keywords

如果提供,则仅返回其游戏与此模式匹配的警报。

keywords: 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

如果提供,则仅包含此参考的警报。 <如果未提供 br />,并且 OnlyDefaultBranch 为 true,则仅包含默认分支或上次运行分支上找到的警报(如果没有默认分支的分析配置)。 <br />否则,包括来自所有分支的警报。

ref: string

属性值

string

ruleId

如果提供,则仅返回此规则的警报。 <br />否则,返回所有规则的警报。

ruleId: string

属性值

string

ruleName

如果提供,则仅返回此规则的警报。 <br />否则,返回所有规则的警报。

ruleName: string

属性值

string

severities

如果提供,则仅返回这些严重级别的警报。 <br />否则,在任何服务器上返回警报。

severities: Severity[]

属性值

states

如果提供,则仅返回处于这些状态的警报。 <br />否则,返回处于任何状态的警报。

states: State[]

属性值

State[]

toDate

如果提供,则仅返回在此日期之前上次看到的警报。 <br />否则返回所有警报。

toDate: Date

属性值

Date

toolName

如果随 toolName 一起提供,则仅返回此工具检测到的警报。 <br />否则,返回所有工具检测到的警报。

toolName: string

属性值

string