AlertRestClient class
Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS
- Extends
Конструкторы
| Alert |
Методы
| autofix |
Получает обратный вызов от конвейера автофикса с результатом запуска. Идемпотентный: повторные вызовы запроса, уже находящегося в терминальном состоянии, возвращает 200 без изменений. |
| create |
Создайте запрос на автофикс для указанного оповещения. |
| create |
Создание юридического обзора. При этом создается юридическая проверка, связанная с оповещением. Он включает в себя URL-адрес рабочего элемента обзора. |
| delete |
Обратимое удаление данных анализа для всех конвейеров в репозитории, очистка связанных оповещений Advanced Security. |
| delete |
Обратимое удаление данных анализа для определенного конвейера, очистка связанных оповещений Расширенной безопасности. |
| export |
Экспорт оповещений в виде одного файла SARIF |
| get |
Получите оповещение. |
| get |
Получение экземпляров оповещения в ветви, указанной с @ref. Если @ref не указан, возвращает экземпляры оповещения в ветви по умолчанию (если оповещение существует в ветви по умолчанию) или последнюю затронутую ветвь. |
| get |
Получите метаданные предупреждения. |
| get |
Получайте метаданные уведомлений. |
| get |
Получение оповещений для репозитория |
| get |
Получите оповещение. |
| get |
Получение оповещений по идентификаторам оповещений в настоящее время поддерживает только получение секретных оповещений. |
| get |
Получите все запросы на автофикс для указанного оповещения. |
| get |
Возвращает ветви, для которых были отправлены результаты анализа. |
| get |
Получайте оповещения по их идентификаторам на уровне организации. Retrun выдает только предупреждения о том, что у пользователя есть разрешение на просмотр. Возвращает оповещения только о включенных планах sku. |
| get |
Получение состояния задания обработки Sarif |
| get |
|
| get |
|
| get |
Получите сведения о сроке действия оповещения. |
| initiate |
Запуск процесса проверки для заданного оповещения |
| update |
Обновление состояния оповещения |
| update |
Сообщает оповещение о пакетном обновлении. Только внутреннее использование — используется сканерами доказательств для перевода оповещений о черновиках, созданных ИИ, в «Активно» или «Отклонено». Оповещения, помеченные как Draft (неопределённый), остаются без изменений. |
| update |
Обновите связи метаданных оповещений. |
| upload |
Загрузите файл Шарифа на уровне организации |
| upload |
Отправка Сарифа, содержащего оповещения системы безопасности |
| upload |
Загрузите SARIF в GitHub Code Scanning через приложение GitOps. |
Сведения о конструкторе
AlertRestClient(IVssRestClientOptions)
Сведения о методе
autofixCallback(AutofixCallbackRequest, string, string, number)
Получает обратный вызов от конвейера автофикса с результатом запуска. Идемпотентный: повторные вызовы запроса, уже находящегося в терминальном состоянии, возвращает 200 без изменений.
function autofixCallback(callbackRequest: AutofixCallbackRequest, project: string, repository: string, alertId: number): Promise<void>Параметры
- callbackRequest
- AutofixCallbackRequest
Payload для обратного вызова, содержащий requestId, статус и опциональный pullRequestId.
- project
-
string
Идентификатор проекта или имя проекта
- repository
-
string
Имя или идентификатор репозитория.
- alertId
-
number
ID оповещения для создания автофикса.
Возвращаемое значение
Promise<void>
createAutofixRequest(string, number, string, string)
Создайте запрос на автофикс для указанного оповещения.
function createAutofixRequest(project: string, alertId: number, repository: string, ref?: string): Promise<AutofixRequest>Параметры
- project
-
string
Идентификатор проекта или имя проекта
- alertId
-
number
ID оповещения для создания автофикса.
- repository
-
string
Имя или идентификатор репозитория.
- ref
-
string
Опциональный Git ref (например, refs/heads/feature/x) должен быть нацелен автофикс. Если отсутствует, используется стандартная ветка репозитория.
Возвращаемое значение
Promise<AutofixRequest>
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>
deleteAllPipelineAnalyses(string, string)
Обратимое удаление данных анализа для всех конвейеров в репозитории, очистка связанных оповещений Advanced Security.
function deleteAllPipelineAnalyses(project: string, repository: string): Promise<void>Параметры
- project
-
string
Идентификатор проекта или имя проекта
- repository
-
string
Имя или идентификатор репозитория.
Возвращаемое значение
Promise<void>
deletePipelineAnalysis(string, string, number)
Обратимое удаление данных анализа для определенного конвейера, очистка связанных оповещений Расширенной безопасности.
function deletePipelineAnalysis(project: string, repository: string, adoPipelineId: number): Promise<void>Параметры
- project
-
string
Идентификатор проекта или имя проекта
- repository
-
string
Имя или идентификатор репозитория.
- adoPipelineId
-
number
Идентификатор конвейера ADO, данные анализа которого должны быть удалены.
Возвращаемое значение
Promise<void>
exportSarif(string, string, number[], string)
Экспорт оповещений в виде одного файла SARIF
function exportSarif(project: string, repository: string, alertIds: number[], branchName?: string): Promise<any>Параметры
- project
-
string
Идентификатор проекта или имя проекта
- repository
-
string
Имя или идентификатор репозитория
- alertIds
-
number[]
Список идентификаторов оповещений для экспорта
- branchName
-
string
Название филиала целевого предупреждения. Если не указано, будет использоваться стандартная ветка.
Возвращаемое значение
Promise<any>
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[]>
getAlertMetadata(string, number, string)
Получите метаданные предупреждения.
function getAlertMetadata(project: string, alertId: number, repository: string): Promise<AlertMetadata>Параметры
- project
-
string
Идентификатор проекта или имя проекта
- alertId
-
number
Идентификатор генерации оповещений для получения
- repository
-
string
Имя или идентификатор репозитория, который оповещение является частью
Возвращаемое значение
Promise<AlertMetadata>
getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)
Получайте метаданные уведомлений.
function getAlertMetadataBatch(alertMetadataBatchRequest: AlertMetadataBatchRequest, project: string, repository: string): Promise<AlertMetadata[]>Параметры
- alertMetadataBatchRequest
- AlertMetadataBatchRequest
- project
-
string
Идентификатор проекта или имя проекта
- repository
-
string
Имя или идентификатор репозитория, который оповещение является частью
Возвращаемое значение
Promise<AlertMetadata[]>
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. Используйте этот маркер здесь, чтобы получить следующую страницу оповещений
Возвращаемое значение
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>
getAlertsByIds(AlertBatchRequest, string, string, boolean)
Получение оповещений по идентификаторам оповещений в настоящее время поддерживает только получение секретных оповещений.
function getAlertsByIds(request: AlertBatchRequest, project: string, repository: string, includeSensitiveInformation?: boolean): Promise<Alert[]>Параметры
- request
- AlertBatchRequest
Запрос, содержащий идентификаторы оповещений и опциональный фильтр типа оповещений
- project
-
string
Идентификатор проекта или имя проекта
- repository
-
string
Имя или идентификатор репозитория
- includeSensitiveInformation
-
boolean
Применяется только к секретным оповещениям. Если ложно (по умолчанию), 'ValidationFingerprintJson' отпечатков валидации каждого секретного оповещения опускается в ответе. Установлен на true, чтобы включить его; Имейте в виду, что валидационный отпечаток может содержать незашифрованный секрет и другие конфиденциальные данные, поэтому будьте осторожны при их запросе.
Возвращаемое значение
Promise<Alert[]>
getAutofixRequestsByAlertId(string, number, string, string)
Получите все запросы на автофикс для указанного оповещения.
function getAutofixRequestsByAlertId(project: string, alertId: number, repository: string, ref?: string): Promise<AutofixRequest[]>Параметры
- project
-
string
Идентификатор проекта или имя проекта
- alertId
-
number
Идентификатор оповещения.
- repository
-
string
Имя или идентификатор репозитория.
- ref
-
string
Опциональный Git ref (например, refs/heads/feature/x) должен быть нацелен автофикс. Если отсутствует, используется стандартная ветка репозитория.
Возвращаемое значение
Promise<AutofixRequest[]>
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>
getSarifContent(number)
function getSarifContent(submissionId: number): Promise<any>Параметры
- submissionId
-
number
Возвращаемое значение
Promise<any>
getUxFilters(string, string, AlertType)
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>
updateAlertsBatch(AlertBatchStateUpdateRequest, string, string)
Сообщает оповещение о пакетном обновлении. Только внутреннее использование — используется сканерами доказательств для перевода оповещений о черновиках, созданных ИИ, в «Активно» или «Отклонено». Оповещения, помеченные как Draft (неопределённый), остаются без изменений.
function updateAlertsBatch(request: AlertBatchStateUpdateRequest, project: string, repository: string): Promise<Alert[]>Параметры
- request
- AlertBatchStateUpdateRequest
Запрос, содержащий обновления состояния оповещений
- project
-
string
Идентификатор проекта или имя проекта
- repository
-
string
Имя или идентификатор репозитория
Возвращаемое значение
Promise<Alert[]>
updateAlertsMetadata(AlertMetadata[], string, string)
Обновите связи метаданных оповещений.
function updateAlertsMetadata(alertsMetadata: AlertMetadata[], project: string, repository: string): Promise<AlertMetadataChange[]>Параметры
- alertsMetadata
Список метаданных для связывания с оповещениями.
- 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>
uploadSarifToGitHub(string, string, string, string, string)
Загрузите SARIF в GitHub Code Scanning через приложение GitOps.
function uploadSarifToGitHub(content: string, project: string, hostname: string, owner: string, repo: string): Promise<string>Параметры
- content
-
string
Содержимое для отправки
- project
-
string
Идентификатор проекта или имя проекта
- hostname
-
string
Имя хоста GitHub (например, github.com или microsoft.ghe.com)
- owner
-
string
Владелец репозитория GitHub (организация или пользователь)
- repo
-
string
Имя репозитория GitHub
Возвращаемое значение
Promise<string>