ManagementRestClient class
VSS REST API への要求を行うために使用する (派生する) 基本クラス
- Extends
メソッド
| create |
プライマリ スケール ユニット (EUS21) での複数組織の課金計算中に、この API を使用して特定の組織の課金スナップショットを作成します。プライマリ スケール ユニットは、異なる scsle ユニット内の組織ごとにこの API を呼び出して、課金スナップショットを作成します。 データは、組織固有のパーティション DB -> 請求スナップショット テーブルに格納されます。 これは、お客様が組織固有のパーティション DB から課金データをフェッチする場合に必要です。 |
| get |
VSID と一致しないものも含め、課金対象のすべてのコミッターの詳細を取得します。 |
| get |
このリポジトリに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。 |
| get |
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。 |
| get |
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。 |
| get |
|
| get |
課金情報を計算するときに使用されるコミット者を取得します。 |
| get |
組織のセキュリティ強化の現在の状態を取得する |
| get |
プロジェクトの Advanced Security の現在の状態を取得する |
| get |
コード セキュリティ、シークレット保護、およびその機能がリポジトリに対して有効になっているかどうかを判断します。 |
| update |
組織のセキュリティ強化の状態を更新する |
| update |
プロジェクトの Advanced Security の状態を更新する |
| update |
特定のリポジトリに対して、Code Security と Secret Protection の有効化状態をそれぞれの機能と共に更新します。 |
コンストラクターの詳細
ManagementRestClient(IVssRestClientOptions)
メソッドの詳細
createBillingSnapshot3(MeterUsageForPlan, Plan)
プライマリ スケール ユニット (EUS21) での複数組織の課金計算中に、この API を使用して特定の組織の課金スナップショットを作成します。プライマリ スケール ユニットは、異なる scsle ユニット内の組織ごとにこの API を呼び出して、課金スナップショットを作成します。 データは、組織固有のパーティション DB -> 請求スナップショット テーブルに格納されます。 これは、お客様が組織固有のパーティション DB から課金データをフェッチする場合に必要です。
function createBillingSnapshot3(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>パラメーター
- meterUsage
- MeterUsageForPlan
- plan
- Plan
戻り値
Promise<void>
getBillableCommitterDetails3(Plan, Date)
VSID と一致しないものも含め、課金対象のすべてのコミッターの詳細を取得します。
function getBillableCommitterDetails3(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>パラメーター
- plan
- Plan
クエリを実行するプラン。 サポートされているプラン: CodeSecurity と SecretProtection。 これは必須パラメーターです。
- billingDate
-
Date
クエリを実行する日付、または指定されていない場合は今日
戻り値
Promise<BillableCommitterDetails[]>
getEstimatedBillableCommittersDetailsForRepo3(string, string, Plan)
このリポジトリに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。
function getEstimatedBillableCommittersDetailsForRepo3(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- repository
-
string
リポジトリの名前または ID
- plan
- Plan
クエリを実行するプラン。
戻り値
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForOrg3(Plan)
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。
function getEstimatedBillablePushersDetailsForOrg3(plan: Plan): Promise<MeterUsageEstimate>パラメーター
- plan
- Plan
クエリを実行するプラン。
戻り値
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject3(string, Plan)
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。
function getEstimatedBillablePushersDetailsForProject3(project: string, plan?: Plan): Promise<MeterUsageEstimate>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- plan
- Plan
戻り値
Promise<MeterUsageEstimate>
getLastMeterUsage3(Plan)
function getLastMeterUsage3(plan: Plan): Promise<MeterUsageForPlan>パラメーター
- plan
- Plan
戻り値
Promise<MeterUsageForPlan>
getMeterUsage3(Plan, Date)
課金情報を計算するときに使用されるコミット者を取得します。
function getMeterUsage3(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>パラメーター
- plan
- Plan
クエリを実行するプラン。 サポートされているプラン: CodeSecurity と SecretProtection。 これは必須パラメーターです。
- billingDate
-
Date
クエリを実行する日付、または指定されていない場合は今日
戻り値
Promise<MeterUsageForPlan>
getOrgEnablementStatus3(boolean)
組織のセキュリティ強化の現在の状態を取得する
function getOrgEnablementStatus3(includeAllProperties?: boolean): Promise<OrgEnablementSettings>パラメーター
- includeAllProperties
-
boolean
true の場合は、プッシュにシークレットが含まれている場合にブロックされるかどうかも確認します
戻り値
Promise<OrgEnablementSettings>
getProjectEnablementStatus3(string, boolean)
プロジェクトの Advanced Security の現在の状態を取得する
function getProjectEnablementStatus3(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- includeAllProperties
-
boolean
true の場合は、プッシュにシークレットが含まれている場合にブロックされるかどうかも確認します
戻り値
Promise<ProjectEnablementSettings>
getRepoEnablementStatus3(string, string, boolean)
コード セキュリティ、シークレット保護、およびその機能がリポジトリに対して有効になっているかどうかを判断します。
function getRepoEnablementStatus3(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- repository
-
string
リポジトリの名前または ID
- includeAllProperties
-
boolean
true の場合、シークレットが検出されたときにプッシュがブロックされるかどうかも判断されます
戻り値
Promise<RepoEnablementSettings>
updateOrgEnablementStatus3(OrgEnablementSettings)
組織のセキュリティ強化の状態を更新する
function updateOrgEnablementStatus3(orgEnablementSettings: OrgEnablementSettings): Promise<void>パラメーター
- orgEnablementSettings
- OrgEnablementSettings
新しい状態
戻り値
Promise<void>
updateProjectEnablementStatus3(ProjectEnablementSettings, string)
プロジェクトの Advanced Security の状態を更新する
function updateProjectEnablementStatus3(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>パラメーター
- projectEnablementSettings
- ProjectEnablementSettings
新しい状態
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<void>
updateRepoAdvSecEnablementStatus3(RepoEnablementSettings, string, string)
特定のリポジトリに対して、Code Security と Secret Protection の有効化状態をそれぞれの機能と共に更新します。
function updateRepoAdvSecEnablementStatus3(savedAdvSecEnablementStatus: RepoEnablementSettings, project: string, repository: string): Promise<void>パラメーター
- savedAdvSecEnablementStatus
- RepoEnablementSettings
new status
- project
-
string
プロジェクト ID またはプロジェクト名
- repository
-
string
リポジトリの名前または ID
戻り値
Promise<void>