次の方法で共有


ManagementRestClient class

VSS REST API への要求を行うために使用する (派生する) 基本クラス

Extends

コンストラクター

ManagementRestClient(IVssRestClientOptions)

メソッド

createBillingSnapshot2(MeterUsageForPlan, Plan)

プライマリ スケール ユニット (EUS21) での複数組織の課金計算中に、この API を使用して特定の組織の課金スナップショットを作成します。プライマリ スケール ユニットは、異なる scsle ユニット内の組織ごとにこの API を呼び出して、課金スナップショットを作成します。 データは、組織固有のパーティション DB - 請求スナップショット テーブルに格納されます。 これは、お客様が組織固有のパーティション DB から課金データをフェッチする場合に必要です。

getAdvancedSecurityAgentPoolSelection()

すべての利用可能なエージェントプール+現在選択中のエージェントプールを取得するための基本URL これは管理権限を必要としない読み取り専用操作です。

getBillableCommitterDetails2(Plan, Date)

VSID と一致しないものも含め、課金対象のすべてのコミッターの詳細を取得します。

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

このリポジトリに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。

getEstimatedBillablePushersDetailsForOrg2(Plan)

この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。

getEstimatedBillablePushersDetailsForProject2(string, Plan)

このprojectでAdvanced Securityが有効になった場合、顧客の利用に加わるプッシャーの数を推定してください。

getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)

課金情報を計算するときに使用されるコミット者を取得します。

getOrgEnablementStatus2(boolean)

組織のセキュリティ強化の現在の状態を取得する

getProjectEnablementStatus2(string, boolean)

projectのAdvanced Securityの現在のステータスを入手

getRepoEnablementStatus2(string, string, boolean)

コード セキュリティ、シークレット保護、およびその機能がリポジトリに対して有効になっているかどうかを判断します。

updateAdvancedSecurityAgentPoolSelection(string)

選択されたエージェントプールのレジストリ値を更新 これは自動的に、エージェントプールの基盤となるHTTPクライアントを使い、ユーザーがそのプールを使用する権限を持っているかを検証します。

updateOrgEnablementStatus2(OrgEnablementSettings)

組織のセキュリティ強化の状態を更新する

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

projectのAdvanced Securityのステータスを更新してください

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

特定のリポジトリに対して、Code Security と Secret Protection の有効化状態をそれぞれの機能と共に更新します。

コンストラクターの詳細

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

パラメーター

メソッドの詳細

createBillingSnapshot2(MeterUsageForPlan, Plan)

プライマリ スケール ユニット (EUS21) での複数組織の課金計算中に、この API を使用して特定の組織の課金スナップショットを作成します。プライマリ スケール ユニットは、異なる scsle ユニット内の組織ごとにこの API を呼び出して、課金スナップショットを作成します。 データは、組織固有のパーティション DB - 請求スナップショット テーブルに格納されます。 これは、お客様が組織固有のパーティション DB から課金データをフェッチする場合に必要です。

function createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>

パラメーター

meterUsage
MeterUsageForPlan
plan
Plan

戻り値

Promise<void>

getAdvancedSecurityAgentPoolSelection()

すべての利用可能なエージェントプール+現在選択中のエージェントプールを取得するための基本URL これは管理権限を必要としない読み取り専用操作です。

function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>

戻り値

Promise<AgentPoolDetails>

getBillableCommitterDetails2(Plan, Date)

VSID と一致しないものも含め、課金対象のすべてのコミッターの詳細を取得します。

function getBillableCommitterDetails2(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>

パラメーター

plan
Plan

クエリを実行するプラン。 サポートされているプラン: CodeSecurity と SecretProtection。 これは必須パラメーターです。

billingDate

Date

クエリを実行する日付、または指定されていない場合は今日

戻り値

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

このリポジトリに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。

function getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>

パラメーター

project

string

Project ID または project 名称

repository

string

リポジトリの名前または ID

plan
Plan

クエリを実行するプラン。

戻り値

getEstimatedBillablePushersDetailsForOrg2(Plan)

この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。

function getEstimatedBillablePushersDetailsForOrg2(plan?: Plan): Promise<MeterUsageEstimate>

パラメーター

plan
Plan

クエリを実行するプラン。

戻り値

getEstimatedBillablePushersDetailsForProject2(string, Plan)

このprojectでAdvanced Securityが有効になった場合、顧客の利用に加わるプッシャーの数を推定してください。

function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>

パラメーター

project

string

Project ID または project 名称

plan
Plan

戻り値

getLastMeterUsage2(Plan)

function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>

パラメーター

plan
Plan

戻り値

getMeterUsage2(Plan, Date)

課金情報を計算するときに使用されるコミット者を取得します。

function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>

パラメーター

plan
Plan

クエリを実行するプラン。 サポートされているプラン: CodeSecurity と SecretProtection。 これは必須パラメーターです。

billingDate

Date

クエリを実行する日付、または指定されていない場合は今日

戻り値

getOrgEnablementStatus2(boolean)

組織のセキュリティ強化の現在の状態を取得する

function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>

パラメーター

includeAllProperties

boolean

true の場合は、プッシュにシークレットが含まれている場合にブロックされるかどうかも確認します

戻り値

getProjectEnablementStatus2(string, boolean)

projectのAdvanced Securityの現在のステータスを入手

function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>

パラメーター

project

string

Project ID または project 名称

includeAllProperties

boolean

true の場合は、プッシュにシークレットが含まれている場合にブロックされるかどうかも確認します

戻り値

getRepoEnablementStatus2(string, string, boolean)

コード セキュリティ、シークレット保護、およびその機能がリポジトリに対して有効になっているかどうかを判断します。

function getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>

パラメーター

project

string

Project ID または project 名称

repository

string

リポジトリの名前または ID

includeAllProperties

boolean

true の場合、シークレットが検出されたときにプッシュがブロックされるかどうかも判断されます

戻り値

updateAdvancedSecurityAgentPoolSelection(string)

選択されたエージェントプールのレジストリ値を更新 これは自動的に、エージェントプールの基盤となるHTTPクライアントを使い、ユーザーがそのプールを使用する権限を持っているかを検証します。

function updateAdvancedSecurityAgentPoolSelection(agentPoolName: string): Promise<AgentPoolDetails>

パラメーター

agentPoolName

string

戻り値

Promise<AgentPoolDetails>

updateOrgEnablementStatus2(OrgEnablementSettings)

組織のセキュリティ強化の状態を更新する

function updateOrgEnablementStatus2(orgEnablementSettings: OrgEnablementSettings): Promise<void>

パラメーター

orgEnablementSettings
OrgEnablementSettings

新しい状態

戻り値

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

projectのAdvanced Securityのステータスを更新してください

function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>

パラメーター

projectEnablementSettings
ProjectEnablementSettings

新しい状態

project

string

Project ID または project 名称

戻り値

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

特定のリポジトリに対して、Code Security と Secret Protection の有効化状態をそれぞれの機能と共に更新します。

function updateRepoAdvSecEnablementStatus2(repoEnablementSettings: RepoEnablementSettings, project: string, repository: string): Promise<void>

パラメーター

repoEnablementSettings
RepoEnablementSettings

新たな地位

project

string

Project ID または project 名称

repository

string

リポジトリの名前または ID

戻り値

Promise<void>