AlertRestClient class

程序包:

azure-devops-extension-api

应使用基类（派生自）向 VSS REST API 发出请求

扩展

RestClientBase

构造函数

AlertRestClient(IVssRestClientOptions)

方法

autofixCallback(AutofixCallbackRequest, string, string)	自动修复流水线会收到回调，告知运行结果。 等值：对已处于终端状态的请求重复调用，返回200且未做任何变化。
createAutofixRequest(string, number, string, string)	为指定的警报创建一个自动修正请求。
createJob(any, string, string)	创建一个警报任务。
createLegalReview(string, string, number, string)	创建法律审核。 这将创建与警报关联的法律审核。 它包括评审工作项 URL。
deleteAllPipelineAnalyses(string, string)	软删除存储库中所有管道的分析数据，清理关联的高级安全警报。
deletePipelineAnalysis(string, string, number)	软删除特定管道的分析数据，清理关联的高级安全警报。
exportSarif(string, string, number[], string)	将警报导出为单一的SARIF文件
getAiMetadataContent(string, number, string)	下载完整的AI元数据块，获取AI代码警报。
getAlert(string, number, string, string, ExpandOption)	获取警报。
getAlertInstances(string, number, string, string)	获取使用 @ref指定的分支上的警报实例。如果未提供 @ref，则返回默认分支（如果默认分支中存在警报）或最新受影响的分支上的警报实例。
getAlertMetadata(string, number, string)	获取警报元数据。
getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)	获取警报元数据。
getAlerts(string, string, number, string, SearchCriteria, AlertListExpandOption, string)	获取存储库的警报
getAlertSarif(string, number, string, string, ExpandOption)	获取警报。
getAlertsByIds(AlertBatchRequest, string, string, boolean)	通过警报 ID 获取警报当前仅支持提取机密警报。
getAutofixRequestsByAlertId(string, number, string, string)	获取所有指定警报的自动修正请求。
getBranches(string, string, AlertType, string, string, number, boolean)	返回提交分析结果的分支。
getDraftAlerts(string, string, number, string, string, number, string)	获取仓库的草稿提醒。
getJob(string, string, string)	通过ID获取一个警报职位。
getJobsForAlert(string, string, number, number, string)	获取与警报相关的警报任务。
getOrgLevelAlertsByIds(number[])	在组织级别按其 ID 获取警报。 仅重新运行用户有权查看的警报。 仅返回已启用的 SKU 计划的警报。
getSarif(number)	获取 Sarif 处理作业的状态
getSarifContent(number)
getUxFilters(string, string, AlertType)
getValidityData(string, string, number)	获取警报的有效性详细信息。
initiateValidation(string, string, number)	启动给定警报的验证过程
queryAlerts(AlertMetadataQueryCriteria, string, string, number, string, AlertListExpandOption, string)	通过元数据类型链接查询存储库的警报。
submitTriageSignals(TriageSignalSubmissionRequest, string, string)	Durably 接受一批与提供者中立的分诊评估。
updateAlert(AlertStateUpdate, string, number, string)	更新警报的状态
updateAlertsBatch(AlertBatchStateUpdateRequest, string, string)	批量更新警报状态。
updateAlertsMetadata(AlertMetadata[], string, string)	更新警报元数据关联。
updateJob(any, string, string, string)	更新警报任务。
uploadOrgSarif(string)	在组织级别上传 Sarif 文件
uploadSarif(string, string, string, String)	上传包含安全警报的 Sarif
uploadSarifToGitHub(string, string, string, string, string)	通过 GitOps 应用上传 SARIF 到 GitHub 代码扫描。

构造函数详细信息

AlertRestClient(IVssRestClientOptions)

new AlertRestClient(options: IVssRestClientOptions)

参数

options

IVssRestClientOptions

方法详细信息

autofixCallback(AutofixCallbackRequest, string, string)

自动修复流水线会收到回调，告知运行结果。 等值：对已处于终端状态的请求重复调用，返回200且未做任何变化。

