ManagementRestClient class
应使用基类(派生自)向 VSS REST API 发出请求
方法
构造函数详细信息
ManagementRestClient(IVssRestClientOptions)
方法详细信息
createBillingSnapshot(MeterUsage)
在主要缩放单元(EUS21)的多组织计费计算期间,此 API 用于为特定组织创建计费快照。主要缩放单元将针对不同 scsle 单位中的每个组织调用此 API,以创建计费快照。 数据将存储在组织特定的分区 DB 中 -> 计费快照表。 这是必需的,因为客户将从其组织特定的分区数据库中提取计费数据。
function createBillingSnapshot(meterUsage: MeterUsage): Promise<void>
参数
- meterUsage
- MeterUsage
返回
Promise<void>
createBillingSnapshot2(MeterUsageForPlan, Plan)
在主要缩放单元(EUS21)的多组织计费计算期间,此 API 用于为特定组织创建计费快照。主要缩放单元将针对不同 scsle 单位中的每个组织调用此 API,以创建计费快照。 数据将存储在组织特定的分区 DB 中 -> 计费快照表。 这是必需的,因为客户将从其组织特定的分区数据库中提取计费数据。
function createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>
参数
- meterUsage
- MeterUsageForPlan
- plan
- Plan
返回
Promise<void>
getBillableCommitterDetails(Date)
获取所有计费提交者的详细信息,包括与 VSID 不匹配的提交者的详细信息。
function getBillableCommitterDetails(billingDate?: Date): Promise<BillableCommitterDetails[]>
参数
- billingDate
-
Date
查询日期(如果未提供)今天
返回
Promise<BillableCommitterDetails[]>
getBillableCommitterDetails2(Plan, Date)
获取所有计费提交者的详细信息,包括与 VSID 不匹配的提交者的详细信息。
function getBillableCommitterDetails2(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>
参数
- plan
- Plan
要查询的计划。 支持的计划:CodeSecurity 和 SecretProtection。 这是强制参数。
- billingDate
-
Date
查询日期(如果未提供)今天
返回
Promise<BillableCommitterDetails[]>
getEstimatedBillablePushersDetailsForOrg()
如果为此组织启用了高级安全性,则估计将添加到客户的使用情况的推送器。
function getEstimatedBillablePushersDetailsForOrg(): Promise<BilledCommitter[]>
返回
Promise<BilledCommitter[]>
getEstimatedBillablePushersDetailsForOrg2()
如果为此组织启用了高级安全性,则估计将添加到客户的使用情况的推送器。
function getEstimatedBillablePushersDetailsForOrg2(): Promise<MeterUsageEstimate>
返回
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject(string)
如果为此项目启用了高级安全性,则估计将添加到客户的使用情况的推送器。
function getEstimatedBillablePushersDetailsForProject(project: string): Promise<BilledCommitter[]>
参数
- project
-
string
项目 ID 或项目名称
返回
Promise<BilledCommitter[]>
getEstimatedBillablePushersDetailsForProject2(string)
如果为此项目启用了高级安全性,则估计将添加到客户的使用情况的推送器。
function getEstimatedBillablePushersDetailsForProject2(project: string): Promise<MeterUsageEstimate>
参数
- project
-
string
项目 ID 或项目名称
返回
Promise<MeterUsageEstimate>
getEstimatedOrgBillablePushers()
如果为此组织启用了高级安全性,则估计将添加到客户的使用情况中的提交者。
function getEstimatedOrgBillablePushers(): Promise<string[]>
返回
Promise<string[]>
getEstimatedOrgBillablePushers2()
如果为此组织启用了高级安全性,则估计将添加到客户的使用情况中的提交者。
function getEstimatedOrgBillablePushers2(): Promise<string[]>
返回
Promise<string[]>
getEstimatedProjectBillablePushers(string)
如果为此项目启用了高级安全性,则估计将添加到客户的使用情况中的提交者数。
function getEstimatedProjectBillablePushers(project: string): Promise<string[]>
参数
- project
-
string
项目 ID 或项目名称
返回
Promise<string[]>
getEstimatedProjectBillablePushers2(string)
如果为此项目启用了高级安全性,则估计将添加到客户的使用情况中的提交者数。
function getEstimatedProjectBillablePushers2(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[]>
getEstimatedRepoBillableCommitters2(string, string)
如果为此存储库启用了高级安全性,则估计将添加到客户的使用情况的提交者。
function getEstimatedRepoBillableCommitters2(project: string, repository: string): Promise<string[]>
参数
- project
-
string
项目 ID 或项目名称
- repository
-
string
存储库的名称或 ID
返回
Promise<string[]>
getEstimatedRepoBillableCommittersDetails2(string, string)
如果为此存储库启用了高级安全性,则估计将添加到客户的使用情况的推送器。
function getEstimatedRepoBillableCommittersDetails2(project: string, repository: string): Promise<MeterUsageEstimate>
参数
- project
-
string
项目 ID 或项目名称
- repository
-
string
返回
Promise<MeterUsageEstimate>
getEstimatedRepoBillablePushersDetails(string, string)
如果为此存储库启用了高级安全性,则估计将添加到客户的使用情况的推送器。
function getEstimatedRepoBillablePushersDetails(project: string, repository: string): Promise<BilledCommitter[]>
参数
- project
-
string
项目 ID 或项目名称
- repository
-
string
返回
Promise<BilledCommitter[]>
getLastMeterUsage()
getLastMeterUsage2(Plan)
function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>
参数
- plan
- Plan
返回
Promise<MeterUsageForPlan>
getMeterUsage(Date)
获取计算计费信息时使用的提交器。
function getMeterUsage(billingDate?: Date): Promise<MeterUsage>
参数
- billingDate
-
Date
查询日期(如果未提供)今天
返回
Promise<MeterUsage>
getMeterUsage2(Plan, Date)
获取计算计费信息时使用的提交器。
function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>
参数
- plan
- Plan
要查询的计划。 支持的计划:CodeSecurity 和 SecretProtection。 这是强制参数。
- billingDate
-
Date
查询日期(如果未提供)今天
返回
Promise<MeterUsageForPlan>
getOrgEnablementStatus(boolean)
获取组织的高级安全性的当前状态
function getOrgEnablementStatus(includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>
参数
- includeAllProperties
-
boolean
如果为 true,还确定推送是否被阻止(如果它们包含机密)
返回
Promise<AdvSecEnablementSettings>
getOrgEnablementStatus2(boolean)
获取组织的高级安全性的当前状态
function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>
参数
- includeAllProperties
-
boolean
如果为 true,还确定推送是否被阻止(如果它们包含机密)
返回
Promise<OrgEnablementSettings>
getProjectEnablementStatus(string, boolean)
获取项目的“高级安全性”的当前状态
function getProjectEnablementStatus(project: string, includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>
参数
- project
-
string
项目 ID 或项目名称
- includeAllProperties
-
boolean
如果为 true,还确定推送是否被阻止(如果它们包含机密)
返回
Promise<AdvSecEnablementSettings>
getProjectEnablementStatus2(string, boolean)
获取项目的“高级安全性”的当前状态
function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>
参数
- project
-
string
项目 ID 或项目名称
- includeAllProperties
-
boolean
如果为 true,还确定推送是否被阻止(如果它们包含机密)
返回
Promise<ProjectEnablementSettings>
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>
getRepoEnablementStatus2(string, string, boolean)
确定是否为存储库启用了高级安全性
function getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>
参数
- project
-
string
项目 ID 或项目名称
- repository
-
string
存储库的名称或 ID
- includeAllProperties
-
boolean
如果为 true,还将确定检测到机密时是否阻止推送
返回
Promise<RepoEnablementSettings>
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)
更新组织高级安全性的状态
function updateOrgEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate): Promise<void>
参数
- savedAdvSecEnablementStatus
- AdvSecEnablementSettingsUpdate
新状态
返回
Promise<void>
updateOrgEnablementStatus2(OrgEnablementSettings)
更新组织高级安全性的状态
function updateOrgEnablementStatus2(savedAdvSecEnablementStatus: OrgEnablementSettings): Promise<void>
参数
- savedAdvSecEnablementStatus
- OrgEnablementSettings
新状态
返回
Promise<void>
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)
更新项目的高级安全性状态
function updateProjectEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate, project: string): Promise<void>
参数
- savedAdvSecEnablementStatus
- AdvSecEnablementSettingsUpdate
新状态
- project
-
string
项目 ID 或项目名称
返回
Promise<void>
updateProjectEnablementStatus2(ProjectEnablementSettings, string)
更新项目的高级安全性状态
function updateProjectEnablementStatus2(savedAdvSecEnablementStatus: ProjectEnablementSettings, project: string): Promise<void>
参数
- savedAdvSecEnablementStatus
- ProjectEnablementSettings
新状态
- 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>
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)
更新存储库的高级安全性启用
function updateRepoAdvSecEnablementStatus2(savedAdvSecEnablementStatus: RepoEnablementSettings, project: string, repository: string): Promise<void>
参数
- savedAdvSecEnablementStatus
- RepoEnablementSettings
新状态
- project
-
string
项目 ID 或项目名称
- repository
-
string
存储库的名称或 ID
返回
Promise<void>