Partilhar via


SearchCriteria interface

Propriedades

alertIds

Se fornecido, retorne apenas alertas com as ids especificadas. <br />Caso contrário, retorne qualquer alerta.

alertType

Se fornecido, apenas retorne alertas desse tipo. Caso contrário, retorne alertas de todos os tipos.

confidenceLevels

Se fornecido, apenas retorne alertas nesses níveis de confiança. <br />Caso contrário, retorne alertas em qualquer nível de confiança.

dependencyName

Se fornecido, apenas os alertas para essa dependência serão retornados. <br />Caso contrário, retorne alertas para todas as dependências. <br />Em um envio sarif, uma dependência (ou um componente) é especificada no resultado. RelatedLocations[].logicalLocation.

fromDate

Se fornecido, apenas os alertas de retorno vistos pela última vez após essa data. <br />Caso contrário, retorne todos os alertas.

keywords

Se fornecido, retorne apenas alertas cujos títulos correspondam a esse padrão.

licenseName

Se fornecido, apenas os alertas criados para dependência com esta licença são retornados. <br />Caso contrário, retorne alertas para todas as licenças. <br />Em um envio sarif, a licença para uma dependência (ou um componente) é especificada no resultado. RelatedLocations[].logicalLocation.properties.license.

modifiedSince

Se fornecido, apenas retornará alertas que foram modificados desde essa data. <br />Caso contrário, retorne todos os alertas.

onlyDefaultBranchAlerts

Se verdadeiro, apenas retornará alertas encontrados na ramificação padrão do repositório. <br />Se não houver nenhuma execução concluída na ramificação padrão, a última execução será usada em vez disso, independentemente da ramificação usada para essa execução. <br />Esta opção é ignorada se ref for fornecida.

phaseId

Se fornecido com pipelineName, apenas alertas de retorno detetados nesta fase de pipeline <br />Caso contrário, retorne alertas detetados em todas as fases.

phaseName

Se fornecido com pipelineName, apenas alertas de retorno detetados nesta fase de pipeline <br />Caso contrário, retorne alertas detetados em todas as fases.

pipelineName

Se fornecido, apenas os alertas de retorno detetados nesse pipeline. <br />Caso contrário, retorne alertas detetados em todos os pipelines.

ref

Se fornecido, inclua apenas alertas para esta ref. <br />Se não for fornecido e OnlyDefaultBranch for true, inclua apenas alertas encontrados na ramificação padrão ou na ramificação de última execução se não houver nenhuma configuração de análise para a ramificação padrão. <br />Caso contrário, inclua alertas de todas as filiais.

ruleId

Se fornecido, apenas retorne alertas para esta regra. <br />Caso contrário, retorne alertas de todas as regras.

ruleName

Se fornecido, apenas retorne alertas para esta regra. <br />Caso contrário, retorne alertas para todas as regras.

severities

Se fornecido, apenas retorne alertas nessas gravidades. <br />Caso contrário, retorne alertas em qualquer servidor.

states

Se fornecido, apenas alertas de retorno nesses estados. <br />Caso contrário, retorne alertas em qualquer estado.

toDate

Se fornecido, apenas os alertas de retorno vistos pela última vez antes dessa data. <br />Caso contrário, retorne todos os alertas.

toolName

Se fornecido com toolName, apenas retornará alertas detetados por essa ferramenta. <br />Caso contrário, retorne alertas detetados por todas as ferramentas.

Detalhes de Propriedade

alertIds

Se fornecido, retorne apenas alertas com as ids especificadas. <br />Caso contrário, retorne qualquer alerta.

alertIds: number[]

Valor de Propriedade

number[]

alertType

Se fornecido, apenas retorne alertas desse tipo. Caso contrário, retorne alertas de todos os tipos.

alertType: AlertType

Valor de Propriedade

confidenceLevels