function autofixCallback(callbackRequest: AutofixCallbackRequest, project: string, repository: string): Promise<void>

参数

callbackRequest

AutofixCallbackRequest

回调有效载荷包含requestId、status和可选的pullRequestId。

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID。

返回

Promise<void>

createAutofixRequest(string, number, string, string)

为指定的警报创建一个自动修正请求。

function createAutofixRequest(project: string, alertId: number, repository: string, ref: string): Promise<AutofixRequest>

参数

project

string

项目 ID 或项目名称

alertId

number

提醒的ID，用于创建自动修复。

repository

string

存储库的名称或 ID。

ref

string

自动修正应该针对的 Git 参考（例如 refs/heads/feature/x）。

返回

Promise<AutofixRequest>

createJob(any, string, string)

创建一个警报任务。

function createJob(body: any, project: string, repository: string): Promise<AlertJob>

参数

body

any

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

返回

Promise<AlertJob>

createLegalReview(string, string, number, string)

创建法律审核。 这将创建与警报关联的法律审核。 它包括评审工作项 URL。

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

参数

project

string

项目 ID 或项目名称

repository

string

法律警报的存储库的名称或 ID

alertId

number

高级安全警报 ID 法律警报以获取法律审查

ref

string

返回

Promise<LegalReview>

deleteAllPipelineAnalyses(string, string)

软删除存储库中所有管道的分析数据，清理关联的高级安全警报。

function deleteAllPipelineAnalyses(project: string, repository: string): Promise<void>

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID。

返回

Promise<void>

deletePipelineAnalysis(string, string, number)

软删除特定管道的分析数据，清理关联的高级安全警报。

function deletePipelineAnalysis(project: string, repository: string, adoPipelineId: number): Promise<void>

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID。

adoPipelineId

number

应清理其分析数据的 ADO 管道的 ID。

返回

Promise<void>

exportSarif(string, string, number[], string)

将警报导出为单一的SARIF文件

function exportSarif(project: string, repository: string, alertIds: number[], branchName?: string): Promise<any>

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

alertIds

number[]

可导出的警报ID列表

branchName

string

目标的分支名称会发出警报。 如果未指定，则使用默认分支。

返回

Promise<any>

getAiMetadataContent(string, number, string)

下载完整的AI元数据块，获取AI代码警报。

function getAiMetadataContent(project: string, alertId: number, repository: string): Promise<any>

参数

project

string

项目 ID 或项目名称

alertId

number

应该下载其AI元数据块的警报ID。

repository

string

提醒所属仓库的名称或ID。

返回

Promise<any>

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

获取警报。

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

参数

project

string

项目 ID 或项目名称

alertId

number

要检索的警报的 ID

repository

string

警报所属存储库的名称或 ID

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

项目 ID 或项目名称

alertId

number

要检索的警报的 ID

repository

string

警报所属存储库的名称或 ID

ref

string

返回

Promise<AlertAnalysisInstance[]>

getAlertMetadata(string, number, string)

获取警报元数据。

function getAlertMetadata(project: string, alertId: number, repository: string): Promise<AlertMetadata>

参数

project

string

项目 ID 或项目名称

alertId

number

要检索的警报的 ID

repository

string

警报所属存储库的名称或 ID

返回

Promise<AlertMetadata>

getAlertMetadataBatch(AlertMetadataBatchRequest, string, string)

获取警报元数据。

function getAlertMetadataBatch(alertMetadataBatchRequest: AlertMetadataBatchRequest, project: string, repository: string): Promise<AlertMetadata[]>

参数

alertMetadataBatchRequest

AlertMetadataBatchRequest

project

string

项目 ID 或项目名称

repository

string

警报所属存储库的名称或 ID

返回

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

项目 ID 或项目名称

repository

string

存储库的名称或 ID

top

number

要返回的最大警报数

orderBy

string

必须是“id” “firstSeen” “lastSeen” “fixedOn” 或 “severity” 默认值为“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

项目 ID 或项目名称

alertId

number

要检索的警报的 ID

