ManagementRestClient class

Paket:

azure-devops-extension-api

Basisklasse, die verwendet (von abgeleitet) werden soll, um Anforderungen an VSS-REST-APIs zu senden

Extends

RestClientBase

Konstruktoren

ManagementRestClient(IVssRestClientOptions)

Methoden

createBillingSnapshot(MeterUsage)	Während der Abrechnung mit mehreren Organisationen in der primären Skalierungseinheit (EUS21) wird diese API verwendet, um abrechnungsbasierte Momentaufnahme für eine bestimmte Organisation zu erstellen. Die primäre Skalierungseinheit ruft diese API für jede Organisation in verschiedenen Sksle-Einheiten auf, um abrechnungsbasierte Momentaufnahme zu erstellen. Die Daten werden in der organisationsspezifischen Partitionsdatenbank –> Abrechnungstabelle Momentaufnahme gespeichert. Dies ist erforderlich, da Kunden Abrechnungsdaten aus ihrer organisationsspezifischen Partitionsdatenbank abrufen.
deleteBillingInfo(string)	Löschen Sie die Abrechnungsinformationen für eine organization.
deleteMeterUsageHistory(string)	Löschen Sie den Verbrauchsdatennutzungsverlauf aus der primären SU für eine organization.
getBillableCommitterDetails(Date)	Rufen Sie alle abrechenbaren Committerdetails ab, einschließlich derer, die nicht mit einer VSID übereinstimmen.
getBillingInfo(string)	Rufen Sie die Abrechnungsinformationen für eine organization ab.
getEstimatedOrgBillablePushers()	Schätzen Sie die Committer, die der Nutzung des Kunden hinzugefügt würden, wenn Advanced Security für diese organization aktiviert wäre.
getEstimatedProjectBillablePushers(string)	Schätzen Sie die Anzahl der Committer, die der Nutzung des Kunden hinzugefügt werden, wenn advanced Security für dieses Projekt aktiviert wurde.
getEstimatedRepoBillableCommitters(string, string)	Schätzen Sie die Committer, die der Nutzung des Kunden hinzugefügt werden, wenn advanced Security für dieses Repository aktiviert wurde.
getLastMeterUsage()
getMeterUsage(Date)	Abrufen von Commitern, die beim Berechnen von Abrechnungsinformationen verwendet werden.
getOrgEnablementStatus(boolean)	Abrufen der aktuellen status von Advanced Security für die organization
getProjectEnablementStatus(string, boolean)	Abrufen der aktuellen status von Advanced Security für ein Projekt
getRepoEnablementStatus(string, string, boolean)	Ermitteln, ob Advanced Security für ein Repository aktiviert ist
saveBillingInfo(BillingInfo, string)	Speichern Sie die Abrechnungsinformationen für eine organization.
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	Aktualisieren des status der erweiterten Sicherheit für die organization
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	Aktualisieren der status der erweiterten Sicherheit für das Projekt
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)	Aktualisieren der Aktivierung von Advanced Security für ein Repository

Details zum Konstruktor

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Methode

createBillingSnapshot(MeterUsage)

Während der Abrechnung mit mehreren Organisationen in der primären Skalierungseinheit (EUS21) wird diese API verwendet, um abrechnungsbasierte Momentaufnahme für eine bestimmte Organisation zu erstellen. Die primäre Skalierungseinheit ruft diese API für jede Organisation in verschiedenen Sksle-Einheiten auf, um abrechnungsbasierte Momentaufnahme zu erstellen. Die Daten werden in der organisationsspezifischen Partitionsdatenbank –> Abrechnungstabelle Momentaufnahme gespeichert. Dies ist erforderlich, da Kunden Abrechnungsdaten aus ihrer organisationsspezifischen Partitionsdatenbank abrufen.

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

Parameter

meterUsage

MeterUsage

Gibt zurück

Promise<void>

deleteBillingInfo(string)