Se fornecido, apenas retorne alertas nesses níveis de confiança. <br />Caso contrário, retorne alertas em qualquer nível de confiança.

confidenceLevels: Confidence[]

Valor de Propriedade

dependencyName

Se fornecido, apenas os alertas para essa dependência serão retornados. <br />Caso contrário, retorne alertas para todas as dependências. <br />Em um envio sarif, uma dependência (ou um componente) é especificada no resultado. RelatedLocations[].logicalLocation.

dependencyName: string

Valor de Propriedade

string

fromDate

Se fornecido, apenas os alertas de retorno vistos pela última vez após essa data. <br />Caso contrário, retorne todos os alertas.

fromDate: Date

Valor de Propriedade

Date

keywords

Se fornecido, retorne apenas alertas cujos títulos correspondam a esse padrão.

keywords: string

Valor de Propriedade

string

licenseName

Se fornecido, apenas os alertas criados para dependência com esta licença são retornados. <br />Caso contrário, retorne alertas para todas as licenças. <br />Em um envio sarif, a licença para uma dependência (ou um componente) é especificada no resultado. RelatedLocations[].logicalLocation.properties.license.

licenseName: string

Valor de Propriedade

string

modifiedSince

Se fornecido, apenas retornará alertas que foram modificados desde essa data. <br />Caso contrário, retorne todos os alertas.

modifiedSince: Date

Valor de Propriedade

Date

onlyDefaultBranchAlerts

Se verdadeiro, apenas retornará alertas encontrados na ramificação padrão do repositório. <br />Se não houver nenhuma execução concluída na ramificação padrão, a última execução será usada em vez disso, independentemente da ramificação usada para essa execução. <br />Esta opção é ignorada se ref for fornecida.

onlyDefaultBranchAlerts: boolean

Valor de Propriedade

boolean

phaseId

Se fornecido com pipelineName, apenas alertas de retorno detetados nesta fase de pipeline <br />Caso contrário, retorne alertas detetados em todas as fases.

phaseId: string

Valor de Propriedade

string

phaseName

Se fornecido com pipelineName, apenas alertas de retorno detetados nesta fase de pipeline <br />Caso contrário, retorne alertas detetados em todas as fases.

phaseName: string

Valor de Propriedade

string

pipelineName

Se fornecido, apenas os alertas de retorno detetados nesse pipeline. <br />Caso contrário, retorne alertas detetados em todos os pipelines.

pipelineName: string

Valor de Propriedade

string

ref

Se fornecido, inclua apenas alertas para esta ref. <br />Se não for fornecido e OnlyDefaultBranch for true, inclua apenas alertas encontrados na ramificação padrão ou na ramificação de última execução se não houver nenhuma configuração de análise para a ramificação padrão. <br />Caso contrário, inclua alertas de todas as filiais.

ref: string

Valor de Propriedade

string

ruleId

Se fornecido, apenas retorne alertas para esta regra. <br />Caso contrário, retorne alertas de todas as regras.

ruleId: string

Valor de Propriedade

string

ruleName

Se fornecido, apenas retorne alertas para esta regra. <br />Caso contrário, retorne alertas para todas as regras.

ruleName: string

Valor de Propriedade

string

severities

Se fornecido, apenas retorne alertas nessas gravidades. <br />Caso contrário, retorne alertas em qualquer servidor.

severities: Severity[]

Valor de Propriedade

states

Se fornecido, apenas alertas de retorno nesses estados. <br />Caso contrário, retorne alertas em qualquer estado.

states: State[]

Valor de Propriedade

State[]

toDate

Se fornecido, apenas os alertas de retorno vistos pela última vez antes dessa data. <br />Caso contrário, retorne todos os alertas.

toDate: Date

Valor de Propriedade

Date

toolName

Se fornecido com toolName, apenas retornará alertas detetados por essa ferramenta. <br />Caso contrário, retorne alertas detetados por todas as ferramentas.

toolName: string

Valor de Propriedade

string