repository

string

警报所属存储库的名称或 ID

ref

string

expand

ExpandOption

展开机密警报的属性。 可能的值为 None 和 ValidationFingerprint。 默认为 None。 请注意，如果 expand 设置为 ValidationFingerprint，响应可能包含其未加密形式的机密。 使用此数据时，请谨慎行事。

返回

Promise<string>

getAlertsByIds(AlertBatchRequest, string, string, boolean)

通过警报 ID 获取警报当前仅支持提取机密警报。

function getAlertsByIds(request: AlertBatchRequest, project: string, repository: string, includeSensitiveInformation?: boolean): Promise<Alert[]>

参数

request

AlertBatchRequest

包含警报ID和可选警报类型过滤器的请求

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

includeSensitiveInformation

boolean

仅适用于秘密警报。 当为 false（默认值）时，响应中省略每个秘密警报验证指纹的“ValidationFingerprintJson”。 设置为真以包含它;请注意，验证指纹JSON可能包含未加密的秘密及其他敏感数据，申请时请谨慎。

返回

Promise<Alert[]>

getAutofixRequestsByAlertId(string, number, string, string)

获取所有指定警报的自动修正请求。

function getAutofixRequestsByAlertId(project: string, alertId: number, repository: string, ref: string): Promise<AutofixRequest[]>

参数

project

string

项目 ID 或项目名称

alertId

number

警报的 ID。

repository

string

存储库的名称或 ID。

ref

string

自动修正应该针对的 Git 参考（例如 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

项目 ID 或项目名称

repository

string

alertType

AlertType

警报类型：依赖项扫描（1）、机密（2）、代码 QL（3）等。

continuationToken

string

表示分支名称的字符串变量，用于提取按字母顺序排列的分支。

branchNameContains

string

一个字符串变量，用于提取分支名称中的任何位置包含此字符串的分支，不区分大小写。

top

number

用于返回满足搜索条件的前 k 分支的 int 变量。

includePullRequestBranches

boolean

一个布尔变量，指示是否包含拉取请求分支。

返回

Promise<Branch[]>

getDraftAlerts(string, string, number, string, string, number, string)

获取仓库的草稿提醒。

function getDraftAlerts(project: string, repository: string, top?: number, orderBy?: string, continuationToken?: string, sarifSubmissionId?: number, triageState?: string): Promise<PagedList<Alert>>

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

top

number

要返回的最大警报数

orderBy

string

必须是“id”、“firstseeen”、“lastSeen”、“fixedOn”或“severity”。 默认为“id”。 当提供triageState时，仅支持“id”。

continuationToken

string

如果警报多于可以返回，则延续标记将放置在“x-ms-continuationtoken”标头中。 在此处使用该令牌获取下一页警报

sarifSubmissionId

number

如提供，仅返回本SARIF提交所代表的AI代码草案警报

triageState

string

如果提供了，仅返回以该分流状态的 Draft AI Code alert-branch 实例

返回

Promise<PagedList<Alert>>

getJob(string, string, string)

通过ID获取一个警报职位。

function getJob(project: string, repository: string, jobId: string): Promise<AlertJob>

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

jobId

string

提供者分配的作业标识符

返回

Promise<AlertJob>

getJobsForAlert(string, string, number, number, string)

获取与警报相关的警报任务。

function getJobsForAlert(project: string, repository: string, alertId: number, top?: number, continuationToken?: string): Promise<PagedList<AlertJob>>

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

alertId

number

警报的 ID

top

number

最大返还作业数

continuationToken

string

如果作业数量超过可返回的数量，则在“x-ms-continuationtoken”头部放置延续令牌。 用这个令牌获取下一页的职位

返回

Promise<PagedList<AlertJob>>

getOrgLevelAlertsByIds(number[])

在组织级别按其 ID 获取警报。 仅重新运行用户有权查看的警报。 仅返回已启用的 SKU 计划的警报。

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

参数

alertIds

number[]

要检索的警报 ID 列表

返回

Promise<Alert[]>

