Partager via


SearchCriteria interface

Propriétés

alertIds

Si elle est fournie, renvoyez uniquement des alertes avec les ID spécifiés. <br />Sinon, retournez n’importe quelle alerte.

alertType

Si elle est fournie, renvoyez uniquement les alertes de ce type. Sinon, retournez des alertes de tous les types.

confidenceLevels

Si elle est fournie, retournez uniquement des alertes à ces niveaux de confiance. <br />Sinon, retournez des alertes à n’importe quel niveau de confiance.

dependencyName

Si elle est fournie, seules les alertes pour cette dépendance sont retournées. <br />Sinon, retournez des alertes pour toutes les dépendances. <br />Dans une soumission sarif, une dépendance (ou un composant) est spécifiée dans le résultat. RelatedLocations[].logicalLocation.

fromDate

Si elle est fournie, seules les alertes renvoyées sont affichées en dernier après cette date. <br />Sinon, retournez toutes les alertes.

keywords

Si elle est fournie, renvoyez uniquement les alertes dont les titres correspondent à ce modèle.

licenseName

Si elle est fournie, seules les alertes créées pour la dépendance avec cette licence sont retournées. <br />Sinon, retournez des alertes pour toutes les licences. <br />Dans une soumission sarif, une licence pour une dépendance (ou un composant) est spécifiée dans le résultat. RelatedLocations[].logicalLocation.properties.license.

modifiedSince

Si elle est fournie, retournez uniquement les alertes qui ont été modifiées depuis cette date. <br />Sinon, retournez toutes les alertes.

onlyDefaultBranchAlerts

Si la valeur est true, renvoyez uniquement les alertes trouvées sur la branche par défaut du référentiel. <br />S’il n’y a pas eu d’exécutions terminées sur la branche par défaut, la dernière exécution est utilisée à la place, quelle que soit la branche utilisée pour cette exécution. <br />Cette option est ignorée si la référence est fournie.

phaseId

Si elle est fournie avec pipelineName, retourne uniquement les alertes détectées dans cette phase de pipeline <br />Sinon, les alertes de retour détectées dans toutes les phases.

phaseName

Si elle est fournie avec pipelineName, retourne uniquement les alertes détectées dans cette phase de pipeline <br />Sinon, les alertes de retour détectées dans toutes les phases.

pipelineName

Si elle est fournie, seules les alertes renvoyées sont détectées dans ce pipeline. <br />Sinon, retournez des alertes détectées dans tous les pipelines.

ref

Si elle est fournie, incluez uniquement les alertes pour cette référence. <br />Si ce n’est pas fourni et OnlyDefaultBranch a la valeur true, incluez uniquement les alertes trouvées sur la branche par défaut ou la dernière branche d’exécution s’il n’existe aucune configuration d’analyse pour la branche par défaut. <br />Sinon, incluez des alertes de toutes les branches.

ruleId

Si elle est fournie, renvoyez uniquement des alertes pour cette règle. <br />Sinon, renvoyez des alertes de toutes les règles.

ruleName

Si elle est fournie, renvoyez uniquement des alertes pour cette règle. <br />Sinon, retournez des alertes pour toutes les règles.

severities

Si elle est fournie, retournez uniquement des alertes à ces gravités. <br />Sinon, renvoyez des alertes à n’importe quel serveur.

states

Si elle est fournie, retournez uniquement des alertes dans ces états. <br />Sinon, retournez des alertes dans n’importe quel état.

toDate

Si elle est fournie, seules les alertes renvoyées sont affichées avant cette date. <br />Sinon, retournez toutes les alertes.

toolName

Si elle est fournie avec toolName, renvoyez uniquement les alertes détectées par cet outil. <br />Sinon, renvoyez des alertes détectées par tous les outils.

Détails de la propriété

alertIds

Si elle est fournie, renvoyez uniquement des alertes avec les ID spécifiés. <br />Sinon, retournez n’importe quelle alerte.

alertIds: number[]

Valeur de propriété

number[]

alertType

Si elle est fournie, renvoyez uniquement les alertes de ce type. Sinon, retournez des alertes de tous les types.

alertType: AlertType

Valeur de propriété

confidenceLevels

