通过

AlertRestClient class

  • 参考
包:
azure-devops-extension-api

应使用 (派生自) 的基类向 VSS REST API 发出请求

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

项目 ID 或项目名称

alertId

number

要检索的警报的 ID

repository

string

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

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

项目 ID 或项目名称

alertId

number

要检索的警报的 ID

repository

string

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

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

项目 ID 或项目名称

repository

string

存储库的名称或 ID

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

项目 ID 或项目名称

alertId

number

要检索的警报的 ID

repository

string

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

ref

string

expand
ExpandOption

展开警报属性。 可能的选项为 {ValidationFingerprint， None}

返回

Promise<string>

getSarif(number)

获取 Sarif 处理作业的状态

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

参数

sarifId

number

上传 Sarif 时返回的 Sarif ID

返回

Promise<SarifUploadStatus>

getUxFilters(string, string, AlertType) 

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

参数

project

string

项目 ID 或项目名称

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

项目 ID 或项目名称

alertId

number

警报的 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[]>

uploadSarif(string, string, string)

上传包含安全警报的 Sarif

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

参数

content

string

要上传的内容

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

返回

Promise<number>