SearchCriteria interface

  • Reference
Package:
azure-devops-extension-api

Properties

alertIds

If provided, only return alerts with the ids specified. <br />Otherwise, return any alert.
alertType

If provided, only return alerts of this type. Otherwise, return alerts of all types.
confidenceLevels

If provided, only return alerts at these confidence levels. <br />Otherwise, return alerts at any confidence level.
dependencyName

If provided, only alerts for this dependency are returned. <br />Otherwise, return alerts for all dependencies. <br />In a sarif submission, a dependency (or a component) is specified in result.RelatedLocations[].logicalLocation.
fromDate

If provided, only return alerts last seen after this date. <br />Otherwise return all alerts.
keywords

If provided, only return alerts whose titles match this pattern.
licenseName

If provided, only alerts created for dependency with this license are returned. <br />Otherwise, return alerts for all licenses. <br />In a sarif submission, license for a dependency (or a component) is specified in result.RelatedLocations[].logicalLocation.properties.license.
modifiedSince

If provided, only return alerts that were modified since this date. <br />Otherwise return all alerts.
onlyDefaultBranch

If true or not set, only return alerts found on the default branch of the repository. <br />If there have been no runs completed on the default branch, the last run is used instead regardless of the branch used for that run. If false, return alerts from all branches. <br />This option is ignored if ref is provided.
phaseId

If provided with pipelineName, only return alerts detected in this pipeline phase <br />Otherwise, return alerts detected in all phases.
phaseName

If provided with pipelineName, only return alerts detected in this pipeline phase <br />Otherwise, return alerts detected in all phases.
pipelineName

If provided, only return alerts detected in this pipeline. <br />Otherwise, return alerts detected in all pipelines.
ref

If provided, only include alerts for this ref. <br />If not provided and OnlyDefaultBranch is true, only include alerts found on the default branch or last run branch if there is no analysis configuration for the default branch. <br />Otherwise, include alerts from all branches.
ruleId

If provided, only return alerts for this rule. <br />Otherwise, return alerts of all rules.
ruleName

If provided, only return alerts for this rule. <br />Otherwise, return alerts for all rules.
severities

If provided, only return alerts at these severities. <br />Otherwise, return alerts at any serverity.
states

If provided, only return alerts in these states. <br />Otherwise, return alerts in any state.
toDate

If provided, only return alerts last seen before this date. <br />Otherwise return all alerts.
toolName

If provided with toolName, only return alerts detected by this tool. <br />Otherwise, return alerts detected by all tools.

Property Details

alertIds

If provided, only return alerts with the ids specified. <br />Otherwise, return any alert.

alertIds: number[]

Property Value

number[]

alertType

If provided, only return alerts of this type. Otherwise, return alerts of all types.

alertType: AlertType

Property Value

AlertType

confidenceLevels

If provided, only return alerts at these confidence levels. <br />Otherwise, return alerts at any confidence level.

confidenceLevels: Confidence[]

Property Value

Confidence[]

dependencyName

If provided, only alerts for this dependency are returned. <br />Otherwise, return alerts for all dependencies. <br />In a sarif submission, a dependency (or a component) is specified in result.RelatedLocations[].logicalLocation.

dependencyName: string

Property Value

string

fromDate

If provided, only return alerts last seen after this date. <br />Otherwise return all alerts.

fromDate: Date

Property Value

Date

keywords

If provided, only return alerts whose titles match this pattern.

keywords: string

Property Value

string

licenseName

If provided, only alerts created for dependency with this license are returned. <br />Otherwise, return alerts for all licenses. <br />In a sarif submission, license for a dependency (or a component) is specified in result.RelatedLocations[].logicalLocation.properties.license.

licenseName: string

Property Value

string

modifiedSince

If provided, only return alerts that were modified since this date. <br />Otherwise return all alerts.

modifiedSince: Date

Property Value

Date

onlyDefaultBranch

If true or not set, only return alerts found on the default branch of the repository. <br />If there have been no runs completed on the default branch, the last run is used instead regardless of the branch used for that run. If false, return alerts from all branches. <br />This option is ignored if ref is provided.

onlyDefaultBranch: boolean

Property Value

boolean

phaseId

If provided with pipelineName, only return alerts detected in this pipeline phase <br />Otherwise, return alerts detected in all phases.

phaseId: string

Property Value

string

phaseName

If provided with pipelineName, only return alerts detected in this pipeline phase <br />Otherwise, return alerts detected in all phases.

phaseName: string

Property Value

string

pipelineName

If provided, only return alerts detected in this pipeline. <br />Otherwise, return alerts detected in all pipelines.

pipelineName: string

Property Value

string

ref

If provided, only include alerts for this ref. <br />If not provided and OnlyDefaultBranch is true, only include alerts found on the default branch or last run branch if there is no analysis configuration for the default branch. <br />Otherwise, include alerts from all branches.

ref: string

Property Value

string

ruleId

If provided, only return alerts for this rule. <br />Otherwise, return alerts of all rules.

ruleId: string

Property Value

string

ruleName

If provided, only return alerts for this rule. <br />Otherwise, return alerts for all rules.

ruleName: string

Property Value

string

severities

If provided, only return alerts at these severities. <br />Otherwise, return alerts at any serverity.

severities: Severity[]

Property Value

Severity[]

states

If provided, only return alerts in these states. <br />Otherwise, return alerts in any state.

states: State[]

Property Value

State[]

toDate

If provided, only return alerts last seen before this date. <br />Otherwise return all alerts.

toDate: Date

Property Value

Date

toolName

If provided with toolName, only return alerts detected by this tool. <br />Otherwise, return alerts detected by all tools.

toolName: string

Property Value

string