ManagementRestClient class

Pacchetto:

azure-devops-extension-api

Classe di base che deve essere usata (derivata da) per effettuare richieste alle API REST di VSS

Extends

RestClientBase

Costruttori

ManagementRestClient(IVssRestClientOptions)

Metodi

createBillingSnapshot(MeterUsage)	Durante il calcolo della fatturazione multi-organizzazione nell'unità di scalabilità primaria (EUS21), questa API viene usata per creare uno snapshot di fatturazione per un'organizzazione specifica. L'unità di scalabilità primaria chiamerà questa API per ogni organizzazione in unità scsle diverse per creare uno snapshot di fatturazione. I dati verranno archiviati nel database di partizione specifico dell'organizzazione -> tabella snapshot di fatturazione. Questa operazione è necessaria perché i clienti recuperano i dati di fatturazione dal database di partizione specifico dell'organizzazione.
deleteBillingInfo(string)	Eliminare le informazioni di fatturazione per un'organizzazione.
deleteMeterUsageHistory(string)	Eliminare la cronologia di utilizzo del contatore da SU primario per un'organizzazione.
getBillableCommitterDetails(Date)	Ottenere tutti i dettagli dei commitable fatturabili, inclusi quelli non corrispondenti a un VSID.
getBillingInfo(string)	Ottenere le informazioni di fatturazione per un'organizzazione.
getEstimatedOrgBillablePushers()	Stimare i commiter che verranno aggiunti all'utilizzo del cliente se la sicurezza avanzata è stata abilitata per questa organizzazione.
getEstimatedProjectBillablePushers(string)	Stimare il numero di commiter che verranno aggiunti all'utilizzo del cliente se la sicurezza avanzata è stata abilitata per questo progetto.
getEstimatedRepoBillableCommitters(string, string)	Stimare i commiter che verranno aggiunti all'utilizzo del cliente se la sicurezza avanzata è stata abilitata per questo repository.
getLastMeterUsage()
getMeterUsage(Date)	Ottenere i commiter usati durante il calcolo delle informazioni di fatturazione.
getOrgEnablementStatus(boolean)	Ottenere lo stato corrente di Sicurezza avanzata per l'organizzazione
getProjectEnablementStatus(string, boolean)	Ottenere lo stato corrente di Sicurezza avanzata per un progetto
getRepoEnablementStatus(string, string, boolean)	Determinare se la sicurezza avanzata è abilitata per un repository
saveBillingInfo(BillingInfo, string)	Salvare le informazioni di fatturazione per un'organizzazione.
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	Aggiornare lo stato di Sicurezza avanzata per l'organizzazione
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	Aggiornare lo stato di Sicurezza avanzata per il progetto
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)	Aggiornare l'abilitazione di Advanced Security per un repository

Dettagli costruttore

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parametri

options

IVssRestClientOptions

Dettagli metodo

createBillingSnapshot(MeterUsage)

Durante il calcolo della fatturazione multi-organizzazione nell'unità di scalabilità primaria (EUS21), questa API viene usata per creare uno snapshot di fatturazione per un'organizzazione specifica. L'unità di scalabilità primaria chiamerà questa API per ogni organizzazione in unità scsle diverse per creare uno snapshot di fatturazione. I dati verranno archiviati nel database di partizione specifico dell'organizzazione -> tabella snapshot di fatturazione. Questa operazione è necessaria perché i clienti recuperano i dati di fatturazione dal database di partizione specifico dell'organizzazione.

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

Parametri

meterUsage

MeterUsage

Restituisce

Promise<void>

deleteBillingInfo(string)

Eliminare le informazioni di fatturazione per un'organizzazione.

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

Parametri

organizationId

string

Restituisce

Promise<void>

deleteMeterUsageHistory(string)

Eliminare la cronologia di utilizzo del contatore da SU primario per un'organizzazione.

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

Parametri

organizationId

string

Restituisce

Promise<void>

getBillableCommitterDetails(Date)

Ottenere tutti i dettagli dei commitable fatturabili, inclusi quelli non corrispondenti a un VSID.

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

Parametri

billingDate

Date

Data di query, o se non specificata, oggi

Restituisce

Promise<BillableCommitterDetails[]>

getBillingInfo(string)

Ottenere le informazioni di fatturazione per un'organizzazione.

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

Parametri

organizationId

string

ID organizzazione per ottenere informazioni di fatturazione.

Restituisce

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

Stimare i commiter che verranno aggiunti all'utilizzo del cliente se la sicurezza avanzata è stata abilitata per questa organizzazione.

function getEstimatedOrgBillablePushers(): Promise<string[]>

Restituisce

Promise<string[]>

getEstimatedProjectBillablePushers(string)

Stimare il numero di commiter che verranno aggiunti all'utilizzo del cliente se la sicurezza avanzata è stata abilitata per questo progetto.

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

Parametri

project

string

ID progetto o nome progetto

Restituisce

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

Stimare i commiter che verranno aggiunti all'utilizzo del cliente se la sicurezza avanzata è stata abilitata per questo repository.

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

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

Restituisce

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Restituisce

Promise<MeterUsage>

getMeterUsage(Date)

Ottenere i commiter usati durante il calcolo delle informazioni di fatturazione.

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

Parametri

billingDate

Date

Data di query, o se non specificata, oggi

Restituisce

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

Ottenere lo stato corrente di Sicurezza avanzata per l'organizzazione

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

Parametri

includeAllProperties

boolean

Se true, determinare anche se i push vengono bloccati se contengono segreti

Restituisce

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus(string, boolean)

Ottenere lo stato corrente di Sicurezza avanzata per un progetto

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

Parametri

project

string

ID progetto o nome progetto

includeAllProperties

boolean

Se true, determinare anche se i push vengono bloccati se contengono segreti

Restituisce

Promise<AdvSecEnablementSettings>

getRepoEnablementStatus(string, string, boolean)

Determinare se la sicurezza avanzata è abilitata per un repository

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

Parametri

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

includeAllProperties

boolean

Quando true, determina anche se i push vengono bloccati quando vengono rilevati segreti

Restituisce

Promise<AdvSecEnablementStatus>

saveBillingInfo(BillingInfo, string)

Salvare le informazioni di fatturazione per un'organizzazione.

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

Parametri

billingInfo

BillingInfo

organizationId

string

Restituisce

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

Aggiornare lo stato di Sicurezza avanzata per l'organizzazione

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

Parametri

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Nuovo stato

Restituisce

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

Aggiornare lo stato di Sicurezza avanzata per il progetto

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

Parametri

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Nuovo stato

project

string

ID progetto o nome progetto

Restituisce

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

Aggiornare l'abilitazione di Advanced Security per un repository

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

Parametri

savedAdvSecEnablementStatus

AdvSecEnablementStatusUpdate

nuovo stato

project

string

ID progetto o nome progetto

repository

string

Nome o ID del repository

Restituisce

Promise<void>