SearchCriteria interface
Properties
alert |
If provided, only return alerts with the ids specified. <br />Otherwise, return any alert. |
alert |
If provided, only return alerts of this type. Otherwise, return alerts of all types. |
confidence |
If provided, only return alerts at these confidence levels. <br />Otherwise, return alerts at any confidence level. |
dependency |
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 vulnerable component) is specified in result.RelatedLocations[].logicalLocation. |
from |
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. |
modified |
If provided, only return alerts that were modified since this date. <br />Otherwise return all alerts. |
only |
If true, 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. <br />This option is ignored if ref is provided. |
phase |
If provided with pipelineName, only return alerts detected in this pipeline phase <br />Otherwise, return alerts detected in all phases. |
phase |
If provided with pipelineName, only return alerts detected in this pipeline phase <br />Otherwise, return alerts detected in all phases. |
pipeline |
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. |
rule |
If provided, only return alerts for this rule. <br />Otherwise, return alerts of all rules. |
rule |
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. |
to |
If provided, only return alerts last seen before this date. <br />Otherwise return all alerts. |
tool |
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
confidenceLevels
If provided, only return alerts at these confidence levels. <br />Otherwise, return alerts at any confidence level.
confidenceLevels: Confidence[]
Property Value
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 vulnerable 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
modifiedSince
If provided, only return alerts that were modified since this date. <br />Otherwise return all alerts.
modifiedSince: Date
Property Value
Date
onlyDefaultBranchAlerts
If true, 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. <br />This option is ignored if ref is provided.
onlyDefaultBranchAlerts: 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
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for