SearchCriteria interface
Propriétés
| alert |
Si elle est fournie, renvoyez uniquement des alertes avec les ID spécifiés. <br />Sinon, retournez n’importe quelle alerte. |
| alert |
Si elle est fournie, renvoyez uniquement les alertes de ce type. Sinon, retournez des alertes de tous les types. |
| confidence |
Si elle est fournie, retournez uniquement des alertes à ces niveaux de confiance. <br />High et Other doivent être spécifiés pour extraire les alertes de tous les niveaux de confiance. <br />Sinon, retournez des alertes avec un niveau de confiance élevé. <br />Applicable uniquement aux alertes secrètes. |
| dependency |
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 />In a sarif submission, a dependency (or a component) is specified in result. RelatedLocations[].logicalLocation. <br />Non applicable aux alertes secrètes. |
| dependency |
Si cela est fourni, seules les alertes pour les dépendances dans ce champ de caractère sont renvoyées. < >Autrement, retour d’alertes quel que soit le champ d’application. <br />Uniquement applicable aux alertes de dépendance. |
| from |
Si elle est fournie, seules les alertes renvoyées sont affichées en dernier après cette date. <br />Sinon, retournez toutes les alertes. |
| has |
Si elle est fournie, filtre les alertes selon qu’elles ont des éléments de travail liés. <br />Régler sur « true » pour ne renvoyer que les alertes avec des éléments liés au travail. <br />Réglez sur « false » pour ne renvoyer que les alertes sans éléments liés au travail. <br />Si cela n’est pas fourni, toutes les alertes sont renversées, quel que soit le travail lié. <br />Non applicable aux alertes secrètes et de balayage de dépendances. |
| is |
Si elle est fournie avec isTriaged, renvoyez uniquement les alertes triées. < >Autrement, retour d’alertes quel que soit le statut du triage. |
| keywords | Si elle est fournie, renvoyez uniquement les alertes dont les titres correspondent à ce modèle. |
| license |
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 />In a sarif submission, license for a dependency (or a component) is specified in result. RelatedLocations[].logicalLocation.properties.license. <br />Non applicable aux alertes secrètes. |
| modified |
Si elle est fournie, retournez uniquement les alertes qui ont été modifiées depuis cette date. <br />Sinon, retournez toutes les alertes. |
| only |
Si la valeur est true ou non définie, retourne 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. Si la valeur est false, retournez des alertes de toutes les branches. <br />Cette option est ignorée si la référence est fournie. <br />Non applicable aux alertes secrètes. |
| phase |
Si elle est fournie avec pipelineName, retournez uniquement les alertes détectées dans cette phase <de pipeline br />Sinon, les alertes de retour détectées dans toutes les phases. <br />Non applicable aux alertes secrètes. |
| phase |
Si elle est fournie avec pipelineName, retournez uniquement les alertes détectées dans cette phase <de pipeline br />Sinon, les alertes de retour détectées dans toutes les phases. <br />Non applicable aux alertes secrètes. |
| pipeline |
Si fourni avec pipelineId, ne retournez que les alertes détectées dans ce pipeline <br />Sinon, retournez les alertes détectées dans tous les pipelines. |
| pipeline |
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. <br />Non applicable aux alertes secrètes. |
| ref | Si elle est fournie, incluez uniquement des alertes pour cette référence. <br />If not provided and OnlyDefaultBranch is true, only include alerts found on the default branch or last run branch if there is not analysis configuration for the default branch. <br />Sinon, incluez des alertes de toutes les branches. <br />Non applicable aux alertes secrètes. |
| rule |
Si elle est fournie, renvoyez uniquement des alertes pour cette règle. <br />Sinon, retournez des alertes de toutes les règles. |
| rule |
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, retournez des alertes à n’importe quelle gravité. |
| states | Si elle est fournie, retournez uniquement des alertes dans ces états. <br />Sinon, retournez des alertes dans n’importe quel état. |
| to |
Si elle est fournie, seules les alertes renvoyées sont affichées avant cette date. <br />Sinon, retournez toutes les alertes. |
| tool |
Si elle est fournie avec toolName, renvoyez uniquement les alertes détectées par cet outil. <br />Sinon, retournez des alertes détectées par tous les outils. |
| tool |
Si cela est fourni, ne retournez que les alertes détectées par ces outils. <br />Prend la priorité sur ToolName lorsqu’il est rempli. <br />Nécessite le drapeau de fonctionnalité EnableMultiToolSelection. |
| validity | Si elle est fournie, retournez uniquement des alertes avec la validité spécifiée ici. Si l’état de validité est Inconnu, récupérez les alertes de tous les résultats de validité. <br />Applicable uniquement aux alertes secrètes. <br />Le filtrage par statut de validité peut entraîner le renvoi d’un nombre inférieur d’alertes à celui demandé avec le paramètre TOP. <br />En raison de ce comportement, le ContinuationToken(< ![ CDATA[<nom de> l’en-tête]]>) dans l’en-tête de réponse doit être utilisé pour décider si un autre lot doit être récupéré. |
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 />High et Other doivent être spécifiés pour extraire les alertes de tous les niveaux de confiance. <br />Sinon, retournez des alertes avec un niveau de confiance élevé. <br />Applicable uniquement aux alertes secrètes.
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 />In a sarif submission, a dependency (or a component) is specified in result. RelatedLocations[].logicalLocation. <br />Non applicable aux alertes secrètes.
dependencyName: string
Valeur de propriété
string
dependencyScope
Si cela est fourni, seules les alertes pour les dépendances dans ce champ de caractère sont renvoyées. < >Autrement, retour d’alertes quel que soit le champ d’application. <br />Uniquement applicable aux alertes de dépendance.
dependencyScope: DependencyScope
Valeur de propriété
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
hasLinkedWorkItems
Si elle est fournie, filtre les alertes selon qu’elles ont des éléments de travail liés. <br />Régler sur « true » pour ne renvoyer que les alertes avec des éléments liés au travail. <br />Réglez sur « false » pour ne renvoyer que les alertes sans éléments liés au travail. <br />Si cela n’est pas fourni, toutes les alertes sont renversées, quel que soit le travail lié. <br />Non applicable aux alertes secrètes et de balayage de dépendances.
hasLinkedWorkItems: boolean
Valeur de propriété
boolean
isTriaged
Si elle est fournie avec isTriaged, renvoyez uniquement les alertes triées. < >Autrement, retour d’alertes quel que soit le statut du triage.
isTriaged: boolean
Valeur de propriété
boolean
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 />In a sarif submission, license for a dependency (or a component) is specified in result. RelatedLocations[].logicalLocation.properties.license. <br />Non applicable aux alertes secrètes.
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
onlyDefaultBranch
Si la valeur est true ou non définie, retourne 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. Si la valeur est false, retournez des alertes de toutes les branches. <br />Cette option est ignorée si la référence est fournie. <br />Non applicable aux alertes secrètes.
onlyDefaultBranch: boolean
Valeur de propriété
boolean
phaseId
Si elle est fournie avec pipelineName, retournez uniquement les alertes détectées dans cette phase <de pipeline br />Sinon, les alertes de retour détectées dans toutes les phases. <br />Non applicable aux alertes secrètes.
phaseId: string
Valeur de propriété
string
phaseName
Si elle est fournie avec pipelineName, retournez uniquement les alertes détectées dans cette phase <de pipeline br />Sinon, les alertes de retour détectées dans toutes les phases. <br />Non applicable aux alertes secrètes.
phaseName: string
Valeur de propriété
string
pipelineId
Si fourni avec pipelineId, ne retournez que les alertes détectées dans ce pipeline <br />Sinon, retournez les alertes détectées dans tous les pipelines.
pipelineId: number
Valeur de propriété
number
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. <br />Non applicable aux alertes secrètes.
pipelineName: string
Valeur de propriété
string
ref
Si elle est fournie, incluez uniquement des alertes pour cette référence. <br />If not provided and OnlyDefaultBranch is true, only include alerts found on the default branch or last run branch if there is not analysis configuration for the default branch. <br />Sinon, incluez des alertes de toutes les branches. <br />Non applicable aux alertes secrètes.
ref: string
Valeur de propriété
string
ruleId
Si elle est fournie, renvoyez uniquement des alertes pour cette règle. <br />Sinon, retournez 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, retournez des alertes à n’importe quelle gravité.
severities: Severity[]
Valeur de propriété
Severity[]
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, retournez des alertes détectées par tous les outils.
toolName: string
Valeur de propriété
string
toolNames
Si cela est fourni, ne retournez que les alertes détectées par ces outils. <br />Prend la priorité sur ToolName lorsqu’il est rempli. <br />Nécessite le drapeau de fonctionnalité EnableMultiToolSelection.
toolNames: string[]
Valeur de propriété
string[]
validity
Si elle est fournie, retournez uniquement des alertes avec la validité spécifiée ici. Si l’état de validité est Inconnu, récupérez les alertes de tous les résultats de validité. <br />Applicable uniquement aux alertes secrètes. <br />Le filtrage par statut de validité peut entraîner le renvoi d’un nombre inférieur d’alertes à celui demandé avec le paramètre TOP. <br />En raison de ce comportement, le ContinuationToken(< ![ CDATA[<nom de> l’en-tête]]>) dans l’en-tête de réponse doit être utilisé pour décider si un autre lot doit être récupéré.
validity: AlertValidityStatus[]