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, 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 /> Tanto Alto quanto 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 />Apenas aplicável a alertas secretos.
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. <br />Não aplicável a alertas secretos.
fromDate	Se fornecido, apenas os alertas de retorno vistos pela última vez após essa data. <br />Caso contrário, retorne todos os alertas.
hasLinkedWorkItems	Se for, filtra os alertas com base em se têm itens de trabalho ligados. <br />Defina para "true" para devolver apenas alertas com itens de trabalho ligados. <br />Defina para "false" para devolver apenas alertas sem itens de trabalho ligados. <br />Se não for fornecido, devolve todos os alertas independentemente dos itens de trabalho ligados. <br />Não aplicável a alertas secretos e de varredura de dependências.
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. <br />Não aplicável a alertas secretos.
modifiedSince	Se fornecido, apenas retornará alertas que foram modificados desde essa data. <br />Caso contrário, retorne todos os alertas.
onlyDefaultBranch	Se true ou não estiver definido, 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. Se false, retorne alertas de todas as ramificações. <br />Esta opção é ignorada se ref for fornecida. <br />Não aplicável a alertas secretos.
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. <br />Não aplicável a alertas secretos.
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. <br />Não aplicável a alertas secretos.
pipelineName	Se fornecido, apenas os alertas de retorno detetados nesse pipeline. <br />Caso contrário, retorne alertas detetados em todos os pipelines. <br />Não aplicável a alertas secretos.
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. <br />Não aplicável a alertas secretos.
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 gravidade.
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.
validity	Se fornecido, apenas alertas de retorno com a validade especificada aqui. Se o status de validade for Desconhecido, busque alertas de todos os resultados de validade. <br />Apenas aplicável a 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[<header name>]]>) no cabeçalho de resposta deve ser usado para decidir se outro lote precisa ser buscado.

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

AlertType

confidenceLevels

Se fornecido, apenas retorne alertas nesses níveis de confiança. <br /> Tanto Alto quanto 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 />Apenas aplicável a alertas secretos.

confidenceLevels: Confidence[]

Valor de Propriedade

Confidence[]

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

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

hasLinkedWorkItems

Se for, filtra os alertas com base em se têm itens de trabalho ligados. <br />Defina para "true" para devolver apenas alertas com itens de trabalho ligados. <br />Defina para "false" para devolver apenas alertas sem itens de trabalho ligados. <br />Se não for fornecido, devolve todos os alertas independentemente dos itens de trabalho ligados. <br />Não aplicável a alertas secretos e de varredura de dependências.

hasLinkedWorkItems: boolean

Valor de Propriedade

boolean

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

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

onlyDefaultBranch

Se true ou não estiver definido, 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. Se false, retorne alertas de todas as ramificações. <br />Esta opção é ignorada se ref for fornecida. <br />Não aplicável a alertas secretos.

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

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

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

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

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

severities: Severity[]

Valor de Propriedade

Severity[]

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

validity

Se fornecido, apenas alertas de retorno com a validade especificada aqui. Se o status de validade for Desconhecido, busque alertas de todos os resultados de validade. <br />Apenas aplicável a 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[<header name>]]>) no cabeçalho de resposta deve ser usado para decidir se outro lote precisa ser buscado.

validity: AlertValidityStatus[]

Valor de Propriedade

AlertValidityStatus[]