ManagementRestClient class
VSS REST API への要求を行うために使用する (から派生する) 基本クラス
- Extends
コンストラクター
| Management |
メソッド
| create |
プライマリ スケール ユニット (EUS21) での複数組織の課金計算中に、この API は特定の組織の課金スナップショットを作成するために使用されます。プライマリ スケール ユニットは、請求スナップショットを作成するために、組織ごとに異なる scsle ユニットでこの API を呼び出します。 データは、組織固有のパーティション DB -> 課金スナップショットテーブルに格納されます。 これは、顧客が組織固有のパーティション DB から課金データをフェッチする場合に必要です。 |
| delete |
organizationの課金情報を削除します。 |
| delete |
organizationのプライマリ SU から測定の使用状況履歴を削除します。 |
| get |
VSID と一致しないものも含め、課金対象のすべてのコミッターの詳細を取得します。 |
| get |
organizationの課金情報を取得します。 |
| get |
このorganizationに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターを見積もります。 |
| get |
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターの数を見積もります。 |
| get |
このリポジトリに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターを見積もります。 |
| get |
|
| get |
課金情報を計算するときに使用されるコミッターを取得します。 |
| get |
organizationの Advanced Security の現在の状態を取得する |
| get |
プロジェクトの Advanced Security の現在の状態を取得する |
| get |
リポジトリに対して Advanced Security が有効になっているかどうかを判断する |
| save |
organizationの課金情報を保存します。 |
| update |
organizationの Advanced Security の状態を更新する |
| update |
プロジェクトの Advanced Security の状態を更新する |
| update |
リポジトリの Advanced Security の有効化を更新する |
コンストラクターの詳細
ManagementRestClient(IVssRestClientOptions)
メソッドの詳細
createBillingSnapshot(MeterUsage)
プライマリ スケール ユニット (EUS21) での複数組織の課金計算中に、この API は特定の組織の課金スナップショットを作成するために使用されます。プライマリ スケール ユニットは、請求スナップショットを作成するために、組織ごとに異なる scsle ユニットでこの API を呼び出します。 データは、組織固有のパーティション DB -> 課金スナップショットテーブルに格納されます。 これは、顧客が組織固有のパーティション DB から課金データをフェッチする場合に必要です。
function createBillingSnapshot(meterUsage: MeterUsage): Promise<void>パラメーター
- meterUsage
- MeterUsage
戻り値
Promise<void>
deleteBillingInfo(string)
organizationの課金情報を削除します。
function deleteBillingInfo(organizationId: string): Promise<void>パラメーター
- organizationId
-
string
戻り値
Promise<void>
deleteMeterUsageHistory(string)
organizationのプライマリ 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)
organizationの課金情報を取得します。
function getBillingInfo(organizationId: string): Promise<BillingInfo>パラメーター
- organizationId
-
string
課金情報を取得する組織 ID。
戻り値
Promise<BillingInfo>
getEstimatedOrgBillablePushers()
このorganizationに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターを見積もります。
function getEstimatedOrgBillablePushers(): Promise<string[]>戻り値
Promise<string[]>
getEstimatedProjectBillablePushers(string)
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターの数を見積もります。
function getEstimatedProjectBillablePushers(project: string): Promise<string[]>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<string[]>
getEstimatedRepoBillableCommitters(string, string)
このリポジトリに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターを見積もります。
function getEstimatedRepoBillableCommitters(project: string, repository: string): Promise<string[]>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- repository
-
string
リポジトリの名前または ID
戻り値
Promise<string[]>
getLastMeterUsage()
getMeterUsage(Date)
課金情報を計算するときに使用されるコミッターを取得します。
function getMeterUsage(billingDate?: Date): Promise<MeterUsage>パラメーター
- billingDate
-
Date
クエリを実行する日付(指定されていない場合)、今日
戻り値
Promise<MeterUsage>
getOrgEnablementStatus(boolean)
organizationの Advanced Security の現在の状態を取得する
function getOrgEnablementStatus(includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>パラメーター
- includeAllProperties
-
boolean
true の場合は、シークレットが含まれている場合にプッシュがブロックされるかどうかも判断します
戻り値
Promise<AdvSecEnablementSettings>
getProjectEnablementStatus(string, boolean)
プロジェクトの Advanced Security の現在の状態を取得する
function getProjectEnablementStatus(project: string, includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- includeAllProperties
-
boolean
true の場合は、シークレットが含まれている場合にプッシュがブロックされるかどうかも判断します
戻り値
Promise<AdvSecEnablementSettings>
getRepoEnablementStatus(string, string, boolean)
リポジトリに対して Advanced Security が有効になっているかどうかを判断する
function getRepoEnablementStatus(project: string, repository: string, includeAllProperties?: boolean): Promise<AdvSecEnablementStatus>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- repository
-
string
リポジトリの名前または ID
- includeAllProperties
-
boolean
true の場合、シークレットが検出されたときにプッシュがブロックされるかどうかも判断されます
戻り値
Promise<AdvSecEnablementStatus>
saveBillingInfo(BillingInfo, string)
organizationの課金情報を保存します。
function saveBillingInfo(billingInfo: BillingInfo, organizationId: string): Promise<void>パラメーター
- billingInfo
- BillingInfo
- organizationId
-
string
戻り値
Promise<void>
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)
organizationの Advanced Security の状態を更新する
function updateOrgEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate): Promise<void>パラメーター
- savedAdvSecEnablementStatus
- AdvSecEnablementSettingsUpdate
新しい状態
戻り値
Promise<void>
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)
プロジェクトの Advanced Security の状態を更新する
function updateProjectEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate, project: string): Promise<void>パラメーター
- savedAdvSecEnablementStatus
- AdvSecEnablementSettingsUpdate
新しい状態
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<void>
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)
リポジトリの Advanced Security の有効化を更新する
function updateRepoAdvSecEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementStatusUpdate, project: string, repository: string): Promise<void>パラメーター
- savedAdvSecEnablementStatus
- AdvSecEnablementStatusUpdate
新しい状態
- project
-
string
プロジェクト ID またはプロジェクト名
- repository
-
string
リポジトリの名前または ID
戻り値
Promise<void>