ReportingRestClient class

套件:

azure-devops-extension-api

應該用來對 VSS REST API 提出要求的基類（衍生自）

Extends

RestClientBase

建構函式

ReportingRestClient(IVssRestClientOptions)

方法

createAdvancedFilter(AdvancedFilterCreate)	為組織建立新的進階篩選器。
deleteAdvancedFilter(string)	刪除進階篩選器。
getAdvancedFilter(string)	透過 ID 獲得特定的進階篩選器。
getAlertSummaryForOrg(FilterCriteria)	依組織的嚴重性取得警示摘要
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	為組織取得綜合警報
getDependencyComponentNamesForOrg()	取得組織所有不同的相依元件名稱（用於使用者體驗過濾）
getEnablementSummaryForOrg(EnablementFilterCriteria)	取得組織的賦能摘要
getProjectsAndReposForOrg()	取得該組織的所有專案和倉庫（用於使用者體驗過濾）
getRuleNamesForOrg(string)	取得組織所有不同的程式碼掃描規則名稱（用於使用者體驗過濾）
getSecretTypesForOrg()	取得組織所有不同的秘密類型（用於使用者體驗過濾）
getUXComputedFilters()
listAdvancedFilters(boolean, string)	能取得組織所有進階篩選功能。
updateAdvancedFilter(AdvancedFilterUpdate, string)	更新進階篩選器。 只有名稱可以更新。

建構函式詳細資料

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

參數

options

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()

取得組織所有不同的相依元件名稱（用於使用者體驗過濾）

function getDependencyComponentNamesForOrg(): Promise<string[]>

傳回

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

取得組織的賦能摘要

function getEnablementSummaryForOrg(criteria?: EnablementFilterCriteria): Promise<OrgEnablementSummary>

參數

criteria

EnablementFilterCriteria

限制回傳摘要的選項

傳回

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

取得該組織的所有專案和倉庫（用於使用者體驗過濾）

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

傳回

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

取得組織所有不同的程式碼掃描規則名稱（用於使用者體驗過濾）

function getRuleNamesForOrg(toolName?: string): Promise<CodeScanningRuleInfo[]>

參數

toolName

string

可選的工具名稱可依規則篩選

傳回

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

取得組織所有不同的秘密類型（用於使用者體驗過濾）

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>