AlertRestClient class

Пакет:

azure-devops-extension-api

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

Extends

RestClientBase

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

AlertRestClient(IVssRestClientOptions)

Методы

createLegalReview(string, string, number, string)	Создание юридического обзора. При этом создается юридическая проверка, связанная с оповещением. Он включает в себя URL-адрес рабочего элемента обзора.
getAlert(string, number, string, string, ExpandOption)	Получите оповещение.
getAlertInstances(string, number, string, string)	Получение экземпляров оповещения в ветви, указанной с @ref. Если @ref не указан, возвращает экземпляры оповещения в ветви по умолчанию (если оповещение существует в ветви по умолчанию) или последнюю затронутую ветвь.
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	Получение оповещений для репозитория
getAlertSarif(string, number, string, string, ExpandOption)	Получите оповещение.
getBranches(string, string, AlertType, string, string, number, boolean)	Возвращает ветви, для которых были отправлены результаты анализа.
getOrgLevelAlertsByIds(number[])	Получайте оповещения по их идентификаторам на уровне организации. Retrun выдает только предупреждения о том, что у пользователя есть разрешение на просмотр. Возвращает оповещения только о включенных планах sku.
getSarif(number)	Получение состояния задания обработки Sarif
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	Получите сведения о сроке действия оповещения.
initiateValidation(string, string, number)	Запуск процесса проверки для заданного оповещения
updateAlert(AlertStateUpdate, string, number, string)	Обновление состояния оповещения
updateAlertsMetadata(AlertMetadata[], string, string)	Обновите связи метаданных оповещений.
uploadOrgSarif(string)	Загрузите файл Шарифа на уровне организации
uploadSarif(string, string, string, String)	Отправка Сарифа, содержащего оповещения системы безопасности

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

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

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

createLegalReview(string, string, number, string)

Создание юридического обзора. При этом создается юридическая проверка, связанная с оповещением. Он включает в себя URL-адрес рабочего элемента обзора.

function createLegalReview(project: string, repository: string, alertId: number, ref?: string): Promise<LegalReview>

Параметры

project

string

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

repository

string

Название или идентификатор репозитория для информационного бюллетеня

alertId

number

Идентификатор предупреждения о безопасности для получения юридической проверки

ref

string

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

Promise<LegalReview>

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

Разверните атрибуты секретного оповещения. Возможные значения: None и ValidationFingerprint. По умолчанию — None. Помните, что если expand задано значение ValidationFingerprint, ответ может содержать секрет в его незашифрованной форме. При использовании этих данных следует соблюдать осторожность.

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

Promise<Alert>

getAlertInstances(string, number, string, string)

Получение экземпляров оповещения в ветви, указанной с @ref. Если @ref не указан, возвращает экземпляры оповещения в ветви по умолчанию (если оповещение существует в ветви по умолчанию) или последнюю затронутую ветвь.

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, AlertListExpandOption, string)

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

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

Параметры

project

string

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

repository

string

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

top

number

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

orderBy

string

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

criteria

SearchCriteria

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

expand

AlertListExpandOption

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

Разверните атрибуты секретного оповещения. Возможные значения: None и ValidationFingerprint. По умолчанию — None. Помните, что если expand задано значение ValidationFingerprint, ответ может содержать секрет в его незашифрованной форме. При использовании этих данных следует соблюдать осторожность.

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

Promise<string>

getBranches(string, string, AlertType, string, string, number, boolean)

Возвращает ветви, для которых были отправлены результаты анализа.

function getBranches(project: string, repository: string, alertType: AlertType, continuationToken?: string, branchNameContains?: string, top?: number, includePullRequestBranches?: boolean): Promise<Branch[]>

Параметры

project

string

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

repository

string

alertType

AlertType

Тип оповещения: проверка зависимостей (1), секрет (2), код QL (3) и т. д.

continuationToken

string

Строковая переменная, представляющая имя ветви и используемая для получения ветвей, которые следуют за ним в алфавитном порядке.

branchNameContains

string

Строковая переменная, используемая для получения ветвей, содержащих эту строку в любом месте имени ветви, не учитывает регистр.

top

number

Переменная int, используемая для возврата ветвей верхнего K, удовлетворяющих критериям поиска.

includePullRequestBranches

boolean

Логическое значение, указывающее, следует ли включать ветви запроса на вытягивание.

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

Promise<Branch[]>

getOrgLevelAlertsByIds(number[])

Получайте оповещения по их идентификаторам на уровне организации. Retrun выдает только предупреждения о том, что у пользователя есть разрешение на просмотр. Возвращает оповещения только о включенных планах sku.

function getOrgLevelAlertsByIds(alertIds: number[]): Promise<Alert[]>

Параметры

alertIds

number[]

Список идентификаторов оповещений для извлечения

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

Promise<Alert[]>

getSarif(number)

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

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

Параметры

sarifId

number

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

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

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType)

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

Параметры

project

string

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

repository

string

alertType

AlertType

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

Promise<UxFilters>

getValidityData(string, string, number)

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

function getValidityData(project: string, repository: string, alertId: number): Promise<ValidationRequestInfo>

Параметры

project

string

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

repository

string

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

alertId

number

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

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

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

Запуск процесса проверки для заданного оповещения

function initiateValidation(project: string, repository: string, alertId: number): Promise<AlertValidationRequestStatus>

Параметры

project

string

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

repository

string

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

alertId

number

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

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

Promise<AlertValidationRequestStatus>

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[]>

uploadOrgSarif(string)

Загрузите файл Шарифа на уровне организации

function uploadOrgSarif(content: string): Promise<number>

Параметры

content

string

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

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

Promise<number>

uploadSarif(string, string, string, String)

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

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

Параметры

content

string

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

project

string

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

repository

string

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

notificationFlag

String

Заголовок для сигнала о том, что это уведомление о ходе выполнения

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

Promise<number>