ManagementRestClient class

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

扩展

构造函数

ManagementRestClient(IVssRestClientOptions)

方法

createBillingSnapshot2(MeterUsageForPlan, Plan)

在主要缩放单元(EUS21)的多组织计费计算期间,此 API 用于为特定组织创建计费快照。主要缩放单元将针对不同 scsle 单位中的每个组织调用此 API,以创建计费快照。 数据将存储在组织特定的分区 DB 中 -> 计费快照表。 这是必需的,因为客户将从其组织特定的分区数据库中提取计费数据。

getBillableCommitterDetails2(Plan, Date)

获取所有计费提交者的详细信息,包括与 VSID 不匹配的提交者的详细信息。

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

如果为此存储库启用了高级安全性,则估计将添加到客户的使用情况的推送器。

getEstimatedBillablePushersDetailsForOrg2(Plan)

如果为此组织启用了高级安全性,则估计将添加到客户的使用情况的推送器。

getEstimatedBillablePushersDetailsForProject2(string, Plan)

如果为此项目启用了高级安全性,则估计将添加到客户的使用情况的推送器。

getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)

获取计算计费信息时使用的提交器。

getOrgEnablementStatus2(boolean)

获取组织的高级安全性的当前状态

getProjectEnablementStatus2(string, boolean)

获取项目的“高级安全性”的当前状态

getRepoEnablementStatus2(string, string, boolean)

确定是否为存储库启用了代码安全、机密保护及其功能。

updateOrgEnablementStatus2(OrgEnablementSettings)

更新组织高级安全性的状态

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

更新项目的高级安全性状态

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

更新代码安全和机密保护的启用状态以及给定存储库的相应功能。

构造函数详细信息

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

参数

方法详细信息

createBillingSnapshot2(MeterUsageForPlan, Plan)

在主要缩放单元(EUS21)的多组织计费计算期间,此 API 用于为特定组织创建计费快照。主要缩放单元将针对不同 scsle 单位中的每个组织调用此 API,以创建计费快照。 数据将存储在组织特定的分区 DB 中 -> 计费快照表。 这是必需的,因为客户将从其组织特定的分区数据库中提取计费数据。

function createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>

参数

meterUsage
MeterUsageForPlan
plan
Plan

返回

Promise<void>

getBillableCommitterDetails2(Plan, Date)

获取所有计费提交者的详细信息,包括与 VSID 不匹配的提交者的详细信息。

function getBillableCommitterDetails2(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>

参数

plan
Plan

要查询的计划。 支持的计划:CodeSecurity 和 SecretProtection。 这是强制参数。

billingDate

Date

查询日期(如果未提供)今天

返回

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

如果为此存储库启用了高级安全性,则估计将添加到客户的使用情况的推送器。

function getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

plan
Plan

要查询的计划。

返回

getEstimatedBillablePushersDetailsForOrg2(Plan)

如果为此组织启用了高级安全性,则估计将添加到客户的使用情况的推送器。

function getEstimatedBillablePushersDetailsForOrg2(plan?: Plan): Promise<MeterUsageEstimate>

参数

plan
Plan

要查询的计划。

返回

getEstimatedBillablePushersDetailsForProject2(string, Plan)

如果为此项目启用了高级安全性,则估计将添加到客户的使用情况的推送器。

function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>

参数

project

string

项目 ID 或项目名称

plan
Plan

返回

getLastMeterUsage2(Plan)

function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>

参数

plan
Plan

返回

getMeterUsage2(Plan, Date)

获取计算计费信息时使用的提交器。

function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>

参数

plan
Plan

要查询的计划。 支持的计划:CodeSecurity 和 SecretProtection。 这是强制参数。

billingDate

Date

查询日期(如果未提供)今天

返回

getOrgEnablementStatus2(boolean)

获取组织的高级安全性的当前状态

function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>

参数

includeAllProperties

boolean

如果为 true,还确定推送是否被阻止(如果它们包含机密)

返回

getProjectEnablementStatus2(string, boolean)

获取项目的“高级安全性”的当前状态

function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>

参数

project

string

项目 ID 或项目名称

includeAllProperties

boolean

如果为 true,还确定推送是否被阻止(如果它们包含机密)

返回

getRepoEnablementStatus2(string, string, boolean)

确定是否为存储库启用了代码安全、机密保护及其功能。

function getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

includeAllProperties

boolean

如果为 true,还将确定检测到机密时是否阻止推送

返回

updateOrgEnablementStatus2(OrgEnablementSettings)

更新组织高级安全性的状态

function updateOrgEnablementStatus2(orgEnablementSettings: OrgEnablementSettings): Promise<void>

参数

orgEnablementSettings
OrgEnablementSettings

新状态

返回

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

更新项目的高级安全性状态

function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>

参数

projectEnablementSettings
ProjectEnablementSettings

新状态

project

string

项目 ID 或项目名称

返回

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

更新代码安全和机密保护的启用状态以及给定存储库的相应功能。

function updateRepoAdvSecEnablementStatus2(savedAdvSecEnablementStatus: RepoEnablementSettings, project: string, repository: string): Promise<void>

参数

savedAdvSecEnablementStatus
RepoEnablementSettings

新状态

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

返回

Promise<void>