SearchCriteria interface

属性

alertIds

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

alertType

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

confidenceLevels

如果提供,则仅返回这些置信度级别的警报。 <需要指定 br />High 和 Other 才能提取所有置信度级别的警报。 <br />否则,返回置信度较高的警报。 <br />仅适用于机密警报。

dependencyName

如果提供,则仅返回此依赖项的警报。 <br />否则,返回所有依赖项的警报。 <br />In a sarif submission, a dependency (or a component) is specified in result.RelatedLocations[].logicalLocation. <br />不适用于机密警报。

fromDate

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

keywords

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

licenseName

如果提供,则仅返回针对具有此许可证的依赖项创建的警报。 <br />否则,返回所有许可证的警报。 <br />In a sarif submission, license for a dependency (or a component) is specified in the result.RelatedLocations[].logicalLocation.properties.license。 <br />不适用于机密警报。

modifiedSince

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

onlyDefaultBranch

如果为 true 或未设置,则仅返回在存储库的默认分支上找到的警报。 <br />如果默认分支上没有完成任何运行,则使用最后一次运行,而不考虑用于该运行的分支。 如果为 false,则返回来自所有分支的警报。 <如果提供了 ref,则忽略 br />This option。 <br />不适用于机密警报。

phaseId

如果使用 pipelineName 提供,则仅返回在此管道阶段 <br 中检测到的警报/>否则,返回在所有阶段检测到的警报。 <br />不适用于机密警报。

phaseName

如果使用 pipelineName 提供,则仅返回在此管道阶段 <br 中检测到的警报/>否则,返回在所有阶段检测到的警报。 <br />不适用于机密警报。

pipelineName

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

ref

如果提供,则仅包含此 ref 的警报。 <br />如果未提供且 OnlyDefaultBranch 为 true,则仅包括默认分支上找到的警报;如果没有默认分支的分析配置,则仅包含上次运行分支上的警报。 <br />否则,包括来自所有分支的警报。 <br />不适用于机密警报。

ruleId

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

ruleName

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

severities

如果提供,则仅返回这些严重性的警报。 <br />否则,返回任何严重性的警报。

states

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

toDate

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

toolName

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

validity

如果提供,则仅返回具有此处指定的有效性的警报。 如果有效性状态为“未知”,则提取所有有效性结果的警报。 <br />仅适用于机密警报。 <br />按有效性状态筛选可能会导致返回的警报少于使用 TOP 参数请求的警报。 <br />由于此行为,ContinuationToken(<![应依赖响应标头中的 CDATA[<header name>]]])>来确定是否需要获取另一个批次。

属性详细信息

alertIds

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

alertIds: number[]

属性值

number[]

alertType

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

alertType: AlertType

属性值

confidenceLevels

如果提供,则仅返回这些置信度级别的警报。 <需要指定 br />High 和 Other 才能提取所有置信度级别的警报。 <br />否则,返回置信度较高的警报。 <br />仅适用于机密警报。

confidenceLevels: Confidence[]

属性值

dependencyName

如果提供,则仅返回此依赖项的警报。 <br />否则,返回所有依赖项的警报。 <br />In a sarif submission, a dependency (or a component) is specified in result.RelatedLocations[].logicalLocation. <br />不适用于机密警报。

dependencyName: string

属性值

string

fromDate

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

fromDate: Date

属性值

Date

keywords

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

keywords: string

属性值

string

licenseName

如果提供,则仅返回针对具有此许可证的依赖项创建的警报。 <br />否则,返回所有许可证的警报。 <br />In a sarif submission, license for a dependency (or a component) is specified in the result.RelatedLocations[].logicalLocation.properties.license。 <br />不适用于机密警报。

licenseName: string

属性值

string

modifiedSince

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

modifiedSince: Date

属性值

Date

onlyDefaultBranch

如果为 true 或未设置,则仅返回在存储库的默认分支上找到的警报。 <br />如果默认分支上没有完成任何运行,则使用最后一次运行,而不考虑用于该运行的分支。 如果为 false,则返回来自所有分支的警报。 <如果提供了 ref,则忽略 br />This option。 <br />不适用于机密警报。

onlyDefaultBranch: boolean

属性值

boolean

phaseId

如果使用 pipelineName 提供,则仅返回在此管道阶段 <br 中检测到的警报/>否则,返回在所有阶段检测到的警报。 <br />不适用于机密警报。

phaseId: string

属性值

string

phaseName

如果使用 pipelineName 提供,则仅返回在此管道阶段 <br 中检测到的警报/>否则,返回在所有阶段检测到的警报。 <br />不适用于机密警报。

phaseName: string

属性值

string

pipelineName

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

pipelineName: string

属性值

string

ref

如果提供,则仅包含此 ref 的警报。 <br />如果未提供且 OnlyDefaultBranch 为 true,则仅包括默认分支上找到的警报;如果没有默认分支的分析配置,则仅包含上次运行分支上的警报。 <br />否则,包括来自所有分支的警报。 <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

validity

如果提供,则仅返回具有此处指定的有效性的警报。 如果有效性状态为“未知”,则提取所有有效性结果的警报。 <br />仅适用于机密警报。 <br />按有效性状态筛选可能会导致返回的警报少于使用 TOP 参数请求的警报。 <br />由于此行为,ContinuationToken(<![应依赖响应标头中的 CDATA[<header name>]]])>来确定是否需要获取另一个批次。

validity: AlertValidityStatus[]

属性值