ManagementRestClient class

Paket:

azure-devops-extension-api

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

Extends

RestClientBase

Konstruktoren

ManagementRestClient(IVssRestClientOptions)

Methoden

createBillingSnapshot2(MeterUsageForPlan, Plan)	Bei der Berechnung der Abrechnung mit mehreren Organisationen in der primären Skalierungseinheit (EUS21) wird diese API verwendet, um einen Abrechnungssnapshot für eine bestimmte Organisation zu erstellen. Die primäre Skalierungseinheit ruft diese API für jede Organisation in verschiedenen scsle-Einheiten auf, um einen Abrechnungssnapshot zu erstellen. Die Daten werden in der organisationsspezifischen Partitions-DB – Abrechnungs-Snapshot-Tabelle gespeichert. Dies ist erforderlich, da Kunden Abrechnungsdaten aus ihrer organisationsspezifischen Partitionsdatenbank abrufen.
getAdvancedSecurityAgentPoolSelection()	Basis-URL zum Erhalten aller verfügbaren Agentenpools + aktuell ausgewählter Agentenpool Dies ist eine schreibgeschützte Operation, die keine Verwaltungsberechtigungen erfordert.
getBillableCommitterDetails2(Plan, Date)	Rufen Sie alle Details zu abrechenbaren Committern ab, einschließlich derjenigen, die nicht mit einer VSID übereinstimmen.
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)	Schätzen Sie die Pusher, die der Nutzung des Kunden hinzugefügt würden, wenn Advanced Security für dieses Repository aktiviert wäre.
getEstimatedBillablePushersDetailsForOrg2(Plan)	Schätzen Sie die Pusher, die der Nutzung des Kunden hinzugefügt würden, wenn die erweiterte Sicherheit für diese Organisation aktiviert wäre.
getEstimatedBillablePushersDetailsForProject2(string, Plan)	Schätzen Sie die Pusher, die zum Kundenverbrauch hinzugefügt würden, wenn Advanced Security für dieses Projekt aktiviert wäre.
getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)	Rufen Sie Commiter ab, die beim Berechnen von Abrechnungsinformationen verwendet werden.
getOrgEnablementStatus2(boolean)	Abrufen des aktuellen Status von Advanced Security für die Organisation
getProjectEnablementStatus2(string, boolean)	Erhalten Sie den aktuellen Status von Advanced Security für ein Projekt
getRepoEnablementStatus2(string, string, boolean)	Bestimmt, ob Codesicherheit, geheimer Schutz und deren Features für das Repository aktiviert sind.
updateAdvancedSecurityAgentPoolSelection(string)	Aktualisiert den Registrierungswert des Agentenpools für den ausgewählten Agentenpool. Dies verwendet automatisch den zugrunde liegenden HTTP-Client für Agentenpools, um zu überprüfen, ob der Benutzer Berechtigungen hat, diesen Pool zu verwenden.
updateOrgEnablementStatus2(OrgEnablementSettings)	Aktualisieren des Status von Advanced Security für die Organisation
updateProjectEnablementStatus2(ProjectEnablementSettings, string)	Aktualisieren Sie den Status der Advanced Security für das Projekt
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)	Aktualisieren Sie den Aktivierungsstatus der Codesicherheit und des geheimen Schutzes sowie deren jeweiligen Features für ein bestimmtes Repository.

Details zum Konstruktor

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Methode

createBillingSnapshot2(MeterUsageForPlan, Plan)

Bei der Berechnung der Abrechnung mit mehreren Organisationen in der primären Skalierungseinheit (EUS21) wird diese API verwendet, um einen Abrechnungssnapshot für eine bestimmte Organisation zu erstellen. Die primäre Skalierungseinheit ruft diese API für jede Organisation in verschiedenen scsle-Einheiten auf, um einen Abrechnungssnapshot zu erstellen. Die Daten werden in der organisationsspezifischen Partitions-DB – Abrechnungs-Snapshot-Tabelle gespeichert. Dies ist erforderlich, da Kunden Abrechnungsdaten aus ihrer organisationsspezifischen Partitionsdatenbank abrufen.

function createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>

Parameter

meterUsage

MeterUsageForPlan

plan

Plan

Gibt zurück

Promise<void>

getAdvancedSecurityAgentPoolSelection()

Basis-URL zum Erhalten aller verfügbaren Agentenpools + aktuell ausgewählter Agentenpool Dies ist eine schreibgeschützte Operation, die keine Verwaltungsberechtigungen erfordert.

function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>

Gibt zurück

Promise<AgentPoolDetails>

getBillableCommitterDetails2(Plan, Date)

Rufen Sie alle Details zu abrechenbaren Committern ab, einschließlich derjenigen, die nicht mit einer VSID übereinstimmen.

