ManagementRestClient class
Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS
- Extends
Constructores
| Management |
Métodos
| create |
Durante el cálculo de facturación de varias organizaciones en la unidad de escalado principal (EUS21), esta API se usa para crear una instantánea de facturación para una organización específica. La unidad de escalado principal llamará a esta API para cada organización en diferentes unidades scsle para crear una instantánea de facturación. Los datos se almacenarán en la base de datos de partición específica de la organización: tabla de instantáneas de facturación. Esto es necesario, ya que los clientes capturarán los datos de facturación de su base de datos de partición específica de la organización. |
| get |
URL base para obtener todos los pools de agentes disponibles + pool de agentes seleccionados actualmente Esta es una operación de solo lectura que no requiere permisos de gestión. |
| get |
Obtenga todos los detalles de los confirmadores facturables, incluidos los que no coinciden con un VSID. |
| get |
Calcule los insertadores que se agregarían al uso del cliente si advanced Security estaba habilitado para este repositorio. |
| get |
Calcule los insertadores que se agregarían al uso del cliente si advanced Security estaba habilitado para esta organización. |
| get |
Estima los pushers que se añadirían al uso del cliente si se activara la Seguridad Avanzada para este proyecto. |
| get |
|
| get |
Obtiene los confirmadores que se usan al calcular la información de facturación. |
| get |
Obtener el estado actual de Advanced Security para la organización |
| get |
Obtén el estado actual de Seguridad Avanzada para un proyecto |
| get |
Determina si la seguridad del código, la protección secreta y sus características están habilitadas para el repositorio. |
| update |
Actualizaciones Valor del Registro del Pool de Agentes Para el Pool de Agentes Seleccionado Esto utiliza automáticamente el cliente http subyacente para los pools de agentes para validar que el usuario tiene permisos para usar ese pool |
| update |
Actualización del estado de Advanced Security para la organización |
| update |
Actualizar el estado de Seguridad Avanzada para el proyecto |
| update |
Actualice el estado de habilitación de Seguridad de código y protección de secretos, junto con sus respectivas características, para un repositorio determinado. |
Detalles del constructor
ManagementRestClient(IVssRestClientOptions)
Detalles del método
createBillingSnapshot2(MeterUsageForPlan, Plan)
Durante el cálculo de facturación de varias organizaciones en la unidad de escalado principal (EUS21), esta API se usa para crear una instantánea de facturación para una organización específica. La unidad de escalado principal llamará a esta API para cada organización en diferentes unidades scsle para crear una instantánea de facturación. Los datos se almacenarán en la base de datos de partición específica de la organización: tabla de instantáneas de facturación. Esto es necesario, ya que los clientes capturarán los datos de facturación de su base de datos de partición específica de la organización.
function createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>
Parámetros
- meterUsage
- MeterUsageForPlan
- plan
- Plan
Devoluciones
Promise<void>
getAdvancedSecurityAgentPoolSelection()
URL base para obtener todos los pools de agentes disponibles + pool de agentes seleccionados actualmente Esta es una operación de solo lectura que no requiere permisos de gestión.
function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>
Devoluciones
Promise<AgentPoolDetails>
getBillableCommitterDetails2(Plan, Date)
Obtenga todos los detalles de los confirmadores facturables, incluidos los que no coinciden con un VSID.
function getBillableCommitterDetails2(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>
Parámetros
- plan
- Plan
Plan que se va a consultar. Planes admitidos: CodeSecurity y SecretProtection. Este parámetro es obligatorio.
- billingDate
-
Date
Fecha de consulta, o si no se proporciona, hoy
Devoluciones
Promise<BillableCommitterDetails[]>
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)
Calcule los insertadores que se agregarían al uso del cliente si advanced Security estaba habilitado para este repositorio.
function getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>
Parámetros
- project
-
string
ID del Project o nombre del project
- repository
-
string
Nombre o identificador del repositorio
- plan
- Plan
Plan que se va a consultar.
Devoluciones
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForOrg2(Plan)
Calcule los insertadores que se agregarían al uso del cliente si advanced Security estaba habilitado para esta organización.
function getEstimatedBillablePushersDetailsForOrg2(plan?: Plan): Promise<MeterUsageEstimate>
Parámetros
- plan
- Plan
Plan que se va a consultar.
Devoluciones
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject2(string, Plan)
Estima los pushers que se añadirían al uso del cliente si se activara la Seguridad Avanzada para este proyecto.
function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>
Parámetros
- project
-
string
ID del Project o nombre del project
- plan
- Plan
Devoluciones
Promise<MeterUsageEstimate>
getLastMeterUsage2(Plan)
function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>
Parámetros
- plan
- Plan
Devoluciones
Promise<MeterUsageForPlan>
getMeterUsage2(Plan, Date)
Obtiene los confirmadores que se usan al calcular la información de facturación.
function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>
Parámetros
- plan
- Plan
Plan que se va a consultar. Planes admitidos: CodeSecurity y SecretProtection. Este parámetro es obligatorio.
- billingDate
-
Date
Fecha de consulta, o si no se proporciona, hoy
Devoluciones
Promise<MeterUsageForPlan>
getOrgEnablementStatus2(boolean)
Obtener el estado actual de Advanced Security para la organización
function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>
Parámetros
- includeAllProperties
-
boolean
Cuando es true, determine también si las inserciones están bloqueadas si contienen secretos.
Devoluciones
Promise<OrgEnablementSettings>
getProjectEnablementStatus2(string, boolean)
Obtén el estado actual de Seguridad Avanzada para un proyecto
function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>
Parámetros
- project
-
string
ID del Project o nombre del project
- includeAllProperties
-
boolean
Cuando es true, determine también si las inserciones están bloqueadas si contienen secretos.
Devoluciones
Promise<ProjectEnablementSettings>
getRepoEnablementStatus2(string, string, boolean)
Determina si la seguridad del código, la protección secreta y sus características están habilitadas para el repositorio.
function getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>
Parámetros
- project
-
string
ID del Project o nombre del project
- repository
-
string
Nombre o identificador del repositorio
- includeAllProperties
-
boolean
Cuando sea true, también determinará si las inserciones se bloquean cuando se detectan secretos.
Devoluciones
Promise<RepoEnablementSettings>
updateAdvancedSecurityAgentPoolSelection(string)
Actualizaciones Valor del Registro del Pool de Agentes Para el Pool de Agentes Seleccionado Esto utiliza automáticamente el cliente http subyacente para los pools de agentes para validar que el usuario tiene permisos para usar ese pool
function updateAdvancedSecurityAgentPoolSelection(agentPoolName: string): Promise<AgentPoolDetails>
Parámetros
- agentPoolName
-
string
Devoluciones
Promise<AgentPoolDetails>
updateOrgEnablementStatus2(OrgEnablementSettings)
Actualización del estado de Advanced Security para la organización
function updateOrgEnablementStatus2(orgEnablementSettings: OrgEnablementSettings): Promise<void>
Parámetros
- orgEnablementSettings
- OrgEnablementSettings
Nuevo estado
Devoluciones
Promise<void>
updateProjectEnablementStatus2(ProjectEnablementSettings, string)
Actualizar el estado de Seguridad Avanzada para el proyecto
function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>
Parámetros
- projectEnablementSettings
- ProjectEnablementSettings
Nuevo estado
- project
-
string
ID del Project o nombre del project
Devoluciones
Promise<void>
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)
Actualice el estado de habilitación de Seguridad de código y protección de secretos, junto con sus respectivas características, para un repositorio determinado.
function updateRepoAdvSecEnablementStatus2(repoEnablementSettings: RepoEnablementSettings, project: string, repository: string): Promise<void>
Parámetros
- repoEnablementSettings
- RepoEnablementSettings
nuevo estado
- project
-
string
ID del Project o nombre del project
- repository
-
string
Nombre o identificador del repositorio
Devoluciones
Promise<void>