ManagementRestClient class
VSS REST API への要求を行うために使用する (派生する) 基本クラス
- Extends
メソッド
| create |
プライマリ スケール ユニット (EUS21) での複数組織の課金計算中に、この API を使用して特定の組織の課金スナップショットを作成します。プライマリ スケール ユニットは、異なる scsle ユニット内の組織ごとにこの API を呼び出して、課金スナップショットを作成します。 データは、組織固有のパーティション DB -> 請求スナップショット テーブルに格納されます。 これは、お客様が組織固有のパーティション DB から課金データをフェッチする場合に必要です。 |
| create |
プライマリ スケール ユニット (EUS21) での複数組織の課金計算中に、この API を使用して特定の組織の課金スナップショットを作成します。プライマリ スケール ユニットは、異なる scsle ユニット内の組織ごとにこの API を呼び出して、課金スナップショットを作成します。 データは、組織固有のパーティション DB -> 請求スナップショット テーブルに格納されます。 これは、お客様が組織固有のパーティション DB から課金データをフェッチする場合に必要です。 |
| get |
VSID と一致しないものも含め、課金対象のすべてのコミッターの詳細を取得します。 |
| get |
VSID と一致しないものも含め、課金対象のすべてのコミッターの詳細を取得します。 |
| get |
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。 |
| get |
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。 |
| get |
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。 |
| get |
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。 |
| get |
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターを見積もります。 |
| get |
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターを見積もります。 |
| get |
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターの数を見積もります。 |
| get |
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターの数を見積もります。 |
| get |
このリポジトリで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターを見積もります。 |
| get |
このリポジトリで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターを見積もります。 |
| get |
このリポジトリに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。 |
| get |
このリポジトリに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。 |
| get |
|
| get |
|
| get |
課金情報を計算するときに使用されるコミット者を取得します。 |
| get |
課金情報を計算するときに使用されるコミット者を取得します。 |
| get |
組織のセキュリティ強化の現在の状態を取得する |
| get |
組織のセキュリティ強化の現在の状態を取得する |
| get |
プロジェクトの Advanced Security の現在の状態を取得する |
| get |
プロジェクトの Advanced Security の現在の状態を取得する |
| get |
リポジトリに対して Advanced Security が有効になっているかどうかを判断する |
| get |
リポジトリに対して Advanced Security が有効になっているかどうかを判断する |
| update |
組織のセキュリティ強化の状態を更新する |
| update |
組織のセキュリティ強化の状態を更新する |
| update |
プロジェクトの Advanced Security の状態を更新する |
| update |
プロジェクトの 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>
createBillingSnapshot2(MeterUsageForPlan, Plan)
プライマリ スケール ユニット (EUS21) での複数組織の課金計算中に、この API を使用して特定の組織の課金スナップショットを作成します。プライマリ スケール ユニットは、異なる scsle ユニット内の組織ごとにこの API を呼び出して、課金スナップショットを作成します。 データは、組織固有のパーティション DB -> 請求スナップショット テーブルに格納されます。 これは、お客様が組織固有のパーティション 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()
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。
function getEstimatedBillablePushersDetailsForOrg(): Promise<BilledCommitter[]>戻り値
Promise<BilledCommitter[]>
getEstimatedBillablePushersDetailsForOrg2()
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。
function getEstimatedBillablePushersDetailsForOrg2(): Promise<MeterUsageEstimate>戻り値
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject(string)
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。
function getEstimatedBillablePushersDetailsForProject(project: string): Promise<BilledCommitter[]>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<BilledCommitter[]>
getEstimatedBillablePushersDetailsForProject2(string)
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。
function getEstimatedBillablePushersDetailsForProject2(project: string): Promise<MeterUsageEstimate>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<MeterUsageEstimate>
getEstimatedOrgBillablePushers()
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターを見積もります。
function getEstimatedOrgBillablePushers(): Promise<string[]>戻り値
Promise<string[]>
getEstimatedOrgBillablePushers2()
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターを見積もります。
function getEstimatedOrgBillablePushers2(): Promise<string[]>戻り値
Promise<string[]>
getEstimatedProjectBillablePushers(string)
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターの数を見積もります。
function getEstimatedProjectBillablePushers(project: string): Promise<string[]>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<string[]>
getEstimatedProjectBillablePushers2(string)
このプロジェクトで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターの数を見積もります。
function getEstimatedProjectBillablePushers2(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[]>
getEstimatedRepoBillableCommitters2(string, string)
このリポジトリで Advanced Security が有効になっている場合に、顧客の使用状況に追加されるコミッターを見積もります。
function getEstimatedRepoBillableCommitters2(project: string, repository: string): Promise<string[]>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- repository
-
string
リポジトリの名前または ID
戻り値
Promise<string[]>
getEstimatedRepoBillableCommittersDetails2(string, string)
このリポジトリに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。
function getEstimatedRepoBillableCommittersDetails2(project: string, repository: string): Promise<MeterUsageEstimate>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- repository
-
string
戻り値
Promise<MeterUsageEstimate>
getEstimatedRepoBillablePushersDetails(string, string)
このリポジトリに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。
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)
プロジェクトの Advanced Security の現在の状態を取得する
function getProjectEnablementStatus(project: string, includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- includeAllProperties
-
boolean
true の場合は、プッシュにシークレットが含まれている場合にブロックされるかどうかも確認します
戻り値
Promise<AdvSecEnablementSettings>
getProjectEnablementStatus2(string, boolean)
プロジェクトの Advanced Security の現在の状態を取得する
function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- includeAllProperties
-
boolean
true の場合は、プッシュにシークレットが含まれている場合にブロックされるかどうかも確認します
戻り値
Promise<ProjectEnablementSettings>
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>
getRepoEnablementStatus2(string, string, boolean)
リポジトリに対して Advanced Security が有効になっているかどうかを判断する
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)
プロジェクトの Advanced Security の状態を更新する
function updateProjectEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate, project: string): Promise<void>パラメーター
- savedAdvSecEnablementStatus
- AdvSecEnablementSettingsUpdate
新しい状態
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<void>
updateProjectEnablementStatus2(ProjectEnablementSettings, string)
プロジェクトの Advanced Security の状態を更新する
function updateProjectEnablementStatus2(savedAdvSecEnablementStatus: ProjectEnablementSettings, project: string): Promise<void>パラメーター
- savedAdvSecEnablementStatus
- ProjectEnablementSettings
新しい状態
- 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>
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)
リポジトリの Advanced Security の有効化を更新する
function updateRepoAdvSecEnablementStatus2(savedAdvSecEnablementStatus: RepoEnablementSettings, project: string, repository: string): Promise<void>パラメーター
- savedAdvSecEnablementStatus
- RepoEnablementSettings
新しい状態
- project
-
string
プロジェクト ID またはプロジェクト名
- repository
-
string
リポジトリの名前または ID
戻り値
Promise<void>