SearchCriteria interface

Egenskaper

alertIds

Om detta anges returnerar du endast aviseringar med angivna ID:t. <br/>Annars returnerar du alla aviseringar.

alertType

Om detta anges returnerar du endast aviseringar av den här typen. Annars returnerar du aviseringar av alla typer.

confidenceLevels

Om detta anges returnerar du endast aviseringar på dessa konfidensnivåer. <br />Både hög och Annan måste anges för att hämta aviseringar om alla konfidensnivåer. <br />Annars returnerar du aviseringar med hög konfidensnivå. <br />Gäller endast för hemliga aviseringar.

dependencyName

Om detta anges returneras endast aviseringar för det här beroendet. <br/>Annars returnerar du aviseringar för alla beroenden. <br/>I en sarif-överföring anges ett beroende (eller en komponent) i resultatet. RelatedLocations[].logicalLocation. <br />Gäller inte för hemliga aviseringar.

fromDate

Om detta anges returnerar du endast aviseringar som senast sågs efter det här datumet. <br/>Annars returnerar du alla aviseringar.

keywords

Om detta anges returnerar du endast aviseringar vars rubriker matchar det här mönstret.

licenseName

Om detta anges returneras endast aviseringar som skapats för beroende med den här licensen. <br/>Annars returnerar du aviseringar för alla licenser. <br/>I en sarif-överföring anges licensen för ett beroende (eller en komponent) i resultatet. RelatedLocations[].logicalLocation.properties.license. <br />Gäller inte för hemliga aviseringar.

modifiedSince

Om detta anges returnerar du endast aviseringar som har ändrats sedan det här datumet. <br/>Annars returnerar du alla aviseringar.

onlyDefaultBranch

Om sant eller inte anges returnerar du bara aviseringar som finns på standardgrenen för lagringsplatsen. <br/>Om inga körningar har slutförts på standardgrenen används den senaste körningen i stället oavsett vilken gren som används för den körningen. Om det är falskt returnerar du aviseringar från alla grenar. <br/>Det här alternativet ignoreras om referens anges. <br />Gäller inte för hemliga aviseringar.

phaseId

Om det tillhandahålls med pipelineName returnerar du endast aviseringar som identifierats i den här pipelinefasen <br/>Annars returnerar du aviseringar som identifierats i alla faser. <br />Gäller inte för hemliga aviseringar.

phaseName

Om det tillhandahålls med pipelineName returnerar du endast aviseringar som identifierats i den här pipelinefasen <br/>Annars returnerar du aviseringar som identifierats i alla faser. <br />Gäller inte för hemliga aviseringar.

pipelineName

Om det tillhandahålls returnerar du endast aviseringar som identifierats i den här pipelinen. <br/>Annars returnerar du aviseringar som identifierats i alla pipelines. <br />Gäller inte för hemliga aviseringar.

ref

Om det tillhandahålls inkluderar du bara aviseringar för den här referensen. <br/>Om det inte anges och OnlyDefaultBranch är sant inkluderar du bara aviseringar som finns på standardgrenen eller den senaste körningsgrenen om det inte finns någon analyskonfiguration för standardgrenen. <br/>I annat fall inkluderar du aviseringar från alla grenar. <br />Gäller inte för hemliga aviseringar.

ruleId

Om detta anges returnerar du endast aviseringar för den här regeln. <br/>Annars returnerar du aviseringar för alla regler.

ruleName

Om detta anges returnerar du endast aviseringar för den här regeln. <br/>Annars returnerar du aviseringar för alla regler.

severities

Om detta anges returnerar du endast aviseringar med dessa allvarlighetsgrader. <br />Annars returnerar du aviseringar med någon allvarlighetsgrad.

states

Om detta anges returnerar du endast aviseringar i dessa tillstånd. <br/>Annars returnerar du aviseringar i alla tillstånd.

toDate

Om detta anges returnerar du endast aviseringar som senast setts före det här datumet. <br/>Annars returnerar du alla aviseringar.

toolName

Om det tillhandahålls med toolName returnerar du endast aviseringar som identifierats av det här verktyget. <br/>Annars returnerar du aviseringar som identifierats av alla verktyg.

validity

Om detta anges returnerar du endast aviseringar med den giltighet som anges här. Om giltighetsstatusen är Okänd hämtar du aviseringar om alla giltighetsresultat. <br />Gäller endast för hemliga aviseringar. <br />Filtrering efter giltighetsstatus kan göra att färre aviseringar returneras än vad som begärs med TOP-parametern. <br />På grund av det här beteendet kommer ContinuationToken(<![ CDATA[<header name>]]>) i svarshuvudet bör användas för att avgöra om en annan batch behöver hämtas.

Egenskapsinformation

alertIds

Om detta anges returnerar du endast aviseringar med angivna ID:t. <br/>Annars returnerar du alla aviseringar.

alertIds: number[]

Egenskapsvärde

number[]

alertType

Om detta anges returnerar du endast aviseringar av den här typen. Annars returnerar du aviseringar av alla typer.

alertType: AlertType

Egenskapsvärde

confidenceLevels

