ManagementRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härleds från) för att göra begäranden till VSS REST API:er

Extends

RestClientBase

Konstruktorer

ManagementRestClient(IVssRestClientOptions)

Metoder

createBillingSnapshot(MeterUsage)	Under faktureringsberäkning för flera organisationer i den primära skalningsenheten (EUS21) används det här API:et för att skapa en ögonblicksbild av faktureringen för en specifik organisation. Den primära skalningsenheten anropar det här API:et för varje organisation i olika scsle-enheter för att skapa en ögonblicksbild av faktureringen. Data lagras i den organisationsspecifika partitionsdatabasen –> ögonblicksbildtabell för fakturering. Detta behövs eftersom kunderna hämtar faktureringsdata från sin organisationsspecifika partitionsdatabas.
deleteBillingInfo(string)	Ta bort faktureringsinformationen för en organisation.
deleteMeterUsageHistory(string)	Ta bort historiken för mätarens användning från primär SU för en organisation.
getBillableCommitterDetails(Date)	Hämta all fakturerbar incheckningsinformation, inklusive de som inte matchas med ett VSID.
getBillingInfo(string)	Hämta faktureringsinformationen för en organisation.
getEstimatedOrgBillablePushers()	Uppskatta de incheckningar som skulle läggas till i kundens användning om Advanced Security aktiverades för den här organisationen.
getEstimatedProjectBillablePushers(string)	Beräkna antalet incheckningar som skulle läggas till i kundens användning om Advanced Security aktiverades för det här projektet.
getEstimatedRepoBillableCommitters(string, string)	Beräkna de incheckningar som skulle läggas till i kundens användning om Advanced Security aktiverades för den här lagringsplatsen.
getLastMeterUsage()
getMeterUsage(Date)	Hämta incheckningar som används vid beräkning av faktureringsinformation.
getOrgEnablementStatus(boolean)	Hämta aktuell status för Advanced Security för organisationen
getProjectEnablementStatus(string, boolean)	Hämta aktuell status för Advanced Security för ett projekt
getRepoEnablementStatus(string, string, boolean)	Kontrollera om Avancerad säkerhet är aktiverat för en lagringsplats
saveBillingInfo(BillingInfo, string)	Spara faktureringsinformationen för en organisation.
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	Uppdatera statusen för Avancerad säkerhet för organisationen
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	Uppdatera statusen för Advanced Security för projektet
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)	Uppdatera aktiveringen av Advanced Security för en lagringsplats

Konstruktorinformation

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Metodinformation

createBillingSnapshot(MeterUsage)

Under faktureringsberäkning för flera organisationer i den primära skalningsenheten (EUS21) används det här API:et för att skapa en ögonblicksbild av faktureringen för en specifik organisation. Den primära skalningsenheten anropar det här API:et för varje organisation i olika scsle-enheter för att skapa en ögonblicksbild av faktureringen. Data lagras i den organisationsspecifika partitionsdatabasen –> ögonblicksbildtabell för fakturering. Detta behövs eftersom kunderna hämtar faktureringsdata från sin organisationsspecifika partitionsdatabas.

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

Parametrar

meterUsage

MeterUsage

Returer

Promise<void>

deleteBillingInfo(string)

Ta bort faktureringsinformationen för en organisation.

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

Parametrar

organizationId

string

Returer

Promise<void>

deleteMeterUsageHistory(string)

Ta bort historiken för mätarens användning från primär SU för en organisation.

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

Parametrar

organizationId

string

Returer

Promise<void>

getBillableCommitterDetails(Date)

Hämta all fakturerbar incheckningsinformation, inklusive de som inte matchas med ett VSID.

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

Parametrar

billingDate

Date

Datum för att fråga, eller om det inte anges, i dag

Returer

Promise<BillableCommitterDetails[]>

getBillingInfo(string)

Hämta faktureringsinformationen för en organisation.

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

Parametrar

organizationId

string

Organisations-ID att hämta faktureringsinformation för.

Returer

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

Uppskatta de incheckningar som skulle läggas till i kundens användning om Advanced Security aktiverades för den här organisationen.

function getEstimatedOrgBillablePushers(): Promise<string[]>

Returer

Promise<string[]>

getEstimatedProjectBillablePushers(string)

Beräkna antalet incheckningar som skulle läggas till i kundens användning om Advanced Security aktiverades för det här projektet.

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

Parametrar

project

string

Projekt-ID eller projektnamn

Returer

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

Beräkna de incheckningar som skulle läggas till i kundens användning om Advanced Security aktiverades för den här lagringsplatsen.

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

Lagringsplatsens namn eller ID

Returer

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Returer

Promise<MeterUsage>

getMeterUsage(Date)

Hämta incheckningar som används vid beräkning av faktureringsinformation.

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

Parametrar

billingDate

Date

Datum för att fråga, eller om det inte anges, i dag

Returer

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

Hämta aktuell status för Advanced Security för organisationen

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

Parametrar

includeAllProperties

boolean

När det är sant kontrollerar du också om push-meddelanden blockeras om de innehåller hemligheter

Returer

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus(string, boolean)

Hämta aktuell status för Advanced Security för ett projekt

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

Parametrar

project

string

Projekt-ID eller projektnamn

includeAllProperties

boolean

När det är sant kontrollerar du också om push-meddelanden blockeras om de innehåller hemligheter

Returer

Promise<AdvSecEnablementSettings>

getRepoEnablementStatus(string, string, boolean)

Kontrollera om Avancerad säkerhet är aktiverat för en lagringsplats

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

Lagringsplatsens namn eller ID

includeAllProperties

boolean

När det är sant avgör även om push-meddelanden blockeras när hemligheter identifieras

Returer

Promise<AdvSecEnablementStatus>

saveBillingInfo(BillingInfo, string)

Spara faktureringsinformationen för en organisation.

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

Parametrar

billingInfo

BillingInfo

organizationId

string

Returer

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

Uppdatera statusen för Avancerad säkerhet för organisationen

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

Parametrar

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Den nya statusen

Returer

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

Uppdatera statusen för Advanced Security för projektet

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

Parametrar

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Den nya statusen

project

string

Projekt-ID eller projektnamn

Returer

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

Uppdatera aktiveringen av Advanced Security för en lagringsplats

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

Parametrar

savedAdvSecEnablementStatus

AdvSecEnablementStatusUpdate

ny status

project

string

Projekt-ID eller projektnamn

repository

string

Namn eller ID för lagringsplatsen

Returer

Promise<void>