SearchCriteria interface

Пакет:

azure-devops-extension-api

Свойства

alertIds	Если указано, возвращаются только оповещения с указанными идентификаторами. <br />В противном случае верните любое оповещение.
alertType	Если это указано, возвращаются только оповещения этого типа. В противном случае возвращаются оповещения всех типов.
confidenceLevels	Если это указано, возвращаются только оповещения на этих уровнях достоверности. <br />High и Other необходимо указать для получения оповещений обо всех уровнях достоверности. <br />В противном случае возвращает оповещения с высоким уровнем достоверности. <br />Only применимо для секретных оповещений.
dependencyName	Если это указано, возвращаются только оповещения для этой зависимости. <br />В противном случае возвращает оповещения для всех зависимостей. <br />В отправке sarif указывается зависимость (или компонент). RelatedLocations[].logicalLocation. <br />Неприменимо для секретных оповещений.
fromDate	Если это указано, возвращаются только оповещения после этой даты. <br />В противном случае возвращаются все оповещения.
hasLinkedWorkItems	При условии фильтрация оповещений зависит от того, имеют ли они связанные рабочие элементы. <br />Set на «true», чтобы возвращать только оповещения с привязанными рабочими элементами. <br />Установите на «false», чтобы возвращать только оповещения без связанных рабочих элементов. <br />Если не предоставляется, возвращает все оповещения независимо от связанных рабочих элементов. <br />Не применимо для секретных и зависимых сканирующих оповещений.
keywords	Если это указано, возвращаются только оповещения, заголовки которых соответствуют этому шаблону.
licenseName	При условии возвращаются только оповещения, созданные для зависимостей с этой лицензией. <br />В противном случае возвращает оповещения для всех лицензий. <br />В отправке sarif лицензия на зависимость (или компонент) указывается в результате. RelatedLocations[].logicalLocation.properties.license. <br />Неприменимо для секретных оповещений.
modifiedSince	Если это указано, возвращаются только оповещения, которые были изменены с этой даты. <br />В противном случае возвращаются все оповещения.
onlyDefaultBranch	Если задано значение true или не задано, возвращаются только оповещения, найденные в ветви репозитория по умолчанию. <br />Если в ветви по умолчанию не было завершено выполнение, то последний запуск используется вместо ветви, используемой для этого запуска. Если значение false, возвращает оповещения из всех ветвей. <br />Этот параметр игнорируется, если указан ссылка. <br />Неприменимо для секретных оповещений.
phaseId	Если задано имя конвейера, возвращаются только оповещения, обнаруженные на этом этапе конвейера <br />В противном случае возвращаются оповещения, обнаруженные во всех этапах. <br />Неприменимо для секретных оповещений.
phaseName	Если задано имя конвейера, возвращаются только оповещения, обнаруженные на этом этапе конвейера <br />В противном случае возвращаются оповещения, обнаруженные во всех этапах. <br />Неприменимо для секретных оповещений.
pipelineName	Если это указано, возвращаются только оповещения, обнаруженные в этом конвейере. <br />В противном случае возвращаются оповещения, обнаруженные во всех конвейерах. <br />Неприменимо для секретных оповещений.
ref	Если это указано, включите только оповещения для этого ссылки. <br />Если не указано и OnlyDefaultBranch имеет значение true, включите только оповещения, найденные в ветви по умолчанию или последней ветви запуска, если для ветви по умолчанию нет конфигурации анализа. <br />В противном случае включите оповещения со всех ветвей. <br />Неприменимо для секретных оповещений.
ruleId	Если это указано, возвращаются только оповещения для этого правила. <br />В противном случае возвращает оповещения обо всех правилах.
ruleName	Если это указано, возвращаются только оповещения для этого правила. <br />В противном случае возвращает оповещения для всех правил.
severities	Если это указано, возвращаются только оповещения по этим уровням серьезности. <br />В противном случае возвращает оповещения по любой серьезности.
states	Если это указано, возвращаются только оповещения в этих состояниях. <br />В противном случае возвращает оповещения в любом состоянии.
toDate	Если это указано, до этой даты возвращаются только оповещения. <br />В противном случае возвращаются все оповещения.
toolName	Если задано значение toolName, возвращаются только оповещения, обнаруженные этим средством. <br />В противном случае возвращаются оповещения, обнаруженные всеми средствами.
validity	Если это указано, возвращаются только оповещения с допустимым значением, указанным здесь. Если состояние допустимости является неизвестным, получите оповещения обо всех результатах действия. <br />Only применимо для секретных оповещений. <br />Фильтрация по статусу валидности может привести к тому, что будет возвращено меньше предупреждений, чем запрашивалось с параметром TOP. <br />Из-за такого поведения ContinuationToken(<![ CDATA[<имя> заголовка]]>) в заголовке ответа, следует полагаться на решение о том, нужно ли получить еще одну партию.

Подробнее

alertIds

Если указано, возвращаются только оповещения с указанными идентификаторами. <br />В противном случае верните любое оповещение.

alertIds: number[]

Стоимость недвижимости

number[]

alertType

Если это указано, возвращаются только оповещения этого типа. В противном случае возвращаются оповещения всех типов.

alertType: AlertType

Стоимость недвижимости

AlertType

confidenceLevels

Если это указано, возвращаются только оповещения на этих уровнях достоверности. <br />High и Other необходимо указать для получения оповещений обо всех уровнях достоверности. <br />В противном случае возвращает оповещения с высоким уровнем достоверности. <br />Only применимо для секретных оповещений.

