ManagementRestClient class

包:

azure-devops-extension-api

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

Extends

RestClientBase

构造函数

ManagementRestClient(IVssRestClientOptions)

方法

createBillingSnapshot(MeterUsage)	在主缩放单元 (EUS21) 进行多组织计费计算期间，此 API 用于为特定组织创建计费快照。主要缩放单元将为不同 scsle 单位中的每个组织调用此 API，以创建计费快照。 数据将存储在组织特定的分区 DB -> 计费快照表中。 这是必需的，因为客户将从其组织特定的分区 DB 中提取计费数据。
deleteBillingInfo(string)	删除组织的帐单信息。
deleteMeterUsageHistory(string)	从组织的主 SU 中删除计量使用情况历史记录。
getBillableCommitterDetails(Date)	获取所有可计费的提交者详细信息，包括与 VSID 不匹配的详细信息。
getBillingInfo(string)	获取组织的计费信息。
getEstimatedOrgBillablePushers()	如果为此组织启用了高级安全，估计将添加到客户使用情况的提交者。
getEstimatedProjectBillablePushers(string)	如果为此项目启用了高级安全，估计将添加到客户使用情况的提交者数。
getEstimatedRepoBillableCommitters(string, string)	如果为此存储库启用了高级安全，估计将添加到客户使用情况的提交者。
getLastMeterUsage()
getMeterUsage(Date)	获取计算计费信息时使用的提交器。
getOrgEnablementStatus(boolean)	获取组织的“高级安全”的当前状态
getProjectEnablementStatus(string, boolean)	获取项目高级安全性的当前状态
getRepoEnablementStatus(string, string, boolean)	确定是否为存储库启用了高级安全
saveBillingInfo(BillingInfo, string)	保存组织的帐单信息。
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	更新组织的高级安全状态
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	更新项目的高级安全状态
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)	更新存储库高级安全性的启用

构造函数详细信息

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

参数

options

IVssRestClientOptions

方法详细信息

createBillingSnapshot(MeterUsage)

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

function createBillingSnapshot(meterUsage: MeterUsage): Promise<void>

参数

meterUsage

MeterUsage

返回

Promise<void>

deleteBillingInfo(string)

删除组织的帐单信息。

function deleteBillingInfo(organizationId: string): Promise<void>

参数

organizationId

string

返回

Promise<void>

deleteMeterUsageHistory(string)

从组织的主 SU 中删除计量使用情况历史记录。

function deleteMeterUsageHistory(organizationId: string): Promise<void>

参数

organizationId

string

返回

Promise<void>

getBillableCommitterDetails(Date)

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

function getBillableCommitterDetails(billingDate?: Date): Promise<BillableCommitterDetails[]>

参数

billingDate

Date

要查询的日期，如果未提供，则为今天

返回

Promise<BillableCommitterDetails[]>

getBillingInfo(string)

获取组织的计费信息。

function getBillingInfo(organizationId: string): Promise<BillingInfo>

参数

organizationId

string

要获取其帐单信息的组织 ID。

返回

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

如果为此组织启用了高级安全，估计将添加到客户使用情况的提交者。

function getEstimatedOrgBillablePushers(): Promise<string[]>

返回

Promise<string[]>

getEstimatedProjectBillablePushers(string)

如果为此项目启用了高级安全，估计将添加到客户使用情况的提交者数。

function getEstimatedProjectBillablePushers(project: string): Promise<string[]>

参数

project

string

项目 ID 或项目名称

返回

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

如果为此存储库启用了高级安全，估计将添加到客户使用情况的提交者。

function getEstimatedRepoBillableCommitters(project: string, repository: string): Promise<string[]>

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

返回

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

返回

Promise<MeterUsage>

getMeterUsage(Date)

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

function getMeterUsage(billingDate?: Date): Promise<MeterUsage>

参数

billingDate

Date

要查询的日期，如果未提供，则为今天

返回

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

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

function getOrgEnablementStatus(includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>

参数

includeAllProperties

boolean

如果为 true，则还要确定是否阻止推送（如果它们包含机密）

返回

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus(string, boolean)

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

function getProjectEnablementStatus(project: string, includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>

参数

project

string

项目 ID 或项目名称

includeAllProperties

boolean

如果为 true，则还要确定是否阻止推送（如果它们包含机密）

返回

Promise<AdvSecEnablementSettings>

getRepoEnablementStatus(string, string, boolean)

确定是否为存储库启用了高级安全

function getRepoEnablementStatus(project: string, repository: string, includeAllProperties?: boolean): Promise<AdvSecEnablementStatus>

参数

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

includeAllProperties

boolean

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

返回

Promise<AdvSecEnablementStatus>

saveBillingInfo(BillingInfo, string)

保存组织的帐单信息。

function saveBillingInfo(billingInfo: BillingInfo, organizationId: string): Promise<void>

参数

billingInfo

BillingInfo

organizationId

string

返回

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

更新组织的高级安全状态

function updateOrgEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate): Promise<void>

参数

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

新状态

返回

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

更新项目的高级安全状态

function updateProjectEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate, project: string): Promise<void>

参数

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

新状态

project

string

项目 ID 或项目名称

返回

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

更新存储库高级安全性的启用

function updateRepoAdvSecEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementStatusUpdate, project: string, repository: string): Promise<void>

参数

savedAdvSecEnablementStatus

AdvSecEnablementStatusUpdate

新状态

project

string

项目 ID 或项目名称

repository

string

存储库的名称或 ID

返回

Promise<void>