getSarif(number)

获取 Sarif 处理作业的状态

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

参数

sarifId

number

在上传 Sarif 时返回 Sarif ID

返回

Promise<SarifUploadStatus>

getSarifContent(number)

function getSarifContent(submissionId: number): Promise<any>

参数

submissionId

number

返回

Promise<any>

getUxFilters(string, string, AlertType)

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

参数

project

string

项目 ID 或项目名称

repository

string

alertType

AlertType

返回

Promise<UxFilters>

getValidityData(string, string, number)

获取警报的有效性详细信息。

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

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

alertId

number

警报的 ID

返回

Promise<ValidationRequestInfo>

initiateValidation(string, string, number)

启动给定警报的验证过程

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

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

alertId

number

警报的 ID

返回

Promise<AlertValidationRequestStatus>

queryAlerts(AlertMetadataQueryCriteria, string, string, number, string, AlertListExpandOption, string)

通过元数据类型链接查询存储库的警报。

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

参数

criteria

AlertMetadataQueryCriteria

元数据类型过滤器以限制返回的警报数量

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

top

number

要返回的最大警报数

orderBy

string

必须是“id” “firstSeen” “lastSeen” “fixedOn” 或 “severity” 默认值为“id”

expand

AlertListExpandOption

用于扩展响应的选项，例如返回警报计数而不是警报

continuationToken

string

如果警报多于可以返回，则延续标记将放置在“x-ms-continuationtoken”标头中。 在此处使用该令牌获取下一页警报

返回

Promise<PagedList<Alert>>

submitTriageSignals(TriageSignalSubmissionRequest, string, string)

Durably 接受一批与提供者中立的分诊评估。

function submitTriageSignals(submission: TriageSignalSubmissionRequest, project: string, repository: string): Promise<TriageSignalSubmissionResponse>

参数

submission

TriageSignalSubmissionRequest

分诊信号提交入院。

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID。

返回

Promise<TriageSignalSubmissionResponse>

updateAlert(AlertStateUpdate, string, number, string)

更新警报的状态

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

参数

stateUpdate

AlertStateUpdate

警报的新状态

project

string

项目 ID 或项目名称

alertId

number

警报的 ID

repository

string

存储库的名称或 ID

返回

Promise<Alert>

updateAlertsBatch(AlertBatchStateUpdateRequest, string, string)

批量更新警报状态。

function updateAlertsBatch(request: AlertBatchStateUpdateRequest, project: string, repository: string): Promise<Alert[]>

参数

request

AlertBatchStateUpdateRequest

包含警报状态更新的请求

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

返回

Promise<Alert[]>

updateAlertsMetadata(AlertMetadata[], string, string)

更新警报元数据关联。

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

参数

alertsMetadata

AlertMetadata[]

要与警报关联的元数据列表。

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID。

返回

Promise<AlertMetadataChange[]>

updateJob(any, string, string, string)

更新警报任务。

function updateJob(patch: any, project: string, repository: string, jobId: string): Promise<AlertJob>

参数

patch

any

描述要更新字段的补丁

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

jobId

string

提供者分配的作业标识符

返回

Promise<AlertJob>

uploadOrgSarif(string)

在组织级别上传 Sarif 文件

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

参数

content

string

要上传的内容

返回

Promise<number>

uploadSarif(string, string, string, String)

上传包含安全警报的 Sarif

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

参数

content

string

要上传的内容

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

notificationFlag

String

指示这是进度通知的标头

返回

Promise<number>

uploadSarifToGitHub(string, string, string, string, string)

通过 GitOps 应用上传 SARIF 到 GitHub 代码扫描。

function uploadSarifToGitHub(content: string, project: string, hostname: string, owner: string, repo: string): Promise<string>

参数

content

string

要上传的内容

project

string

项目 ID 或项目名称

hostname

string

GitHub主机名（例如 github.com 或 microsoft.ghe.com）

owner

string

GitHub仓库所有者（组织或用户）

repo

string

GitHub仓库名称

返回

Promise<string>