AlertRestClient class
應該用來對 VSS REST API 提出要求的基類（衍生自）
- Extends
方法
建構函式詳細資料
AlertRestClient(IVssRestClientOptions)
方法詳細資料
createLegalReview(string, string, number, string)
創建法律審核。 這將創建與警報關聯的法律審核。 它包括評審工作項 URL。
function createLegalReview(project: string, repository: string, alertId: number, ref?: string): Promise<LegalReview>參數
- project
-
string
項目識別碼或項目名稱
- repository
-
string
法律警報的存儲庫的名稱或ID
- alertId
-
number
高級安全警報ID法律警報以獲取法律審查
- 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[]>
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” 或 “severity” 預設值為 “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)
依警報 ID 獲取警報 目前僅支援擷取秘密警報。
function getAlertsByIds(request: AlertBatchRequest, project: string, repository: string): Promise<Alert[]>參數
- request
- AlertBatchRequest
包含警報 ID 及可選警報類型過濾器的請求
- project
-
string
項目識別碼或項目名稱
- repository
-
string
存放庫的名稱或標識碼
傳回
Promise<Alert[]>
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[])
在組織層級依其識別碼取得警示。 只會重新執行使用者有權檢視的警示。 只會傳回已啟用的 SKU 方案警示。
function getOrgLevelAlertsByIds(alertIds: number[]): Promise<Alert[]>參數
- alertIds
-
number[]
要擷取的警示識別碼清單
傳回
Promise<Alert[]>
getSarif(number)
取得 Sarif 處理作業的狀態
function getSarif(sarifId: number): Promise<SarifUploadStatus>參數
- sarifId
-
number
Sarif 標識碼在上傳 Sarif 時傳回
傳回
Promise<SarifUploadStatus>
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>
updateAlertsMetadata(AlertMetadata[], string, string)
更新警示元數據關聯。
function updateAlertsMetadata(alertsMetadata: AlertMetadata[], project: string, repository: string): Promise<AlertMetadataChange[]>參數
- alertsMetadata
要與警示產生關聯的元數據清單。
- project
-
string
項目識別碼或項目名稱
- repository
-
string
存放庫的名稱或標識碼。
傳回
Promise<AlertMetadataChange[]>
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
項目識別碼或項目名稱
- repository
-
string
存放庫的名稱或標識碼
- notificationFlag
-
String
表示這是進度通知的標頭
傳回
Promise<number>