ManagementRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends

RestClientBase

Constructors

ManagementRestClient(IVssRestClientOptions)

Methoden

createBillingSnapshot(MeterUsage)	Tijdens de berekening van facturering voor meerdere organisaties in primaire schaaleenheid (EUS21) wordt deze API gebruikt om een momentopname van facturering voor een specifieke organisatie te maken. Primaire schaaleenheid roept deze API aan voor elke organisatie in verschillende scsle-eenheden om een momentopname van facturering te maken. Gegevens worden opgeslagen in de tabel met momentopnamen van de organisatiespecifieke partitie DB -> facturering. Dit is nodig omdat klanten factureringsgegevens ophalen uit hun organisatiespecifieke partitiedatabase.
deleteBillingInfo(string)	Verwijder de factureringsgegevens voor een organisatie.
deleteMeterUsageHistory(string)	Verwijder de gebruiksgeschiedenis van de meter uit primaire SU voor een organisatie.
getBillableCommitterDetails(Date)	Alle factureerbare doorvoergegevens ophalen, inclusief de gegevens die niet overeenkomen met een VSID.
getBillingInfo(string)	De factureringsgegevens voor een organisatie ophalen.
getEstimatedOrgBillablePushers()	Schat de committers die worden toegevoegd aan het gebruik van de klant als Geavanceerde beveiliging is ingeschakeld voor deze organisatie.
getEstimatedProjectBillablePushers(string)	Schat het aantal committers dat wordt toegevoegd aan het gebruik van de klant als Advanced Security is ingeschakeld voor dit project.
getEstimatedRepoBillableCommitters(string, string)	Schat de committers die worden toegevoegd aan het gebruik van de klant als Geavanceerde beveiliging is ingeschakeld voor deze opslagplaats.
getLastMeterUsage()
getMeterUsage(Date)	Haal commiters op die worden gebruikt bij het berekenen van factureringsgegevens.
getOrgEnablementStatus(boolean)	De huidige status van Geavanceerde beveiliging voor de organisatie ophalen
getProjectEnablementStatus(string, boolean)	De huidige status van Geavanceerde beveiliging voor een project ophalen
getRepoEnablementStatus(string, string, boolean)	Bepalen of Geavanceerde beveiliging is ingeschakeld voor een opslagplaats
saveBillingInfo(BillingInfo, string)	Sla de factureringsgegevens voor een organisatie op.
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	De status van Geavanceerde beveiliging voor de organisatie bijwerken
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	De status van Geavanceerde beveiliging voor het project bijwerken
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)	De inschakeling van geavanceerde beveiliging voor een opslagplaats bijwerken

Constructordetails

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Methodedetails

createBillingSnapshot(MeterUsage)

Tijdens de berekening van facturering voor meerdere organisaties in primaire schaaleenheid (EUS21) wordt deze API gebruikt om een momentopname van facturering voor een specifieke organisatie te maken. Primaire schaaleenheid roept deze API aan voor elke organisatie in verschillende scsle-eenheden om een momentopname van facturering te maken. Gegevens worden opgeslagen in de tabel met momentopnamen van de organisatiespecifieke partitie DB -> facturering. Dit is nodig omdat klanten factureringsgegevens ophalen uit hun organisatiespecifieke partitiedatabase.

function createBillingSnapshot(meterUsage: MeterUsage): Promise<void>

Parameters

meterUsage

MeterUsage

Retouren

Promise<void>

deleteBillingInfo(string)

Verwijder de factureringsgegevens voor een organisatie.

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

Parameters

organizationId

string

Retouren

Promise<void>

deleteMeterUsageHistory(string)

Verwijder de gebruiksgeschiedenis van de meter uit primaire SU voor een organisatie.

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

Parameters

organizationId

string

Retouren

Promise<void>

getBillableCommitterDetails(Date)

Alle factureerbare doorvoergegevens ophalen, inclusief de gegevens die niet overeenkomen met een VSID.

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

Parameters

billingDate

Date

De datum waarop vandaag een query moet worden uitgevoerd, of indien niet opgegeven

Retouren

Promise<BillableCommitterDetails[]>

getBillingInfo(string)

De factureringsgegevens voor een organisatie ophalen.

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

Parameters

organizationId

string

Organisatie-id om factureringsgegevens voor op te halen.

Retouren

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

Schat de committers die worden toegevoegd aan het gebruik van de klant als Geavanceerde beveiliging is ingeschakeld voor deze organisatie.

function getEstimatedOrgBillablePushers(): Promise<string[]>

Retouren

Promise<string[]>

getEstimatedProjectBillablePushers(string)

Schat het aantal committers dat wordt toegevoegd aan het gebruik van de klant als Advanced Security is ingeschakeld voor dit project.

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

Parameters

project

string

Project-id of projectnaam

Retouren

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

Schat de committers die worden toegevoegd aan het gebruik van de klant als Geavanceerde beveiliging is ingeschakeld voor deze opslagplaats.

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

Parameters

project

string

Project-id of projectnaam

repository

string

De naam of id van de opslagplaats

Retouren

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Retouren

Promise<MeterUsage>

getMeterUsage(Date)

Haal commiters op die worden gebruikt bij het berekenen van factureringsgegevens.

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

Parameters

billingDate

Date

De datum waarop vandaag een query moet worden uitgevoerd, of indien niet opgegeven

Retouren

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

De huidige status van Geavanceerde beveiliging voor de organisatie ophalen

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

Parameters

includeAllProperties

boolean

Wanneer waar, bepaalt u ook of pushes worden geblokkeerd als ze geheimen bevatten

Retouren

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus(string, boolean)

De huidige status van Geavanceerde beveiliging voor een project ophalen

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

Parameters

project

string

Project-id of projectnaam

includeAllProperties

boolean

Wanneer waar, bepaalt u ook of pushes worden geblokkeerd als ze geheimen bevatten

Retouren

Promise<AdvSecEnablementSettings>

getRepoEnablementStatus(string, string, boolean)

Bepalen of Geavanceerde beveiliging is ingeschakeld voor een opslagplaats

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

Parameters

project

string

Project-id of projectnaam

repository

string

De naam of id van de opslagplaats

includeAllProperties

boolean

Wanneer waar, wordt ook bepaald of pushes worden geblokkeerd wanneer geheimen worden gedetecteerd

Retouren

Promise<AdvSecEnablementStatus>

saveBillingInfo(BillingInfo, string)

Sla de factureringsgegevens voor een organisatie op.

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

Parameters

billingInfo

BillingInfo

organizationId

string

Retouren

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

De status van Geavanceerde beveiliging voor de organisatie bijwerken

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

Parameters

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

De nieuwe status

Retouren

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

De status van Geavanceerde beveiliging voor het project bijwerken

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

Parameters

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

De nieuwe status

project

string

Project-id of projectnaam

Retouren

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

De inschakeling van geavanceerde beveiliging voor een opslagplaats bijwerken

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

Parameters

savedAdvSecEnablementStatus

AdvSecEnablementStatusUpdate

nieuwe status

project

string

Project-id of projectnaam

repository

string

Naam of id van de opslagplaats

Retouren

Promise<void>