function getBillableCommitterDetails2(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>

Parameter

plan

Plan

Der zu abfragende Plan. Unterstützte Pläne: CodeSecurity und SecretProtection. Dieser Parameter ist erforderlich.

billingDate

Date

Das Datum für die Abfrage oder falls nicht angegeben, heute

Gibt zurück

Promise<BillableCommitterDetails[]>

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

Schätzen Sie die Pusher, die der Nutzung des Kunden hinzugefügt würden, wenn Advanced Security für dieses Repository aktiviert wäre.

function getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>

Parameter

project

string

Project-ID oder Projekt-Name

repository

string

Der Name oder die ID des Repositorys

plan

Plan

Der zu abfragende Plan.

Gibt zurück

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForOrg2(Plan)

Schätzen Sie die Pusher, die der Nutzung des Kunden hinzugefügt würden, wenn die erweiterte Sicherheit für diese Organisation aktiviert wäre.

function getEstimatedBillablePushersDetailsForOrg2(plan?: Plan): Promise<MeterUsageEstimate>

Parameter

plan

Plan

Der zu abfragende Plan.

Gibt zurück

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForProject2(string, Plan)

Schätzen Sie die Pusher, die zum Kundenverbrauch hinzugefügt würden, wenn Advanced Security für dieses Projekt aktiviert wäre.

function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>

Parameter

project

string

Project-ID oder Projekt-Name

plan

Plan

Gibt zurück

Promise<MeterUsageEstimate>

getLastMeterUsage2(Plan)

function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>

Parameter

plan

Plan

Gibt zurück

Promise<MeterUsageForPlan>

getMeterUsage2(Plan, Date)

Rufen Sie Commiter ab, die beim Berechnen von Abrechnungsinformationen verwendet werden.

function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>

Parameter

plan

Plan

Der zu abfragende Plan. Unterstützte Pläne: CodeSecurity und SecretProtection. Dieser Parameter ist erforderlich.

billingDate

Date

Das Datum für die Abfrage oder falls nicht angegeben, heute

Gibt zurück

Promise<MeterUsageForPlan>

getOrgEnablementStatus2(boolean)

Abrufen des aktuellen Status von Advanced Security für die Organisation

function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>

Parameter

includeAllProperties

boolean

Bei "true" können Sie auch ermitteln, ob Pushs blockiert werden, wenn sie geheime Schlüssel enthalten.

Gibt zurück

Promise<OrgEnablementSettings>

getProjectEnablementStatus2(string, boolean)

Erhalten Sie den aktuellen Status von Advanced Security für ein Projekt

function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>

Parameter

project

string

Project-ID oder Projekt-Name

includeAllProperties

boolean

Bei "true" können Sie auch ermitteln, ob Pushs blockiert werden, wenn sie geheime Schlüssel enthalten.

Gibt zurück

Promise<ProjectEnablementSettings>

getRepoEnablementStatus2(string, string, boolean)

Bestimmt, ob Codesicherheit, geheimer Schutz und deren Features für das Repository aktiviert sind.

function getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>

Parameter

project

string

Project-ID oder Projekt-Name

repository

string

Der Name oder die ID des Repositorys

includeAllProperties

boolean

Bei "true" wird auch bestimmt, ob Pushs blockiert werden, wenn geheime Schlüssel erkannt werden.

Gibt zurück

Promise<RepoEnablementSettings>

updateAdvancedSecurityAgentPoolSelection(string)

Aktualisiert den Registrierungswert des Agentenpools für den ausgewählten Agentenpool. Dies verwendet automatisch den zugrunde liegenden HTTP-Client für Agentenpools, um zu überprüfen, ob der Benutzer Berechtigungen hat, diesen Pool zu verwenden.

function updateAdvancedSecurityAgentPoolSelection(agentPoolName: string): Promise<AgentPoolDetails>

Parameter

agentPoolName

string

Gibt zurück

Promise<AgentPoolDetails>

updateOrgEnablementStatus2(OrgEnablementSettings)

Aktualisieren des Status von Advanced Security für die Organisation

function updateOrgEnablementStatus2(orgEnablementSettings: OrgEnablementSettings): Promise<void>

Parameter

orgEnablementSettings

OrgEnablementSettings

Der neue Status

Gibt zurück

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Aktualisieren Sie den Status der Advanced Security für das Projekt

function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>

Parameter

projectEnablementSettings

ProjectEnablementSettings

Der neue Status

project

string

Project-ID oder Projekt-Name

Gibt zurück

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

Aktualisieren Sie den Aktivierungsstatus der Codesicherheit und des geheimen Schutzes sowie deren jeweiligen Features für ein bestimmtes Repository.

function updateRepoAdvSecEnablementStatus2(repoEnablementSettings: RepoEnablementSettings, project: string, repository: string): Promise<void>

Parameter

repoEnablementSettings

RepoEnablementSettings

Neuer Status

project

string

Project-ID oder Projekt-Name

repository

string

Name oder ID des Repositorys

Gibt zurück

Promise<void>