ManagementRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST služby VSS

Extends

RestClientBase

Konstruktory

ManagementRestClient(IVssRestClientOptions)

Metody

createBillingSnapshot(MeterUsage)	Během výpočtu fakturace pro více organizací v primární jednotce škálování (EUS21) se toto rozhraní API používá k vytvoření snímku fakturace pro konkrétní organizaci. Primární jednotka škálování bude toto rozhraní API volat pro každou organizaci v různých jednotkách scsle, aby se vytvořil snímek fakturace. Data se budou ukládat do databáze oddílů specifické pro organizaci –> tabulka snímků fakturace. To je potřeba, protože zákazníci budou načítat fakturační data ze své databáze oddílů specifické pro organizaci.
deleteBillingInfo(string)	Odstraňte fakturační údaje pro organizaci.
deleteMeterUsageHistory(string)	Odstraňte historii využití měřičů z primární SU pro organizaci.
getBillableCommitterDetails(Date)	Získejte všechny podrobnosti o fakturovatelných potvrzeních, včetně těch, které nejsou spárované s VSID.
getBillingInfo(string)	Získejte fakturační údaje pro organizaci.
getEstimatedOrgBillablePushers()	Odhadněte potvrzení, která by se přidala k využití zákazníka, pokud by bylo pro tuto organizaci povolené rozšířené zabezpečení.
getEstimatedProjectBillablePushers(string)	Odhadněte počet potvrzení, které by se přidaly k využití zákazníka, pokud by bylo pro tento projekt povolené rozšířené zabezpečení.
getEstimatedRepoBillableCommitters(string, string)	Odhadněte potvrzení, která by se přidala k využití zákazníka, pokud by pro toto úložiště bylo povolené rozšířené zabezpečení.
getLastMeterUsage()
getMeterUsage(Date)	Získejte potvrzení, které se používají při výpočtu fakturačních údajů.
getOrgEnablementStatus(boolean)	Získání aktuálního stavu rozšířeného zabezpečení pro organizaci
getProjectEnablementStatus(string, boolean)	Zjištění aktuálního stavu rozšířeného zabezpečení projektu
getRepoEnablementStatus(string, string, boolean)	Určení, jestli je pro úložiště povolené rozšířené zabezpečení
saveBillingInfo(BillingInfo, string)	Uložení fakturačních údajů pro organizaci
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	Aktualizace stavu rozšířeného zabezpečení pro organizaci
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	Aktualizace stavu rozšířeného zabezpečení projektu
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)	Aktualizace povolení rozšířeného zabezpečení pro úložiště

Podrobnosti konstruktoru

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti metody

createBillingSnapshot(MeterUsage)

Během výpočtu fakturace pro více organizací v primární jednotce škálování (EUS21) se toto rozhraní API používá k vytvoření snímku fakturace pro konkrétní organizaci. Primární jednotka škálování bude toto rozhraní API volat pro každou organizaci v různých jednotkách scsle, aby se vytvořil snímek fakturace. Data se budou ukládat do databáze oddílů specifické pro organizaci –> tabulka snímků fakturace. To je potřeba, protože zákazníci budou načítat fakturační data ze své databáze oddílů specifické pro organizaci.

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

Parametry

meterUsage

MeterUsage

Návraty

Promise<void>

deleteBillingInfo(string)

Odstraňte fakturační údaje pro organizaci.

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

Parametry

organizationId

string

Návraty

Promise<void>

deleteMeterUsageHistory(string)

Odstraňte historii využití měřičů z primární SU pro organizaci.

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

Parametry

organizationId

string

Návraty

Promise<void>

getBillableCommitterDetails(Date)

Získejte všechny podrobnosti o fakturovatelných potvrzeních, včetně těch, které nejsou spárované s VSID.

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

Parametry

billingDate

Date

Datum, které se má dotazovat, nebo pokud není zadané, dnes

Návraty

Promise<BillableCommitterDetails[]>

getBillingInfo(string)

Získejte fakturační údaje pro organizaci.

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

Parametry

organizationId

string

ID organizace, pro které chcete získat fakturační údaje.

Návraty

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

Odhadněte potvrzení, která by se přidala k využití zákazníka, pokud by bylo pro tuto organizaci povolené rozšířené zabezpečení.

function getEstimatedOrgBillablePushers(): Promise<string[]>

Návraty

Promise<string[]>

getEstimatedProjectBillablePushers(string)

Odhadněte počet potvrzení, které by se přidaly k využití zákazníka, pokud by bylo pro tento projekt povolené rozšířené zabezpečení.

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

Parametry

project

string

ID projektu nebo název projektu

Návraty

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

Odhadněte potvrzení, která by se přidala k využití zákazníka, pokud by pro toto úložiště bylo povolené rozšířené zabezpečení.

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

Parametry

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště

Návraty

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Návraty

Promise<MeterUsage>

getMeterUsage(Date)

Získejte potvrzení, které se používají při výpočtu fakturačních údajů.

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

Parametry

billingDate

Date

Datum, které se má dotazovat, nebo pokud není zadané, dnes

Návraty

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

Získání aktuálního stavu rozšířeného zabezpečení pro organizaci

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

Parametry

includeAllProperties

boolean

Pokud je hodnota true, určete také, jestli jsou nabízená oznámení blokovaná, pokud obsahují tajné kódy.

Návraty

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus(string, boolean)

Zjištění aktuálního stavu rozšířeného zabezpečení projektu

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

Parametry

project

string

ID projektu nebo název projektu

includeAllProperties

boolean

Pokud je hodnota true, určete také, jestli jsou nabízená oznámení blokovaná, pokud obsahují tajné kódy.

Návraty

Promise<AdvSecEnablementSettings>

getRepoEnablementStatus(string, string, boolean)

Určení, jestli je pro úložiště povolené rozšířené zabezpečení

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

Parametry

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště

includeAllProperties

boolean

Pokud je hodnota true, nástroj také určí, jestli se při zjištění tajných kódů zablokují nabízená oznámení.

Návraty

Promise<AdvSecEnablementStatus>

saveBillingInfo(BillingInfo, string)

Uložení fakturačních údajů pro organizaci

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

Parametry

billingInfo

BillingInfo

organizationId

string

Návraty

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

Aktualizace stavu rozšířeného zabezpečení pro organizaci

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

Parametry

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Nový stav

Návraty

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

Aktualizace stavu rozšířeného zabezpečení projektu

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

Parametry

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Nový stav

project

string

ID projektu nebo název projektu

Návraty

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

Aktualizace povolení rozšířeného zabezpečení pro úložiště

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

Parametry

savedAdvSecEnablementStatus

AdvSecEnablementStatusUpdate

nový stav

project

string

ID projektu nebo název projektu

repository

string

Název nebo ID úložiště

Návraty

Promise<void>