Si elle est fournie, retournez uniquement des alertes à ces niveaux de confiance. <br />Sinon, retournez des alertes à n’importe quel niveau de confiance.

confidenceLevels: Confidence[]

Valeur de propriété

dependencyName

Si elle est fournie, seules les alertes pour cette dépendance sont retournées. <br />Sinon, retournez des alertes pour toutes les dépendances. <br />Dans une soumission sarif, une dépendance (ou un composant) est spécifiée dans le résultat. RelatedLocations[].logicalLocation.

dependencyName: string

Valeur de propriété

string

fromDate

Si elle est fournie, seules les alertes renvoyées sont affichées en dernier après cette date. <br />Sinon, retournez toutes les alertes.

fromDate: Date

Valeur de propriété

Date

keywords

Si elle est fournie, renvoyez uniquement les alertes dont les titres correspondent à ce modèle.

keywords: string

Valeur de propriété

string

licenseName

Si elle est fournie, seules les alertes créées pour la dépendance avec cette licence sont retournées. <br />Sinon, retournez des alertes pour toutes les licences. <br />Dans une soumission sarif, une licence pour une dépendance (ou un composant) est spécifiée dans le résultat. RelatedLocations[].logicalLocation.properties.license.

licenseName: string

Valeur de propriété

string

modifiedSince

Si elle est fournie, retournez uniquement les alertes qui ont été modifiées depuis cette date. <br />Sinon, retournez toutes les alertes.

modifiedSince: Date

Valeur de propriété

Date

onlyDefaultBranchAlerts

Si la valeur est true, renvoyez uniquement les alertes trouvées sur la branche par défaut du référentiel. <br />S’il n’y a pas eu d’exécutions terminées sur la branche par défaut, la dernière exécution est utilisée à la place, quelle que soit la branche utilisée pour cette exécution. <br />Cette option est ignorée si la référence est fournie.

onlyDefaultBranchAlerts: boolean

Valeur de propriété

boolean

phaseId

Si elle est fournie avec pipelineName, retourne uniquement les alertes détectées dans cette phase de pipeline <br />Sinon, les alertes de retour détectées dans toutes les phases.

phaseId: string

Valeur de propriété

string

phaseName

Si elle est fournie avec pipelineName, retourne uniquement les alertes détectées dans cette phase de pipeline <br />Sinon, les alertes de retour détectées dans toutes les phases.

phaseName: string

Valeur de propriété

string

pipelineName

Si elle est fournie, seules les alertes renvoyées sont détectées dans ce pipeline. <br />Sinon, retournez des alertes détectées dans tous les pipelines.

pipelineName: string

Valeur de propriété

string

ref

Si elle est fournie, incluez uniquement les alertes pour cette référence. <br />Si ce n’est pas fourni et OnlyDefaultBranch a la valeur true, incluez uniquement les alertes trouvées sur la branche par défaut ou la dernière branche d’exécution s’il n’existe aucune configuration d’analyse pour la branche par défaut. <br />Sinon, incluez des alertes de toutes les branches.

ref: string

Valeur de propriété

string

ruleId

Si elle est fournie, renvoyez uniquement des alertes pour cette règle. <br />Sinon, renvoyez des alertes de toutes les règles.

ruleId: string

Valeur de propriété

string

ruleName

Si elle est fournie, renvoyez uniquement des alertes pour cette règle. <br />Sinon, retournez des alertes pour toutes les règles.

ruleName: string

Valeur de propriété

string

severities

Si elle est fournie, retournez uniquement des alertes à ces gravités. <br />Sinon, renvoyez des alertes à n’importe quel serveur.

severities: Severity[]

Valeur de propriété

states

Si elle est fournie, retournez uniquement des alertes dans ces états. <br />Sinon, retournez des alertes dans n’importe quel état.

states: State[]

Valeur de propriété

State[]

toDate

Si elle est fournie, seules les alertes renvoyées sont affichées avant cette date. <br />Sinon, retournez toutes les alertes.

toDate: Date

Valeur de propriété

Date

toolName

Si elle est fournie avec toolName, renvoyez uniquement les alertes détectées par cet outil. <br />Sinon, renvoyez des alertes détectées par tous les outils.

toolName: string

Valeur de propriété

string