Compartir a través de


SearchCriteria interface

Propiedades

alertIds

Si se proporciona, solo devuelve alertas con los identificadores especificados. <br/>De lo contrario, devuelve cualquier alerta.

alertType

Si se proporciona, solo devuelve alertas de este tipo. De lo contrario, devuelve alertas de todos los tipos.

confidenceLevels

Si se proporciona, solo devuelve alertas en estos niveles de confianza. <br/>De lo contrario, devuelve alertas en cualquier nivel de confianza.

dependencyName

Si se proporciona, solo se devuelven alertas para esta dependencia. <br/>De lo contrario, devuelve alertas para todas las dependencias. <br />En un envío sarif, se especifica una dependencia (o un componente) como resultado. RelatedLocations[].logicalLocation.

fromDate

Si se proporciona, solo se devuelven las alertas que se vieron después de esta fecha. <br/>De lo contrario, devuelve todas las alertas.

keywords

Si se proporciona, solo devuelve alertas cuyos títulos coinciden con este patrón.

licenseName

Si se proporciona, solo se devuelven las alertas creadas para la dependencia con esta licencia. <br/>De lo contrario, devuelve alertas para todas las licencias. <br />En un envío sarif, se especifica una licencia para una dependencia (o un componente) como resultado. RelatedLocations[].logicalLocation.properties.license.

modifiedSince

Si se proporciona, solo devuelve alertas que se modificaron desde esta fecha. <br/>De lo contrario, devuelve todas las alertas.

onlyDefaultBranchAlerts

Si es true, solo se devuelven alertas encontradas en la rama predeterminada del repositorio. <br />Si no se ha completado ninguna ejecución en la rama predeterminada, la última ejecución se usa en lugar de independientemente de la rama usada para esa ejecución. <br />Esta opción se omite si se proporciona ref.

phaseId

Si se proporciona con pipelineName, solo devuelve alertas detectadas en esta fase de canalización <br/>De lo contrario, devuelve alertas detectadas en todas las fases.

phaseName

Si se proporciona con pipelineName, solo devuelve alertas detectadas en esta fase de canalización <br/>De lo contrario, devuelve alertas detectadas en todas las fases.

pipelineName

Si se proporciona, solo se devuelven alertas detectadas en esta canalización. <br/>De lo contrario, devuelve alertas detectadas en todas las canalizaciones.

ref

Si se proporciona, solo incluya alertas para esta referencia. <br />Si no se proporciona y OnlyDefaultBranch es true, solo se incluyen alertas encontradas en la rama predeterminada o en la rama de última ejecución si no hay ninguna configuración de análisis para la rama predeterminada. <br/>De lo contrario, incluya alertas de todas las ramas.

ruleId

Si se proporciona, solo devuelve alertas para esta regla. <br/>De lo contrario, devuelve alertas de todas las reglas.

ruleName

Si se proporciona, solo devuelve alertas para esta regla. <br/>De lo contrario, devuelve alertas para todas las reglas.

severities

Si se proporciona, solo devuelve alertas en estas gravedades. <br />De lo contrario, devuelve alertas en cualquier servidor.

states

Si se proporciona, solo devuelve alertas en estos estados. <br/>De lo contrario, devuelve alertas en cualquier estado.

toDate

Si se proporciona, solo se devuelven las alertas que se vieron antes de esta fecha. <br/>De lo contrario, devuelve todas las alertas.

toolName

Si se proporciona con toolName, solo devuelve alertas detectadas por esta herramienta. <br/>De lo contrario, devuelve alertas detectadas por todas las herramientas.

Detalles de las propiedades

alertIds

Si se proporciona, solo devuelve alertas con los identificadores especificados. <br/>De lo contrario, devuelve cualquier alerta.

alertIds: number[]

Valor de propiedad

number[]

alertType

Si se proporciona, solo devuelve alertas de este tipo. De lo contrario, devuelve alertas de todos los tipos.

alertType: AlertType

Valor de propiedad

confidenceLevels

