SearchCriteria interface

Pacote:

azure-devops-extension-api

Propriedades

alertIds	Se fornecido, retorne apenas alertas com as IDs especificadas. <br />Caso contrário, retorne qualquer alerta.
alertType	Se fornecido, retornará apenas alertas desse tipo. Caso contrário, retorne alertas de todos os tipos.
confidenceLevels	Se fornecido, retornará apenas alertas nesses níveis de confiança. <br />High e Outros precisam ser especificados para buscar alertas de todos os níveis de confiança. <br />Caso contrário, retorne alertas com alto nível de confiança. <br />Aplicável somente para alertas secretos.
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 em resultado. RelatedLocations[].logicalLocation. <br />Não aplicável para alertas secretos.
fromDate	Se fornecido, retorne apenas os alertas vistos pela última vez após essa data. <br />Caso contrário, retorne todos os alertas.
hasLinkedWorkItems	Se fornecido, filtra alertas com base em se eles têm itens de trabalho vinculados. <br />Defina para "true" para devolver apenas alertas com itens de trabalho vinculados. <br />Defina para "false" para devolver apenas alertas sem itens de trabalho vinculados. <br />Se não for fornecido, retorna todos os alertas independentemente dos itens vinculados ao trabalho. <br />Não aplicável para alertas de varredura secreta e de dependência.
keywords	Se fornecido, retornará apenas alertas cujos títulos correspondem a esse padrão.
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. <br />Não aplicável para alertas secretos.
modifiedSince	Se fornecido, retorne apenas os alertas que foram modificados desde essa data. <br />Caso contrário, retorne todos os alertas.
onlyDefaultBranch	Se for true ou não definido, 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. Se for falso, retorne alertas de todos os branches. <br />Essa opção será ignorada se o ref for fornecido. <br />Não aplicável para alertas secretos.
phaseId	Se fornecido com pipelineName, retorne apenas os alertas detectados nesta fase <do pipeline br />Caso contrário, retorne os alertas detectados em todas as fases. <br />Não aplicável para alertas secretos.
phaseName	Se fornecido com pipelineName, retorne apenas os alertas detectados nesta fase <do pipeline br />Caso contrário, retorne os alertas detectados em todas as fases. <br />Não aplicável para alertas secretos.
pipelineName	Se fornecido, retorne apenas os alertas detectados neste pipeline. <br />Caso contrário, retorne alertas detectados em todos os pipelines. <br />Não aplicável para alertas secretos.
ref	Se fornecido, inclua apenas alertas para esse ref. <br />If not provided and OnlyDefaultBranch is true, only include alerts found on the default branch or last run branch if there is no analysis configuration for the default branch. <br />Caso contrário, inclua alertas de todos os branches. <br />Não aplicável para alertas secretos.
ruleId	Se fornecido, retornará apenas alertas para essa regra. <br />Caso contrário, retorne alertas de todas as regras.
ruleName	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 gravidade.
states	Se fornecido, retornará apenas alertas nesses estados. <br />Caso contrário, retorne alertas em qualquer estado.
toDate	Se fornecido, retorne apenas os alertas vistos pela última vez antes dessa data. <br />Caso contrário, retorne todos os alertas.
toolName	Se fornecido com toolName, retorne apenas os alertas detectados por essa ferramenta. <br />Caso contrário, retorne alertas detectados por todas as ferramentas.
validity	Se fornecido, retorne apenas alertas com a validade especificada aqui. Se o status de validade for Desconhecido, busque alertas de todos os resultados de validade. <br />Aplicável somente para alertas secretos. <br />A filtragem por status de validade pode fazer com que menos alertas sejam retornados do que o solicitado com o parâmetro TOP. <br />Devido a esse comportamento, o ContinuationToken(<![ CDATA[<nome> do cabeçalho]]>) no cabeçalho de resposta deve ser confiável para decidir se outro lote precisa ser buscado.

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

AlertType

confidenceLevels

Se fornecido, retornará apenas alertas nesses níveis de confiança. <br />High e Outros precisam ser especificados para buscar alertas de todos os níveis de confiança. <br />Caso contrário, retorne alertas com alto nível de confiança. <br />Aplicável somente para alertas secretos.

confidenceLevels: Confidence[]

Valor da propriedade

Confidence[]

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 em resultado. RelatedLocations[].logicalLocation. <br />Não aplicável para alertas secretos.

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

hasLinkedWorkItems

Se fornecido, filtra alertas com base em se eles têm itens de trabalho vinculados. <br />Defina para "true" para devolver apenas alertas com itens de trabalho vinculados. <br />Defina para "false" para devolver apenas alertas sem itens de trabalho vinculados. <br />Se não for fornecido, retorna todos os alertas independentemente dos itens vinculados ao trabalho. <br />Não aplicável para alertas de varredura secreta e de dependência.

hasLinkedWorkItems: boolean

Valor da propriedade

boolean

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. <br />Não aplicável para alertas secretos.

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

onlyDefaultBranch

Se for true ou não definido, 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. Se for falso, retorne alertas de todos os branches. <br />Essa opção será ignorada se o ref for fornecido. <br />Não aplicável para alertas secretos.

onlyDefaultBranch: boolean

Valor da propriedade

boolean

phaseId

Se fornecido com pipelineName, retorne apenas os alertas detectados nesta fase <do pipeline br />Caso contrário, retorne os alertas detectados em todas as fases. <br />Não aplicável para alertas secretos.

phaseId: string

Valor da propriedade

string

phaseName

Se fornecido com pipelineName, retorne apenas os alertas detectados nesta fase <do pipeline br />Caso contrário, retorne os alertas detectados em todas as fases. <br />Não aplicável para alertas secretos.

phaseName: string

Valor da propriedade

string

pipelineName

Se fornecido, retorne apenas os alertas detectados neste pipeline. <br />Caso contrário, retorne alertas detectados em todos os pipelines. <br />Não aplicável para alertas secretos.

pipelineName: string

Valor da propriedade

string

ref

Se fornecido, inclua apenas alertas para esse ref. <br />If not provided and OnlyDefaultBranch is true, only include alerts found on the default branch or last run branch if there is no analysis configuration for the default branch. <br />Caso contrário, inclua alertas de todos os branches. <br />Não aplicável para alertas secretos.

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 gravidade.

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

validity

Se fornecido, retorne apenas alertas com a validade especificada aqui. Se o status de validade for Desconhecido, busque alertas de todos os resultados de validade. <br />Aplicável somente para alertas secretos. <br />A filtragem por status de validade pode fazer com que menos alertas sejam retornados do que o solicitado com o parâmetro TOP. <br />Devido a esse comportamento, o ContinuationToken(<![ CDATA[<nome> do cabeçalho]]>) no cabeçalho de resposta deve ser confiável para decidir se outro lote precisa ser buscado.

validity: AlertValidityStatus[]

Valor da propriedade

AlertValidityStatus[]