ManagementRestClient class
應該用來對 VSS REST API 提出要求的基類（衍生自）
- Extends
方法
建構函式詳細資料
ManagementRestClient(IVssRestClientOptions)
方法詳細資料
createBillingSnapshot2(MeterUsageForPlan, Plan)
在主要縮放單位（EUS21）的多組織計費計算期間，此 API 會用來建立特定組織的計費快照集。主要縮放單位會針對不同 scsle 單位中的每個組織呼叫此 API，以建立計費快照集。 數據將存儲在組織特定的分區 DB - billing snapshot 表中。 這是必要的，因為客戶會從其組織特定的數據分割資料庫擷取帳單數據。
function createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>參數
- meterUsage
- MeterUsageForPlan
- plan
- Plan
傳回
Promise<void>
getAdvancedSecurityAgentPoolSelection()
取得所有可用代理池 + 目前選擇代理池的基礎網址 這是一個唯讀操作，不需要管理權限。
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[]>
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)
估計如果已啟用此存放庫的進階安全性，則會將推播程式新增至客戶的使用量。
function getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>參數
- project
-
string
Project ID 或 project 名稱
- repository
-
string
存放庫的名稱或標識碼
- plan
- Plan
要查詢的計劃。
傳回
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForOrg2(Plan)
估計如果已啟用此組織的進階安全性，則會將推播程式新增至客戶的使用量。
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
存放庫的名稱或標識碼
- includeAllProperties
-
boolean
若為 true，也會判斷偵測到秘密時是否封鎖推送
傳回
Promise<RepoEnablementSettings>
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)
針對指定的存放庫，更新程式碼安全性和秘密保護的啟用狀態及其各自的功能。
function updateRepoAdvSecEnablementStatus2(repoEnablementSettings: RepoEnablementSettings, project: string, repository: string): Promise<void>參數
- repoEnablementSettings
- RepoEnablementSettings
新地位
- project
-
string
Project ID 或 project 名稱
- repository
-
string
存放庫的名稱或標識碼
傳回
Promise<void>