ManagementRestClient class
Base class that should be used (derived from) to make requests to VSS REST apis
- Extends
Constructors
| Management |
Methods
| create |
During multi-org billing computation in primary scale unit(EUS21), this API is used to create billing snapshot for a specific org. Primary scale unit will call this API for each org in different scsle units to create billing snapshot. Data will be stored in the org specific partition DB -> billing snapshot table. This is needed as customers will fetch billing data from their org specific partition DB. |
| get |
Base URL for getting All Available Agent Pools + Currently Selected Agent Pool This is a read-only operation that does not require manage permissions. |
| get |
Get all billable committers details, including those not matched with a VSID. |
| get |
Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this repository. |
| get |
Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this organization. |
| get |
Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this project. |
| get |
|
| get |
Get commiters used when calculating billing information. |
| get |
Get the current status of Advanced Security for the organization |
| get |
Get the current status of Advanced Security for a project |
| get |
Determines if Code Security, Secret Protection, and their features are enabled for the repository. |
| update |
Updates Agent Pool Registry Value For the Selected Agent Pool This automatically uses the underlying http client for agent pools to validate that the user has permissions to use that pool |
| update |
Update the status of Advanced Security for the organization |
| update |
Update the status of Advanced Security for the project |
| update |
Update the enablement status of Code Security and Secret Protection, along with their respective features, for a given repository. |
Constructor Details
ManagementRestClient(IVssRestClientOptions)
Method Details
createBillingSnapshot2(MeterUsageForPlan, Plan)
During multi-org billing computation in primary scale unit(EUS21), this API is used to create billing snapshot for a specific org. Primary scale unit will call this API for each org in different scsle units to create billing snapshot. Data will be stored in the org specific partition DB -> billing snapshot table. This is needed as customers will fetch billing data from their org specific partition DB.
function createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>
Parameters
- meterUsage
- MeterUsageForPlan
- plan
- Plan
Returns
Promise<void>
getAdvancedSecurityAgentPoolSelection()
Base URL for getting All Available Agent Pools + Currently Selected Agent Pool This is a read-only operation that does not require manage permissions.
function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>
Returns
Promise<AgentPoolDetails>
getBillableCommitterDetails2(Plan, Date)
Get all billable committers details, including those not matched with a VSID.
function getBillableCommitterDetails2(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>
Parameters
- plan
- Plan
The plan to query. Plans supported: CodeSecurity and SecretProtection. This is a mandatory parameter.
- billingDate
-
Date
The date to query, or if not provided, today
Returns
Promise<BillableCommitterDetails[]>
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)
Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this repository.
function getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>
Parameters
- project
-
string
Project ID or project name
- repository
-
string
The name or ID of the repository
- plan
- Plan
The plan to query.
Returns
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForOrg2(Plan)
Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this organization.
function getEstimatedBillablePushersDetailsForOrg2(plan?: Plan): Promise<MeterUsageEstimate>
Parameters
- plan
- Plan
The plan to query.
Returns
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject2(string, Plan)
Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this project.
function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>
Parameters
- project
-
string
Project ID or project name
- plan
- Plan
Returns
Promise<MeterUsageEstimate>
getLastMeterUsage2(Plan)
function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>
Parameters
- plan
- Plan
Returns
Promise<MeterUsageForPlan>
getMeterUsage2(Plan, Date)
Get commiters used when calculating billing information.
function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>
Parameters
- plan
- Plan
The plan to query. Plans supported: CodeSecurity and SecretProtection. This is a mandatory parameter.
- billingDate
-
Date
The date to query, or if not provided, today
Returns
Promise<MeterUsageForPlan>
getOrgEnablementStatus2(boolean)
Get the current status of Advanced Security for the organization
function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>
Parameters
- includeAllProperties
-
boolean
When true, also determine if pushes are blocked if they contain secrets
Returns
Promise<OrgEnablementSettings>
getProjectEnablementStatus2(string, boolean)
Get the current status of Advanced Security for a project
function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>
Parameters
- project
-
string
Project ID or project name
- includeAllProperties
-
boolean
When true, also determine if pushes are blocked if they contain secrets
Returns
Promise<ProjectEnablementSettings>
getRepoEnablementStatus2(string, string, boolean)
Determines if Code Security, Secret Protection, and their features are enabled for the repository.
function getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>
Parameters
- project
-
string
Project ID or project name
- repository
-
string
The name or ID of the repository
- includeAllProperties
-
boolean
When true, will also determine if pushes are blocked when secrets are detected
Returns
Promise<RepoEnablementSettings>
updateAdvancedSecurityAgentPoolSelection(string)
Updates Agent Pool Registry Value For the Selected Agent Pool This automatically uses the underlying http client for agent pools to validate that the user has permissions to use that pool
function updateAdvancedSecurityAgentPoolSelection(agentPoolName: string): Promise<AgentPoolDetails>
Parameters
- agentPoolName
-
string
Returns
Promise<AgentPoolDetails>
updateOrgEnablementStatus2(OrgEnablementSettings)
Update the status of Advanced Security for the organization
function updateOrgEnablementStatus2(orgEnablementSettings: OrgEnablementSettings): Promise<void>
Parameters
- orgEnablementSettings
- OrgEnablementSettings
The new status
Returns
Promise<void>
updateProjectEnablementStatus2(ProjectEnablementSettings, string)
Update the status of Advanced Security for the project
function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>
Parameters
- projectEnablementSettings
- ProjectEnablementSettings
The new status
- project
-
string
Project ID or project name
Returns
Promise<void>
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)
Update the enablement status of Code Security and Secret Protection, along with their respective features, for a given repository.
function updateRepoAdvSecEnablementStatus2(repoEnablementSettings: RepoEnablementSettings, project: string, repository: string): Promise<void>
Parameters
- repoEnablementSettings
- RepoEnablementSettings
new status
- project
-
string
Project ID or project name
- repository
-
string
Name or ID of the repository
Returns
Promise<void>