ManagementRestClient class
VSS REST API への要求を行うために使用する (派生する) 基本クラス
- Extends
メソッド
| cancel |
組織の実行中およびキュー中のCodeQLジョブおよび進行中の動的パイプライン実行をすべてキャンセルします。 |
| create |
プライマリ スケール ユニット (EUS21) での複数組織の課金計算中に、この API を使用して特定の組織の課金スナップショットを作成します。プライマリ スケール ユニットは、異なる scsle ユニット内の組織ごとにこの API を呼び出して、課金スナップショットを作成します。 データは組織固有のパーティションDB -> 請求スナップショットテーブルに保存されます。 これは、お客様が組織固有のパーティション DB から課金データをフェッチする場合に必要です。 |
| get |
すべての利用可能なエージェントプール+現在選択中のエージェントプールを取得するための基本URL これは管理権限を必要としない読み取り専用操作です。 |
| get |
VSID と一致しないものも含め、課金対象のすべてのコミッターの詳細を取得します。 |
| get |
組織の実行中およびキュー中のCodeQLジョブ数、そして進行中の動的パイプライン実行数を取得します。 |
| get |
組織の現在のCodeQLのデフォルトセットアップスケジュール設定を取得します。 |
| get |
組織の現在のCodeQLのデフォルトセットアップスケジュール設定を取得します。 |
| get |
このリポジトリに対して Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。 |
| get |
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。 |
| get |
このprojectでAdvanced Securityが有効になった場合、顧客の利用に加わるプッシャーの数を推定してください。 |
| get |
|
| get |
課金情報を計算するときに使用されるコミット者を取得します。 |
| get |
組織のセキュリティ強化の現在の状態を取得する |
| get |
projectのAdvanced Securityの現在のステータスを入手 |
| get |
コード セキュリティ、シークレット保護、およびその機能がリポジトリに対して有効になっているかどうかを判断します。 |
| update |
選択されたエージェントプールのレジストリ値を更新 これは自動的に、エージェントプールの基盤となるHTTPクライアントを使い、ユーザーがそのプールを使用する権限を持っているかを検証します。 |
| update |
組織のCodeQLデフォルトセットアップスキャンを実行する曜日を設定します。 |
| update |
組織のCodeQLデフォルトセットアップスキャンを実行する曜日を設定します。 |
| update |
組織のセキュリティ強化の状態を更新する |
| update |
projectのAdvanced Securityのステータスを更新してください |
| update |
特定のリポジトリに対して、Code Security と Secret Protection の有効化状態をそれぞれの機能と共に更新します。 |
コンストラクターの詳細
ManagementRestClient(IVssRestClientOptions)
メソッドの詳細
cancelCodeQLJobs()
組織の実行中およびキュー中のCodeQLジョブおよび進行中の動的パイプライン実行をすべてキャンセルします。
function cancelCodeQLJobs(): Promise<number>返品
Promise<number>
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
クエリを実行する日付、または指定されていない場合は今日
返品
Promise<BillableCommitterDetails[]>
getCodeQLJobCount()
組織の実行中およびキュー中のCodeQLジョブ数、そして進行中の動的パイプライン実行数を取得します。
function getCodeQLJobCount(): Promise<number>返品
Promise<number>
getCodeQLSchedule()
組織の現在のCodeQLのデフォルトセットアップスケジュール設定を取得します。
function getCodeQLSchedule(): Promise<CodeQLScheduleDetails>返品
Promise<CodeQLScheduleDetails>
getCodeQLScheduleLegacy()
組織の現在のCodeQLのデフォルトセットアップスケジュール設定を取得します。
function getCodeQLScheduleLegacy(): Promise<CodeQLScheduleDetails>返品
Promise<CodeQLScheduleDetails>
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
クエリを実行するプラン。
返品
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForOrg2(Plan)
この組織で Advanced Security が有効になっている場合に、顧客の使用状況に追加されるプッシャーを見積もる。
function getEstimatedBillablePushersDetailsForOrg2(plan?: Plan): Promise<MeterUsageEstimate>パラメーター
- plan
- Plan
クエリを実行するプラン。
返品
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject2(string, Plan)
このprojectでAdvanced Securityが有効になった場合、顧客の利用に加わるプッシャーの数を推定してください。
function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>パラメーター
- project
-
string
Project ID または project 名称
- plan
- Plan
返品
Promise<MeterUsageEstimate>
getLastMeterUsage2(Plan)
function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>パラメーター
- plan
- Plan
返品
Promise<MeterUsageForPlan>
getMeterUsage2(Plan, Date)
課金情報を計算するときに使用されるコミット者を取得します。
function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>パラメーター
- plan
- Plan
クエリを実行するプラン。 サポートされているプラン: CodeSecurity と SecretProtection。 これは必須パラメーターです。
- billingDate
-
Date
クエリを実行する日付、または指定されていない場合は今日
返品
Promise<MeterUsageForPlan>
getOrgEnablementStatus2(boolean)
組織のセキュリティ強化の現在の状態を取得する
function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>パラメーター
- includeAllProperties
-
boolean
true の場合は、プッシュにシークレットが含まれている場合にブロックされるかどうかも確認します
返品
Promise<OrgEnablementSettings>
getProjectEnablementStatus2(string, boolean)
projectのAdvanced Securityの現在のステータスを入手
function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>パラメーター
- project
-
string
Project ID または project 名称
- includeAllProperties
-
boolean
true の場合は、プッシュにシークレットが含まれている場合にブロックされるかどうかも確認します
返品
Promise<ProjectEnablementSettings>
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 の場合、シークレットが検出されたときにプッシュがブロックされるかどうかも判断されます
返品
Promise<RepoEnablementSettings>
updateAdvancedSecurityAgentPoolSelection(string)
選択されたエージェントプールのレジストリ値を更新 これは自動的に、エージェントプールの基盤となるHTTPクライアントを使い、ユーザーがそのプールを使用する権限を持っているかを検証します。
function updateAdvancedSecurityAgentPoolSelection(agentPoolName: string): Promise<AgentPoolDetails>パラメーター
- agentPoolName
-
string
返品
Promise<AgentPoolDetails>
updateCodeQLSchedule(number)
組織のCodeQLデフォルトセットアップスキャンを実行する曜日を設定します。
function updateCodeQLSchedule(scheduleDayOfWeek: number): Promise<CodeQLScheduleDetails>パラメーター
- scheduleDayOfWeek
-
number
整数の曜日:0=日曜日、1=月曜日、...、6=土曜日。
返品
Promise<CodeQLScheduleDetails>
updateCodeQLScheduleLegacy(number)
組織のCodeQLデフォルトセットアップスキャンを実行する曜日を設定します。
function updateCodeQLScheduleLegacy(scheduleDayOfWeek: number): Promise<CodeQLScheduleDetails>パラメーター
- scheduleDayOfWeek
-
number
整数の曜日:0=日曜日、1=月曜日、...、6=土曜日。
返品
Promise<CodeQLScheduleDetails>
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>