AlertRestClient class
應該用來對 VSS REST API 提出要求的基類（衍生自）
- Extends
建構函式
| Alert |
方法
建構函式詳細資料
AlertRestClient(IVssRestClientOptions)
方法詳細資料
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
展開警示屬性。 可能的選項為 {ValidationFingerprint， None}
傳回
Promise<Alert>
getAlertInstances(string, number, string, string)
取得警示的實例。
function getAlertInstances(project: string, alertId: number, repository: string, ref?: string): Promise<AlertAnalysisInstance[]>參數
- project
-
string
項目識別碼或項目名稱
- alertId
-
number
要擷取的警示標識碼
- repository
-
string
警示所屬存放庫的名稱或標識碼
- 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
項目識別碼或項目名稱
- repository
-
string
存放庫的名稱或標識碼
- top
-
number
要傳回的警示數目上限
- orderBy
-
string
必須是 “id” “firstSeen” “lastSeen” “fixedOn” 或 “severity” 預設值為 “id”
- criteria
- SearchCriteria
限制傳回警示的選項
- 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
展開警示屬性。 可能的選項為 {ValidationFingerprint， None}
傳回
Promise<string>
getSarif(number)
取得 Sarif 處理作業的狀態
function getSarif(sarifId: number): Promise<SarifUploadStatus>參數
- sarifId
-
number
Sarif 標識碼在上傳 Sarif 時傳回
傳回
Promise<SarifUploadStatus>
getUxFilters(string, string, AlertType)
function getUxFilters(project: string, repository: string, alertType: AlertType): Promise<UxFilters>參數
- project
-
string
項目識別碼或項目名稱
- 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
項目識別碼或項目名稱
- 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[]>
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>