Löschen Sie die Abrechnungsinformationen für eine organization.

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

Parameter

organizationId

string

Gibt zurück

Promise<void>

deleteMeterUsageHistory(string)

Löschen Sie den Verbrauchsdatennutzungsverlauf aus der primären SU für eine organization.

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

Parameter

organizationId

string

Gibt zurück

Promise<void>

getBillableCommitterDetails(Date)

Rufen Sie alle abrechenbaren Committerdetails ab, einschließlich derer, die nicht mit einer VSID übereinstimmen.

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

Parameter

billingDate

Date

Das Abzufragende Datum oder, falls nicht angegeben, heute

Gibt zurück

Promise<BillableCommitterDetails[]>

getBillingInfo(string)

Rufen Sie die Abrechnungsinformationen für eine organization ab.

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

Parameter

organizationId

string

Organisations-ID, für die Abrechnungsinformationen abgerufen werden sollen.

Gibt zurück

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

Schätzen Sie die Committer, die der Nutzung des Kunden hinzugefügt würden, wenn Advanced Security für diese organization aktiviert wäre.

function getEstimatedOrgBillablePushers(): Promise<string[]>

Gibt zurück

Promise<string[]>

getEstimatedProjectBillablePushers(string)

Schätzen Sie die Anzahl der Committer, die der Nutzung des Kunden hinzugefügt werden, wenn advanced Security für dieses Projekt aktiviert wurde.

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

Parameter

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

Schätzen Sie die Committer, die der Nutzung des Kunden hinzugefügt werden, wenn advanced Security für dieses Repository aktiviert wurde.

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

Parameter

project

string

Projekt-ID oder Projektname

repository

string

Der Name oder die ID des Repositorys

Gibt zurück

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Gibt zurück

Promise<MeterUsage>

getMeterUsage(Date)

Abrufen von Commitern, die beim Berechnen von Abrechnungsinformationen verwendet werden.

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

Parameter

billingDate

Date

Das Abzufragende Datum oder, falls nicht angegeben, heute

Gibt zurück

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

Abrufen der aktuellen status von Advanced Security für die organization

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

Parameter

includeAllProperties

boolean

Wenn true, bestimmen Sie auch, ob Pushvorgänge blockiert werden, wenn sie Geheimnisse enthalten.

Gibt zurück

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus(string, boolean)

Abrufen der aktuellen status von Advanced Security für ein Projekt

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

Parameter

project

string

Projekt-ID oder Projektname

includeAllProperties

boolean

Wenn true, bestimmen Sie auch, ob Pushvorgänge blockiert werden, wenn sie Geheimnisse enthalten.

Gibt zurück

Promise<AdvSecEnablementSettings>

getRepoEnablementStatus(string, string, boolean)

Ermitteln, ob Advanced Security für ein Repository aktiviert ist

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

Parameter

project

string

Projekt-ID oder Projektname

repository

string

Der Name oder die ID des Repositorys

includeAllProperties

boolean

Wenn true, bestimmt auch, ob Pushvorgänge blockiert werden, wenn Geheimnisse erkannt werden.

Gibt zurück

Promise<AdvSecEnablementStatus>

saveBillingInfo(BillingInfo, string)

Speichern Sie die Abrechnungsinformationen für eine organization.

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

Parameter

billingInfo

BillingInfo

organizationId

string

Gibt zurück

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

Aktualisieren des status der erweiterten Sicherheit für die organization

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

Parameter

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Die neue status

Gibt zurück

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

Aktualisieren der status der erweiterten Sicherheit für das Projekt

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

Parameter

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Die neue status

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

Aktualisieren der Aktivierung von Advanced Security für ein Repository

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

Parameter

savedAdvSecEnablementStatus

AdvSecEnablementStatusUpdate

Neue status

project

string

Projekt-ID oder Projektname

repository

string

Name oder ID des Repositorys

Gibt zurück

Promise<void>