ReportingRestClient class
VSS REST API への要求を行うために使用する (派生する) 基本クラス
- Extends
メソッド
| create |
組織のための新しい高度なフィルターを作成します。 |
| delete |
高度なフィルターを削除します。 |
| get |
IDによって特定の高度なフィルターが付与されます。 |
| get |
組織の重大度別のアラートの概要を取得する |
| get |
組織の結合されたアラートを取得する |
| get |
組織ごとに異なる依存関係コンポーネント名をすべて取得してください(UXフィルタリングに使用) |
| get |
組織の有効化の概要を取得する |
| get |
組織のすべてのプロジェクトとリポジトリを取得してください(UXフィルタリングに使用) |
| get |
組織ごとに異なるコードスキャンルール名をすべて取得してください(UXフィルタリングに使用) |
| get |
組織ごとに異なるシークレットタイプをすべて取得してください(UXフィルタリングに使用) |
| get |
|
| list |
組織の高度なフィルターをすべて利用できます。 |
| update |
高度なフィルターを更新します。 名前だけが更新可能です。 |
コンストラクターの詳細
ReportingRestClient(IVssRestClientOptions)
メソッドの詳細
createAdvancedFilter(AdvancedFilterCreate)
組織のための新しい高度なフィルターを作成します。
function createAdvancedFilter(filter: AdvancedFilterCreate): Promise<AdvancedFilter>
パラメーター
- filter
- AdvancedFilterCreate
高度なフィルターを作成してください。
戻り値
Promise<AdvancedFilter>
deleteAdvancedFilter(string)
高度なフィルターを削除します。
function deleteAdvancedFilter(filterId: string): Promise<void>
パラメーター
- filterId
-
string
削除する高度なフィルターのIDです。
戻り値
Promise<void>
getAdvancedFilter(string)
IDによって特定の高度なフィルターが付与されます。
function getAdvancedFilter(filterId: string): Promise<AdvancedFilter>
パラメーター
- filterId
-
string
取得すべき高度なフィルターのIDです。
戻り値
Promise<AdvancedFilter>
getAlertSummaryForOrg(FilterCriteria)
組織の重大度別のアラートの概要を取得する
function getAlertSummaryForOrg(criteria?: FilterCriteria): Promise<OrgAlertSummary>
パラメーター
- criteria
- FilterCriteria
要約を制限するオプション
戻り値
Promise<OrgAlertSummary>
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)
組織の結合されたアラートを取得する
function getCombinedAlertsForOrg(criteria?: CombinedAlertFilterCriteria, top?: number, continuationToken?: string): Promise<PagedList<DashboardAlert>>
パラメーター
- criteria
- CombinedAlertFilterCriteria
結合アラートをフィルタリングするオプションが返されました
- top
-
number
返されるアラートの最大数
- continuationToken
-
string
返されるよりも多くのアラートがある場合は、継続トークンが "x-ms-continuationtoken" ヘッダーに配置されます。 このトークンを使用して、アラートの次のページを取得します
戻り値
Promise<PagedList<DashboardAlert>>
getDependencyComponentNamesForOrg()
組織ごとに異なる依存関係コンポーネント名をすべて取得してください(UXフィルタリングに使用)
function getDependencyComponentNamesForOrg(): Promise<string[]>
戻り値
Promise<string[]>
getEnablementSummaryForOrg(EnablementFilterCriteria)
組織の有効化の概要を取得する
function getEnablementSummaryForOrg(criteria?: EnablementFilterCriteria): Promise<OrgEnablementSummary>
パラメーター
- criteria
- EnablementFilterCriteria
要約を制限するオプション
戻り値
Promise<OrgEnablementSummary>
getProjectsAndReposForOrg()
組織のすべてのプロジェクトとリポジトリを取得してください(UXフィルタリングに使用)
function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>
戻り値
Promise<ProjectAndRepoInfo[]>
getRuleNamesForOrg(string)
組織ごとに異なるコードスキャンルール名をすべて取得してください(UXフィルタリングに使用)
function getRuleNamesForOrg(toolName?: string): Promise<CodeScanningRuleInfo[]>
パラメーター
- toolName
-
string
ルールをフィルターするためのオプションツール名
戻り値
Promise<CodeScanningRuleInfo[]>
getSecretTypesForOrg()
組織ごとに異なるシークレットタイプをすべて取得してください(UXフィルタリングに使用)
function getSecretTypesForOrg(): Promise<string[]>
戻り値
Promise<string[]>
getUXComputedFilters()
function getUXComputedFilters(): Promise<ReportingUXComputedFilters>
戻り値
Promise<ReportingUXComputedFilters>
listAdvancedFilters(boolean, string)
組織の高度なフィルターをすべて利用できます。
function listAdvancedFilters(includeDeleted?: boolean, keywords?: string): Promise<AdvancedFilter[]>
パラメーター
- includeDeleted
-
boolean
ソフト削除フィルターを含めるかどうか。
- keywords
-
string
名前でフィルターを検索するオプションフィルター(大文字無差別、部分一致)。
戻り値
Promise<AdvancedFilter[]>
updateAdvancedFilter(AdvancedFilterUpdate, string)
高度なフィルターを更新します。 名前だけが更新可能です。
function updateAdvancedFilter(filter: AdvancedFilterUpdate, filterId: string): Promise<void>
パラメーター
- filter
- AdvancedFilterUpdate
新しい名前を含む更新データ。
- filterId
-
string
更新する高度なフィルターのIDです。
戻り値
Promise<void>