ManagementRestClient class

Paquete:

azure-devops-extension-api

Clase base que se debe usar (derivada de) para realizar solicitudes a las API REST de VSS

Extends

RestClientBase

Constructores

ManagementRestClient(IVssRestClientOptions)

Métodos

createBillingSnapshot(MeterUsage)	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 de 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.
deleteBillingInfo(string)	Elimine la información de facturación de una organización.
deleteMeterUsageHistory(string)	Elimine el historial de uso del medidor de la su principal de una organización.
getBillableCommitterDetails(Date)	Obtiene todos los detalles de los confirmadores facturables, incluidos los que no coinciden con un VSID.
getBillingInfo(string)	Obtenga la información de facturación de una organización.
getEstimatedOrgBillablePushers()	Calcule los confirmadores que se agregarían al uso del cliente si advanced Security estaba habilitado para esta organización.
getEstimatedProjectBillablePushers(string)	Calcule el número de confirmadores que se agregarían al uso del cliente si advanced Security estaba habilitado para este proyecto.
getEstimatedRepoBillableCommitters(string, string)	Calcule los confirmadores que se agregarían al uso del cliente si advanced Security estaba habilitado para este repositorio.
getLastMeterUsage()
getMeterUsage(Date)	Obtiene los confirmadores usados al calcular la información de facturación.
getOrgEnablementStatus(boolean)	Obtención del estado actual de Advanced Security para la organización
getProjectEnablementStatus(string, boolean)	Obtener el estado actual de Advanced Security para un proyecto
getRepoEnablementStatus(string, string, boolean)	Determinar si Advanced Security está habilitado para un repositorio
saveBillingInfo(BillingInfo, string)	Guarde la información de facturación de una organización.
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	Actualización del estado de Advanced Security para la organización
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	Actualización del estado de Advanced Security para el proyecto
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)	Actualización de la habilitación de Advanced Security para un repositorio

Detalles del constructor

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parámetros

options

IVssRestClientOptions

Detalles del método

createBillingSnapshot(MeterUsage)

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 de 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 createBillingSnapshot(meterUsage: MeterUsage): Promise<void>

Parámetros

meterUsage

MeterUsage

Devoluciones

Promise<void>

deleteBillingInfo(string)

Elimine la información de facturación de una organización.

function deleteBillingInfo(organizationId: string): Promise<void>

Parámetros

organizationId

string

Devoluciones

Promise<void>

deleteMeterUsageHistory(string)

Elimine el historial de uso del medidor de la su principal de una organización.

function deleteMeterUsageHistory(organizationId: string): Promise<void>

Parámetros

organizationId

string

Devoluciones

Promise<void>

getBillableCommitterDetails(Date)

Obtiene todos los detalles de los confirmadores facturables, incluidos los que no coinciden con un VSID.

function getBillableCommitterDetails(billingDate?: Date): Promise<BillableCommitterDetails[]>

Parámetros

billingDate

Date

Fecha de consulta, o si no se proporciona, hoy

Devoluciones

Promise<BillableCommitterDetails[]>

getBillingInfo(string)

Obtenga la información de facturación de una organización.

function getBillingInfo(organizationId: string): Promise<BillingInfo>

Parámetros

organizationId

string

Id. de organización para el que se obtiene información de facturación.

Devoluciones

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

Calcule los confirmadores que se agregarían al uso del cliente si advanced Security estaba habilitado para esta organización.

function getEstimatedOrgBillablePushers(): Promise<string[]>

Devoluciones

Promise<string[]>

getEstimatedProjectBillablePushers(string)

Calcule el número de confirmadores que se agregarían al uso del cliente si advanced Security estaba habilitado para este proyecto.

function getEstimatedProjectBillablePushers(project: string): Promise<string[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

Calcule los confirmadores que se agregarían al uso del cliente si advanced Security estaba habilitado para este repositorio.

function getEstimatedRepoBillableCommitters(project: string, repository: string): Promise<string[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

repository

string

El nombre o el identificador del repositorio

Devoluciones

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Devoluciones

Promise<MeterUsage>

getMeterUsage(Date)

Obtiene los confirmadores usados al calcular la información de facturación.

function getMeterUsage(billingDate?: Date): Promise<MeterUsage>

Parámetros

billingDate

Date

Fecha de consulta, o si no se proporciona, hoy

Devoluciones

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

Obtención del estado actual de Advanced Security para la organización

function getOrgEnablementStatus(includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>

Parámetros

includeAllProperties

boolean

Cuando es true, determine también si se bloquean las inserciones si contienen secretos.

Devoluciones

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus(string, boolean)

Obtener el estado actual de Advanced Security para un proyecto

function getProjectEnablementStatus(project: string, includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

includeAllProperties

boolean

Cuando es true, determine también si se bloquean las inserciones si contienen secretos.

Devoluciones

Promise<AdvSecEnablementSettings>

getRepoEnablementStatus(string, string, boolean)

Determinar si Advanced Security está habilitado para un repositorio

function getRepoEnablementStatus(project: string, repository: string, includeAllProperties?: boolean): Promise<AdvSecEnablementStatus>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

repository

string

El nombre o el identificador del repositorio

includeAllProperties

boolean

Cuando sea true, también determinará si se bloquean las inserciones cuando se detectan secretos.

Devoluciones

Promise<AdvSecEnablementStatus>

saveBillingInfo(BillingInfo, string)

Guarde la información de facturación de una organización.

function saveBillingInfo(billingInfo: BillingInfo, organizationId: string): Promise<void>

Parámetros

billingInfo

BillingInfo

organizationId

string

Devoluciones

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

Actualización del estado de Advanced Security para la organización

function updateOrgEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate): Promise<void>

Parámetros

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Nuevo estado

Devoluciones

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

Actualización del estado de Advanced Security para el proyecto

function updateProjectEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate, project: string): Promise<void>

Parámetros

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Nuevo estado

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

Actualización de la habilitación de Advanced Security para un repositorio

function updateRepoAdvSecEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementStatusUpdate, project: string, repository: string): Promise<void>

Parámetros

savedAdvSecEnablementStatus

AdvSecEnablementStatusUpdate

nuevo estado

project

string

Id. de proyecto o nombre del proyecto

repository

string

Nombre o identificador del repositorio

Devoluciones

Promise<void>