confidenceLevels: Confidence[]

Стоимость недвижимости

Confidence[]

dependencyName

Если это указано, возвращаются только оповещения для этой зависимости. <br />В противном случае возвращает оповещения для всех зависимостей. <br />В отправке sarif указывается зависимость (или компонент). RelatedLocations[].logicalLocation. <br />Неприменимо для секретных оповещений.

dependencyName: string

Стоимость недвижимости

string

fromDate

Если это указано, возвращаются только оповещения после этой даты. <br />В противном случае возвращаются все оповещения.

fromDate: Date

Стоимость недвижимости

Date

hasLinkedWorkItems

При условии фильтрация оповещений зависит от того, имеют ли они связанные рабочие элементы. <br />Set на «true», чтобы возвращать только оповещения с привязанными рабочими элементами. <br />Установите на «false», чтобы возвращать только оповещения без связанных рабочих элементов. <br />Если не предоставляется, возвращает все оповещения независимо от связанных рабочих элементов. <br />Не применимо для секретных и зависимых сканирующих оповещений.

hasLinkedWorkItems: boolean

Стоимость недвижимости

boolean

keywords

Если это указано, возвращаются только оповещения, заголовки которых соответствуют этому шаблону.

keywords: string

Стоимость недвижимости

string

licenseName

При условии возвращаются только оповещения, созданные для зависимостей с этой лицензией. <br />В противном случае возвращает оповещения для всех лицензий. <br />В отправке sarif лицензия на зависимость (или компонент) указывается в результате. RelatedLocations[].logicalLocation.properties.license. <br />Неприменимо для секретных оповещений.

licenseName: string

Стоимость недвижимости

string

modifiedSince

Если это указано, возвращаются только оповещения, которые были изменены с этой даты. <br />В противном случае возвращаются все оповещения.

modifiedSince: Date

Стоимость недвижимости

Date

onlyDefaultBranch

Если задано значение true или не задано, возвращаются только оповещения, найденные в ветви репозитория по умолчанию. <br />Если в ветви по умолчанию не было завершено выполнение, то последний запуск используется вместо ветви, используемой для этого запуска. Если значение false, возвращает оповещения из всех ветвей. <br />Этот параметр игнорируется, если указан ссылка. <br />Неприменимо для секретных оповещений.

onlyDefaultBranch: boolean

Стоимость недвижимости

boolean

phaseId

Если задано имя конвейера, возвращаются только оповещения, обнаруженные на этом этапе конвейера <br />В противном случае возвращаются оповещения, обнаруженные во всех этапах. <br />Неприменимо для секретных оповещений.

phaseId: string

Стоимость недвижимости

string

phaseName

Если задано имя конвейера, возвращаются только оповещения, обнаруженные на этом этапе конвейера <br />В противном случае возвращаются оповещения, обнаруженные во всех этапах. <br />Неприменимо для секретных оповещений.

phaseName: string

Стоимость недвижимости

string

pipelineName

Если это указано, возвращаются только оповещения, обнаруженные в этом конвейере. <br />В противном случае возвращаются оповещения, обнаруженные во всех конвейерах. <br />Неприменимо для секретных оповещений.

pipelineName: string

Стоимость недвижимости

string

ref

Если это указано, включите только оповещения для этого ссылки. <br />Если не указано и OnlyDefaultBranch имеет значение true, включите только оповещения, найденные в ветви по умолчанию или последней ветви запуска, если для ветви по умолчанию нет конфигурации анализа. <br />В противном случае включите оповещения со всех ветвей. <br />Неприменимо для секретных оповещений.

ref: string

Стоимость недвижимости

string

ruleId

Если это указано, возвращаются только оповещения для этого правила. <br />В противном случае возвращает оповещения обо всех правилах.

ruleId: string

Стоимость недвижимости

string

ruleName

Если это указано, возвращаются только оповещения для этого правила. <br />В противном случае возвращает оповещения для всех правил.

ruleName: string

Стоимость недвижимости

string

severities

Если это указано, возвращаются только оповещения по этим уровням серьезности. <br />В противном случае возвращает оповещения по любой серьезности.

severities: Severity[]

Стоимость недвижимости

Severity[]

states

Если это указано, возвращаются только оповещения в этих состояниях. <br />В противном случае возвращает оповещения в любом состоянии.

states: State[]

Стоимость недвижимости

State[]

toDate

Если это указано, до этой даты возвращаются только оповещения. <br />В противном случае возвращаются все оповещения.

toDate: Date

Стоимость недвижимости

Date

toolName

Если задано значение toolName, возвращаются только оповещения, обнаруженные этим средством. <br />В противном случае возвращаются оповещения, обнаруженные всеми средствами.

toolName: string

Стоимость недвижимости

string

validity

Если это указано, возвращаются только оповещения с допустимым значением, указанным здесь. Если состояние допустимости является неизвестным, получите оповещения обо всех результатах действия. <br />Only применимо для секретных оповещений. <br />Фильтрация по статусу валидности может привести к тому, что будет возвращено меньше предупреждений, чем запрашивалось с параметром TOP. <br />Из-за такого поведения ContinuationToken(<![ CDATA[<имя> заголовка]]>) в заголовке ответа, следует полагаться на решение о том, нужно ли получить еще одну партию.

validity: AlertValidityStatus[]

Стоимость недвижимости

AlertValidityStatus[]