AlertRestClient class

new AlertRestClient(options: IVssRestClientOptions)

參數

為指定的警報建立自動修正請求。

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

參數

傳回

創建法律審核。 這將創建與警報關聯的法律審核。 它包括評審工作項 URL。

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

參數

傳回

軟體刪除儲存庫中所有管線的分析資料，清理相關的進階安全警示。

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

參數

傳回

軟刪除特定管線的分析資料，清理相關的進階安全警示。

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

參數

傳回

將警報匯出為單一 SARIF 檔案

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

參數

傳回

取得警示。

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

參數

傳回

使用 @ref指定之分支上取得警示的實例。如果未提供 @ref，則傳回預設分支上警示的實例（如果警示存在於預設分支中），或最新受影響的分支。

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

參數

傳回

取得警示元資料。

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

參數

傳回

取得警報和元資料。

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

參數

傳回

取得存放庫的警示

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

參數

傳回

取得警示。

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

參數

傳回

依警報 ID 獲取警報 目前僅支援擷取秘密警報。

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

參數

傳回

傳回提交分析結果的分支。

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

參數

傳回

在組織層級依其識別碼取得警示。 只會重新執行使用者有權檢視的警示。 只會傳回已啟用的 SKU 方案警示。

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

參數

傳回

取得 Sarif 處理作業的狀態

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

參數

傳回

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

參數

傳回

獲取警報的有效性詳細資訊。

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

參數

傳回

起始指定警示的驗證程式

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

參數

傳回

更新警示的狀態

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

參數

傳回

更新警示元數據關聯。

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

參數

傳回

在組織層級上傳 Sarif 檔案

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

參數

傳回

上傳包含安全性警示的 Sarif

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

參數

傳回

透過 GitOps 應用程式將 SARIF 程式碼掃描上傳到 GitHub。

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

參數

傳回