ReportingRestClient class

包:

azure-devops-extension-api

应使用基类（派生自）向 VSS REST API 发出请求

扩展

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>