SearchCriteria interface
Propriedades
alert |
Se fornecido, retorne apenas alertas com as IDs especificadas. <br/>Caso contrário, retorne qualquer alerta. |
alert |
Se fornecido, retornará apenas alertas desse tipo. Caso contrário, retorne alertas de todos os tipos. |
confidence |
Se fornecido, retornará apenas alertas nesses níveis de confiança. <br/>Caso contrário, retorne alertas em qualquer nível de confiança. |
dependency |
Se fornecido, somente os alertas para essa dependência serão retornados. <br/>Caso contrário, retorne alertas para todas as dependências. <br/>Em um envio de sarif, uma dependência (ou um componente) é especificada no resultado. RelatedLocations[].logicalLocation. |
from |
Se fornecido, retorne apenas os alertas vistos pela última vez após essa data. <br/>Caso contrário, retorne todos os alertas. |
keywords | Se fornecido, retornará apenas alertas cujos títulos correspondem a esse padrão. |
license |
Se fornecido, somente os alertas criados para dependência com essa licença são retornados. <br/>Caso contrário, retorne alertas para todas as licenças. <br/>Em um envio de sarif, a licença para uma dependência (ou um componente) é especificada no resultado. RelatedLocations[].logicalLocation.properties.license. |
modified |
Se fornecido, retorne apenas os alertas que foram modificados desde essa data. <br/>Caso contrário, retorne todos os alertas. |
only |
Se for true, retorne apenas os alertas encontrados no branch padrão do repositório. <br/>Se não houver nenhuma execução concluída no branch padrão, a última execução será usada, independentemente do branch usado para essa execução. <br/>Essa opção será ignorada se o ref for fornecido. |
phase |
Se fornecido com pipelineName, retorne apenas os alertas detectados nesta fase de pipeline <br/>Caso contrário, retorne os alertas detectados em todas as fases. |
phase |
Se fornecido com pipelineName, retorne apenas os alertas detectados nesta fase de pipeline <br/>Caso contrário, retorne os alertas detectados em todas as fases. |
pipeline |
Se fornecido, retorne apenas os alertas detectados neste pipeline. <br/>Caso contrário, retorne os alertas detectados em todos os pipelines. |
ref | Se fornecido, inclua apenas alertas para esse ref. <br/>Se não for fornecido e OnlyDefaultBranch for true, inclua apenas os alertas encontrados no branch padrão ou na ramificação de última execução se não houver nenhuma configuração de análise para o branch padrão. <br/>Caso contrário, inclua alertas de todos os branches. |
rule |
Se fornecido, retornará apenas alertas para essa regra. <br/>Caso contrário, retorne alertas de todas as regras. |
rule |
Se fornecido, retornará apenas alertas para essa regra. <br/>Caso contrário, retorne alertas para todas as regras. |
severities | Se fornecido, retornará apenas alertas nessas severidades. <br/>Caso contrário, retorne alertas em qualquer servidoridade. |
states | Se fornecido, retornará apenas alertas nesses estados. <br/>Caso contrário, retorne alertas em qualquer estado. |
to |
Se fornecido, retorne apenas os alertas vistos pela última vez antes dessa data. <br/>Caso contrário, retorne todos os alertas. |
tool |
Se fornecido com toolName, retorne apenas os alertas detectados por essa ferramenta. <br/>Caso contrário, retorne alertas detectados por todas as ferramentas. |
Detalhes da propriedade
alertIds
Se fornecido, retorne apenas alertas com as IDs especificadas. <br/>Caso contrário, retorne qualquer alerta.
alertIds: number[]
Valor da propriedade
number[]
alertType
Se fornecido, retornará apenas alertas desse tipo. Caso contrário, retorne alertas de todos os tipos.
alertType: AlertType
Valor da propriedade
confidenceLevels
Se fornecido, retornará apenas alertas nesses níveis de confiança. <br/>Caso contrário, retorne alertas em qualquer nível de confiança.
confidenceLevels: Confidence[]
Valor da propriedade
dependencyName
Se fornecido, somente os alertas para essa dependência serão retornados. <br/>Caso contrário, retorne alertas para todas as dependências. <br/>Em um envio de sarif, uma dependência (ou um componente) é especificada no resultado. RelatedLocations[].logicalLocation.
dependencyName: string
Valor da propriedade
string
fromDate
Se fornecido, retorne apenas os alertas vistos pela última vez após essa data. <br/>Caso contrário, retorne todos os alertas.
fromDate: Date
Valor da propriedade
Date
keywords
Se fornecido, retornará apenas alertas cujos títulos correspondem a esse padrão.
keywords: string
Valor da propriedade
string
licenseName
Se fornecido, somente os alertas criados para dependência com essa licença são retornados. <br/>Caso contrário, retorne alertas para todas as licenças. <br/>Em um envio de sarif, a licença para uma dependência (ou um componente) é especificada no resultado. RelatedLocations[].logicalLocation.properties.license.
licenseName: string
Valor da propriedade
string
modifiedSince
Se fornecido, retorne apenas os alertas que foram modificados desde essa data. <br/>Caso contrário, retorne todos os alertas.
modifiedSince: Date
Valor da propriedade
Date
onlyDefaultBranchAlerts
Se for true, retorne apenas os alertas encontrados no branch padrão do repositório. <br/>Se não houver nenhuma execução concluída no branch padrão, a última execução será usada, independentemente do branch usado para essa execução. <br/>Essa opção será ignorada se o ref for fornecido.
onlyDefaultBranchAlerts: boolean
Valor da propriedade
boolean
phaseId
Se fornecido com pipelineName, retorne apenas os alertas detectados nesta fase de pipeline <br/>Caso contrário, retorne os alertas detectados em todas as fases.
phaseId: string
Valor da propriedade
string
phaseName
Se fornecido com pipelineName, retorne apenas os alertas detectados nesta fase de pipeline <br/>Caso contrário, retorne os alertas detectados em todas as fases.
phaseName: string
Valor da propriedade
string
pipelineName
Se fornecido, retorne apenas os alertas detectados neste pipeline. <br/>Caso contrário, retorne os alertas detectados em todos os pipelines.
pipelineName: string
Valor da propriedade
string
ref
Se fornecido, inclua apenas alertas para esse ref. <br/>Se não for fornecido e OnlyDefaultBranch for true, inclua apenas os alertas encontrados no branch padrão ou na ramificação de última execução se não houver nenhuma configuração de análise para o branch padrão. <br/>Caso contrário, inclua alertas de todos os branches.
ref: string
Valor da propriedade
string
ruleId
Se fornecido, retornará apenas alertas para essa regra. <br/>Caso contrário, retorne alertas de todas as regras.
ruleId: string
Valor da propriedade
string
ruleName
Se fornecido, retornará apenas alertas para essa regra. <br/>Caso contrário, retorne alertas para todas as regras.
ruleName: string
Valor da propriedade
string
severities
Se fornecido, retornará apenas alertas nessas severidades. <br/>Caso contrário, retorne alertas em qualquer servidoridade.
severities: Severity[]
Valor da propriedade
Severity[]
states
Se fornecido, retornará apenas alertas nesses estados. <br/>Caso contrário, retorne alertas em qualquer estado.
states: State[]
Valor da propriedade
State[]
toDate
Se fornecido, retorne apenas os alertas vistos pela última vez antes dessa data. <br/>Caso contrário, retorne todos os alertas.
toDate: Date
Valor da propriedade
Date
toolName
Se fornecido com toolName, retorne apenas os alertas detectados por essa ferramenta. <br/>Caso contrário, retorne alertas detectados por todas as ferramentas.
toolName: string
Valor da propriedade
string