AlertRestClient class
VSS REST API への要求を行うために (から派生) 使用する必要がある基底クラス
- Extends
コンストラクター
| Alert |
メソッド
| get |
アラートを取得します。 |
| get |
アラートのインスタンスを取得します。 |
| get |
リポジトリのアラートを取得する |
| get |
アラートを取得します。 |
| get |
Sarif 処理ジョブの状態を取得する |
| get |
|
| update |
アラートの状態を更新する |
| update |
アラート メタデータの関連付けを更新します。 |
| upload |
セキュリティ アラートを含む Sarif をアップロードする |
コンストラクターの詳細
AlertRestClient(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" ヘッダーに配置されます。 このトークンを使用して、アラートの次のページを取得します
戻り値
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
アラートに関連付けるメタデータの一覧。
- 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>