共用方式為


ManagementRestClient class

應該使用 (衍生自) 的基類,向 VSS REST API 提出要求

Extends

建構函式

ManagementRestClient(IVssRestClientOptions)

方法

createBillingSnapshot(MeterUsage)

在主要縮放單位 (EUS21) 的多組織計費計算期間,此 API 可用來建立特定組織的計費快照集。主要縮放單位會針對不同 Scsle 單位中的每個組織呼叫此 API,以建立計費快照集。 數據會儲存在組織特定的分割區資料庫 -> 計費快照集數據表中。 這是必要的,因為客戶會從其組織特定的分割區資料庫擷取帳單數據。

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)

參數

方法詳細資料

createBillingSnapshot(MeterUsage)

在主要縮放單位 (EUS21) 的多組織計費計算期間,此 API 可用來建立特定組織的計費快照集。主要縮放單位會針對不同 Scsle 單位中的每個組織呼叫此 API,以建立計費快照集。 數據會儲存在組織特定的分割區資料庫 -> 計費快照集數據表中。 這是必要的,因為客戶會從其組織特定的分割區資料庫擷取帳單數據。

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

目前查詢的日期,如果未提供,則為

傳回

getBillingInfo(string)

取得組織的帳單資訊。

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

參數

organizationId

string

要取得帳單資訊的組織標識碼。

傳回

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

如果此組織已啟用進階安全性,則估計將新增至客戶使用量的認可者。

function getEstimatedOrgBillablePushers(): Promise<string[]>

傳回

Promise<string[]>

getEstimatedProjectBillablePushers(string)

如果已啟用此項目的進階安全性,估計要新增至客戶使用量的認可者數目。

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

參數

project

string

項目識別碼或項目名稱

傳回

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

如果已啟用此存放庫的進階安全性,則估計要新增至客戶使用量的認可者。

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

參數

project

string

項目識別碼或項目名稱

repository

string

存放庫的名稱或標識碼

傳回

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,也判斷推播是否在包含秘密時遭到封鎖

傳回

getProjectEnablementStatus(string, boolean)

取得專案的進階安全性目前狀態

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

參數

project

string

項目識別碼或項目名稱

includeAllProperties

boolean

若為 true,也判斷推播是否在包含秘密時遭到封鎖

傳回

getRepoEnablementStatus(string, string, boolean)

判斷是否已啟用存放庫的進階安全性

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

參數

project

string

項目識別碼或項目名稱

repository

string

存放庫的名稱或標識碼

includeAllProperties

boolean

若為 true,也會判斷偵測到秘密時是否封鎖推播

傳回

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

項目識別碼或項目名稱

傳回

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

更新存放庫的進階安全性啟用

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

參數

savedAdvSecEnablementStatus
AdvSecEnablementStatusUpdate

新增狀態

project

string

項目識別碼或項目名稱

repository

string

存放庫的名稱或標識碼

傳回

Promise<void>