AlertRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

AlertRestClient(IVssRestClientOptions)

Методы

getAlert(string, number, string, string, ExpandOption)	Получите оповещение.
getAlertInstances(string, number, string, string)	Получение экземпляров оповещения.
getAlerts(string, string, number, string, SearchCriteria, string)	Получение оповещений для репозитория
getAlertSarif(string, number, string, string, ExpandOption)	Получите оповещение.
getSarif(number)	Получение состояния задания обработки Sarif
getUxFilters(string, string, AlertType)
updateAlert(AlertStateUpdate, string, number, string)	Обновление состояния оповещения
updateAlertsMetadata(AlertMetadata[], string, string)	Обновление сопоставлений метаданных оповещений.
uploadSarif(string, string, string)	Отправка sarif, содержащего оповещения системы безопасности

Сведения о конструкторе

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о методе

getAlert(string, number, string, string, ExpandOption)

Получите оповещение.

function getAlert(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<Alert>

Параметры

project

string

Идентификатор проекта или имя проекта

alertId

number

Идентификатор извлекаемого оповещения

repository

string

Имя или идентификатор репозитория, в который входит оповещение

ref

string

expand

ExpandOption

Разверните атрибуты оповещения. Возможные параметры: {ValidationFingerprint, None}

Возвращаемое значение

Promise<Alert>

getAlertInstances(string, number, string, string)

Получение экземпляров оповещения.

function getAlertInstances(project: string, alertId: number, repository: string, ref?: string): Promise<AlertAnalysisInstance[]>

Параметры

project

string

Идентификатор проекта или имя проекта

alertId

number

Идентификатор извлекаемого оповещения

repository

string

Имя или идентификатор репозитория, в который входит оповещение

ref

string

Возвращаемое значение

Promise<AlertAnalysisInstance[]>

getAlerts(string, string, number, string, SearchCriteria, string)

Получение оповещений для репозитория

function getAlerts(project: string, repository: string, top?: number, orderBy?: string, criteria?: SearchCriteria, continuationToken?: string): Promise<PagedList<Alert>>

Параметры

project

string

Идентификатор проекта или имя проекта

repository

string

Имя или идентификатор репозитория

top

number

Максимальное число возвращаемых оповещений

orderBy

string

Должно быть "id" "firstSeen" "lastSeen" "fixedOn" или "severity". По умолчанию используется значение "id"

criteria

SearchCriteria

Параметры для ограничения возвращаемых оповещений

continuationToken

string

Если оповещений больше, чем может быть возвращено, маркер продолжения помещается в заголовок x-ms-continuationtoken. Используйте этот маркер здесь, чтобы получить следующую страницу оповещений.

Возвращаемое значение

Promise<PagedList<Alert>>

getAlertSarif(string, number, string, string, ExpandOption)

Получите оповещение.

function getAlertSarif(project: string, alertId: number, repository: string, ref?: string, expand?: ExpandOption): Promise<string>

Параметры

project

string

Идентификатор проекта или имя проекта

alertId

number

Идентификатор извлекаемого оповещения

repository

string

Имя или идентификатор репозитория, в который входит оповещение

ref

string

expand

ExpandOption

Разверните атрибуты оповещения. Возможные параметры: {ValidationFingerprint, None}

Возвращаемое значение

Promise<string>

getSarif(number)

Получение состояния задания обработки Sarif

function getSarif(sarifId: number): Promise<SarifUploadStatus>

Параметры

sarifId

number

Идентификатор Sarif, возвращенный при отправке Sarif

Возвращаемое значение

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

function getUxFilters(project: string, repository: string, alertType: AlertType): Promise<UxFilters>

Параметры

project

string

Идентификатор проекта или имя проекта

repository

string

alertType

AlertType

Возвращаемое значение

Promise<UxFilters>

updateAlert(AlertStateUpdate, string, number, string)

Обновление состояния оповещения

function updateAlert(stateUpdate: AlertStateUpdate, project: string, alertId: number, repository: string): Promise<Alert>

Параметры

stateUpdate

AlertStateUpdate

Новое состояние оповещения

project

string

Идентификатор проекта или имя проекта

alertId

number

Идентификатор оповещения

repository

string

Имя или идентификатор репозитория

Возвращаемое значение

Promise<Alert>

updateAlertsMetadata(AlertMetadata[], string, string)

Обновление сопоставлений метаданных оповещений.

function updateAlertsMetadata(alertsMetadata: AlertMetadata[], project: string, repository: string): Promise<AlertMetadataChange[]>

Параметры

alertsMetadata

AlertMetadata[]

Список метаданных, которые необходимо связать с оповещениями.

project

string

Идентификатор проекта или имя проекта

repository

string

Имя или идентификатор репозитория.

Возвращаемое значение

Promise<AlertMetadataChange[]>

uploadSarif(string, string, string)

Отправка sarif, содержащего оповещения системы безопасности

function uploadSarif(content: string, project: string, repository: string): Promise<number>

Параметры

content

string

Содержимое для отправки

project

string

Идентификатор проекта или имя проекта

repository

string

Имя или идентификатор репозитория

Возвращаемое значение

Promise<number>