Om detta anges returnerar du endast aviseringar på dessa konfidensnivåer. <br />Både hög och Annan måste anges för att hämta aviseringar om alla konfidensnivåer. <br />Annars returnerar du aviseringar med hög konfidensnivå. <br />Gäller endast för hemliga aviseringar.

confidenceLevels: Confidence[]

Egenskapsvärde

dependencyName

Om detta anges returneras endast aviseringar för det här beroendet. <br/>Annars returnerar du aviseringar för alla beroenden. <br/>I en sarif-överföring anges ett beroende (eller en komponent) i resultatet. RelatedLocations[].logicalLocation. <br />Gäller inte för hemliga aviseringar.

dependencyName: string

Egenskapsvärde

string

fromDate

Om detta anges returnerar du endast aviseringar som senast sågs efter det här datumet. <br/>Annars returnerar du alla aviseringar.

fromDate: Date

Egenskapsvärde

Date

keywords

Om detta anges returnerar du endast aviseringar vars rubriker matchar det här mönstret.

keywords: string

Egenskapsvärde

string

licenseName

Om detta anges returneras endast aviseringar som skapats för beroende med den här licensen. <br/>Annars returnerar du aviseringar för alla licenser. <br/>I en sarif-överföring anges licensen för ett beroende (eller en komponent) i resultatet. RelatedLocations[].logicalLocation.properties.license. <br />Gäller inte för hemliga aviseringar.

licenseName: string

Egenskapsvärde

string

modifiedSince

Om detta anges returnerar du endast aviseringar som har ändrats sedan det här datumet. <br/>Annars returnerar du alla aviseringar.

modifiedSince: Date

Egenskapsvärde

Date

onlyDefaultBranch

Om sant eller inte anges returnerar du bara aviseringar som finns på standardgrenen för lagringsplatsen. <br/>Om inga körningar har slutförts på standardgrenen används den senaste körningen i stället oavsett vilken gren som används för den körningen. Om det är falskt returnerar du aviseringar från alla grenar. <br/>Det här alternativet ignoreras om referens anges. <br />Gäller inte för hemliga aviseringar.

onlyDefaultBranch: boolean

Egenskapsvärde

boolean

phaseId

Om det tillhandahålls med pipelineName returnerar du endast aviseringar som identifierats i den här pipelinefasen <br/>Annars returnerar du aviseringar som identifierats i alla faser. <br />Gäller inte för hemliga aviseringar.

phaseId: string

Egenskapsvärde

string

phaseName

Om det tillhandahålls med pipelineName returnerar du endast aviseringar som identifierats i den här pipelinefasen <br/>Annars returnerar du aviseringar som identifierats i alla faser. <br />Gäller inte för hemliga aviseringar.

phaseName: string

Egenskapsvärde

string

pipelineName

Om det tillhandahålls returnerar du endast aviseringar som identifierats i den här pipelinen. <br/>Annars returnerar du aviseringar som identifierats i alla pipelines. <br />Gäller inte för hemliga aviseringar.

pipelineName: string

Egenskapsvärde

string

ref

Om det tillhandahålls inkluderar du bara aviseringar för den här referensen. <br/>Om det inte anges och OnlyDefaultBranch är sant inkluderar du bara aviseringar som finns på standardgrenen eller den senaste körningsgrenen om det inte finns någon analyskonfiguration för standardgrenen. <br/>I annat fall inkluderar du aviseringar från alla grenar. <br />Gäller inte för hemliga aviseringar.

ref: string

Egenskapsvärde

string

ruleId

Om detta anges returnerar du endast aviseringar för den här regeln. <br/>Annars returnerar du aviseringar för alla regler.

ruleId: string

Egenskapsvärde

string

ruleName

Om detta anges returnerar du endast aviseringar för den här regeln. <br/>Annars returnerar du aviseringar för alla regler.

ruleName: string

Egenskapsvärde

string

severities

Om detta anges returnerar du endast aviseringar med dessa allvarlighetsgrader. <br />Annars returnerar du aviseringar med någon allvarlighetsgrad.

severities: Severity[]

Egenskapsvärde

states

Om detta anges returnerar du endast aviseringar i dessa tillstånd. <br/>Annars returnerar du aviseringar i alla tillstånd.

states: State[]

Egenskapsvärde

State[]

toDate

Om detta anges returnerar du endast aviseringar som senast setts före det här datumet. <br/>Annars returnerar du alla aviseringar.

toDate: Date

Egenskapsvärde

Date

toolName

Om det tillhandahålls med toolName returnerar du endast aviseringar som identifierats av det här verktyget. <br/>Annars returnerar du aviseringar som identifierats av alla verktyg.

toolName: string

Egenskapsvärde

string

validity

Om detta anges returnerar du endast aviseringar med den giltighet som anges här. Om giltighetsstatusen är Okänd hämtar du aviseringar om alla giltighetsresultat. <br />Gäller endast för hemliga aviseringar. <br />Filtrering efter giltighetsstatus kan göra att färre aviseringar returneras än vad som begärs med TOP-parametern. <br />På grund av det här beteendet kommer ContinuationToken(<![ CDATA[<header name>]]>) i svarshuvudet bör användas för att avgöra om en annan batch behöver hämtas.

validity: AlertValidityStatus[]

Egenskapsvärde