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 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.
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.
getBillableCommitterDetails(Date)	Obtenga todos los detalles de los confirmadores facturables, incluidos los que no coinciden con un VSID.
getBillableCommitterDetails2(Plan, Date)	Obtenga todos los detalles de los confirmadores facturables, incluidos los que no coinciden con un VSID.
getEstimatedBillablePushersDetailsForOrg()	Calcule los insertadores que se agregarían al uso del cliente si advanced Security estaba habilitado para esta organización.
getEstimatedBillablePushersDetailsForOrg2()	Calcule los insertadores que se agregarían al uso del cliente si advanced Security estaba habilitado para esta organización.
getEstimatedBillablePushersDetailsForProject(string)	Calcule los insertadores que se agregarían al uso del cliente si advanced Security estaba habilitado para este proyecto.
getEstimatedBillablePushersDetailsForProject2(string)	Calcule los insertadores que se agregarían al uso del cliente si advanced Security estaba habilitado para este proyecto.
getEstimatedOrgBillablePushers()	Calcule los confirmadores que se agregarían al uso del cliente si advanced Security estaba habilitado para esta organización.
getEstimatedOrgBillablePushers2()	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.
getEstimatedProjectBillablePushers2(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.
getEstimatedRepoBillableCommitters2(string, string)	Calcule los confirmadores que se agregarían al uso del cliente si advanced Security estaba habilitado para este repositorio.
getEstimatedRepoBillableCommittersDetails2(string, string)	Calcule los insertadores que se agregarían al uso del cliente si advanced Security estaba habilitado para este repositorio.
getEstimatedRepoBillablePushersDetails(string, string)	Calcule los insertadores que se agregarían al uso del cliente si advanced Security estaba habilitado para este repositorio.
getLastMeterUsage()
getLastMeterUsage2(Plan)
getMeterUsage(Date)	Obtiene los confirmadores que se usan al calcular la información de facturación.
getMeterUsage2(Plan, Date)	Obtiene los confirmadores que se usan al calcular la información de facturación.
getOrgEnablementStatus(boolean)	Obtener el estado actual de Advanced Security para la organización
getOrgEnablementStatus2(boolean)	Obtener el estado actual de Advanced Security para la organización
getProjectEnablementStatus(string, boolean)	Obtener el estado actual de Advanced Security para un proyecto
getProjectEnablementStatus2(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
getRepoEnablementStatus2(string, string, boolean)	Determinar si Advanced Security está habilitado para un repositorio
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	Actualización del estado de Advanced Security para la organización
updateOrgEnablementStatus2(OrgEnablementSettings)	Actualización del estado de Advanced Security para la organización
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	Actualización del estado de Advanced Security para el proyecto
updateProjectEnablementStatus2(ProjectEnablementSettings, 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
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, 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 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>

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>

getBillableCommitterDetails(Date)

Obtenga 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[]>

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[]>

getEstimatedBillablePushersDetailsForOrg()

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

function getEstimatedBillablePushersDetailsForOrg(): Promise<BilledCommitter[]>

Devoluciones

Promise<BilledCommitter[]>

getEstimatedBillablePushersDetailsForOrg2()

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

function getEstimatedBillablePushersDetailsForOrg2(): Promise<MeterUsageEstimate>

Devoluciones

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForProject(string)

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

function getEstimatedBillablePushersDetailsForProject(project: string): Promise<BilledCommitter[]>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<BilledCommitter[]>

getEstimatedBillablePushersDetailsForProject2(string)

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

function getEstimatedBillablePushersDetailsForProject2(project: string): Promise<MeterUsageEstimate>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

Devoluciones

Promise<MeterUsageEstimate>

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[]>

getEstimatedOrgBillablePushers2()

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

function getEstimatedOrgBillablePushers2(): 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[]>

getEstimatedProjectBillablePushers2(string)

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

function getEstimatedProjectBillablePushers2(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

Nombre o identificador del repositorio

Devoluciones

Promise<string[]>

getEstimatedRepoBillableCommitters2(string, string)

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

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

Parámetros

project

string

Id. de proyecto o nombre del proyecto

repository

string

Nombre o identificador del repositorio

Devoluciones

Promise<string[]>

getEstimatedRepoBillableCommittersDetails2(string, string)

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

function getEstimatedRepoBillableCommittersDetails2(project: string, repository: string): Promise<MeterUsageEstimate>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

repository

string

Devoluciones

Promise<MeterUsageEstimate>

getEstimatedRepoBillablePushersDetails(string, string)

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

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

Parámetros

project

string

Id. de proyecto o nombre del proyecto

repository

string

Devoluciones

Promise<BilledCommitter[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Devoluciones

Promise<MeterUsage>

getLastMeterUsage2(Plan)

function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>

Parámetros

plan

Plan

Devoluciones

Promise<MeterUsageForPlan>

getMeterUsage(Date)

Obtiene los confirmadores que se usan 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>

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>

getOrgEnablementStatus(boolean)

Obtener el 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 las inserciones están bloqueadas si contienen secretos.

Devoluciones

Promise<AdvSecEnablementSettings>

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>

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 las inserciones están bloqueadas si contienen secretos.

Devoluciones

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus2(string, boolean)

Obtener el estado actual de Advanced Security para un proyecto

function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

includeAllProperties

boolean

Cuando es true, determine también si las inserciones están bloqueadas si contienen secretos.

Devoluciones

Promise<ProjectEnablementSettings>

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

Nombre o identificador del repositorio

includeAllProperties

boolean

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

Devoluciones

Promise<AdvSecEnablementStatus>

getRepoEnablementStatus2(string, string, boolean)

Determinar si Advanced Security está habilitado para un repositorio

function getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>

Parámetros

project

string

Id. de proyecto o nombre del proyecto

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>

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>

updateOrgEnablementStatus2(OrgEnablementSettings)

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

function updateOrgEnablementStatus2(savedAdvSecEnablementStatus: OrgEnablementSettings): Promise<void>

Parámetros

savedAdvSecEnablementStatus

OrgEnablementSettings

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>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Actualización del estado de Advanced Security para el proyecto

function updateProjectEnablementStatus2(savedAdvSecEnablementStatus: ProjectEnablementSettings, project: string): Promise<void>

Parámetros

savedAdvSecEnablementStatus

ProjectEnablementSettings

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>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

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

function updateRepoAdvSecEnablementStatus2(savedAdvSecEnablementStatus: RepoEnablementSettings, project: string, repository: string): Promise<void>

Parámetros

savedAdvSecEnablementStatus

RepoEnablementSettings

nuevo estado

project

string

Id. de proyecto o nombre del proyecto

repository

string

Nombre o identificador del repositorio

Devoluciones

Promise<void>