Si se proporciona, solo devuelve alertas en estos niveles de confianza. <br/>De lo contrario, devuelve alertas en cualquier nivel de confianza.

confidenceLevels: Confidence[]

Valor de propiedad

dependencyName

Si se proporciona, solo se devuelven alertas para esta dependencia. <br/>De lo contrario, devuelve alertas para todas las dependencias. <br />En un envío sarif, se especifica una dependencia (o un componente) como resultado. RelatedLocations[].logicalLocation.

dependencyName: string

Valor de propiedad

string

fromDate

Si se proporciona, solo se devuelven las alertas que se vieron después de esta fecha. <br/>De lo contrario, devuelve todas las alertas.

fromDate: Date

Valor de propiedad

Date

keywords

Si se proporciona, solo devuelve alertas cuyos títulos coinciden con este patrón.

keywords: string

Valor de propiedad

string

licenseName

Si se proporciona, solo se devuelven las alertas creadas para la dependencia con esta licencia. <br/>De lo contrario, devuelve alertas para todas las licencias. <br />En un envío sarif, se especifica una licencia para una dependencia (o un componente) como resultado. RelatedLocations[].logicalLocation.properties.license.

licenseName: string

Valor de propiedad

string

modifiedSince

Si se proporciona, solo devuelve alertas que se modificaron desde esta fecha. <br/>De lo contrario, devuelve todas las alertas.

modifiedSince: Date

Valor de propiedad

Date

onlyDefaultBranchAlerts

Si es true, solo se devuelven alertas encontradas en la rama predeterminada del repositorio. <br />Si no se ha completado ninguna ejecución en la rama predeterminada, la última ejecución se usa en lugar de independientemente de la rama usada para esa ejecución. <br />Esta opción se omite si se proporciona ref.

onlyDefaultBranchAlerts: boolean

Valor de propiedad

boolean

phaseId

Si se proporciona con pipelineName, solo devuelve alertas detectadas en esta fase de canalización <br/>De lo contrario, devuelve alertas detectadas en todas las fases.

phaseId: string

Valor de propiedad

string

phaseName

Si se proporciona con pipelineName, solo devuelve alertas detectadas en esta fase de canalización <br/>De lo contrario, devuelve alertas detectadas en todas las fases.

phaseName: string

Valor de propiedad

string

pipelineName

Si se proporciona, solo se devuelven alertas detectadas en esta canalización. <br/>De lo contrario, devuelve alertas detectadas en todas las canalizaciones.

pipelineName: string

Valor de propiedad

string

ref

Si se proporciona, solo incluya alertas para esta referencia. <br />Si no se proporciona y OnlyDefaultBranch es true, solo se incluyen alertas encontradas en la rama predeterminada o en la rama de última ejecución si no hay ninguna configuración de análisis para la rama predeterminada. <br/>De lo contrario, incluya alertas de todas las ramas.

ref: string

Valor de propiedad

string

ruleId

Si se proporciona, solo devuelve alertas para esta regla. <br/>De lo contrario, devuelve alertas de todas las reglas.

ruleId: string

Valor de propiedad

string

ruleName

Si se proporciona, solo devuelve alertas para esta regla. <br/>De lo contrario, devuelve alertas para todas las reglas.

ruleName: string

Valor de propiedad

string

severities

Si se proporciona, solo devuelve alertas en estas gravedades. <br />De lo contrario, devuelve alertas en cualquier servidor.

severities: Severity[]

Valor de propiedad

states

Si se proporciona, solo devuelve alertas en estos estados. <br/>De lo contrario, devuelve alertas en cualquier estado.

states: State[]

Valor de propiedad

State[]

toDate

Si se proporciona, solo se devuelven las alertas que se vieron antes de esta fecha. <br/>De lo contrario, devuelve todas las alertas.

toDate: Date

Valor de propiedad

Date

toolName

Si se proporciona con toolName, solo devuelve alertas detectadas por esta herramienta. <br/>De lo contrario, devuelve alertas detectadas por todas las herramientas.

toolName: string

Valor de propiedad

string