Delen via


ManagementRestClient class

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen naar VSS REST API's

Uitbreiding

Constructors

ManagementRestClient(IVssRestClientOptions)

Methoden

createBillingSnapshot2(MeterUsageForPlan, Plan)

Tijdens de berekening van facturering met meerdere organisaties in de primaire schaaleenheid (EUS21) wordt deze API gebruikt om een momentopname van de facturering voor een specifieke organisatie te maken. De primaire schaaleenheid roept deze API aan voor elke organisatie in verschillende scsle-eenheden om een momentopname van de facturering te maken. Gegevens worden opgeslagen in de organisatiespecifieke partitie-DB - factureringsmomentopnametabel. Dit is nodig omdat klanten factureringsgegevens ophalen uit hun organisatiespecifieke partitie-DB.

getAdvancedSecurityAgentPoolSelection()

Basis-URL voor het verkrijgen van alle beschikbare agentpools + Momenteel geselecteerde agentpool Dit is een alleen-lezen operatie die geen beheerrechten vereist.

getBillableCommitterDetails2(Plan, Date)

Haal alle details van factureerbare committers op, inclusief de gegevens die niet zijn gekoppeld aan een VSID.

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

Maak een schatting van de pushers die zouden worden toegevoegd aan het gebruik van de klant als Advanced Security was ingeschakeld voor deze opslagplaats.

getEstimatedBillablePushersDetailsForOrg2(Plan)

Maak een schatting van de pushers die zouden worden toegevoegd aan het gebruik van de klant als Advanced Security was ingeschakeld voor deze organisatie.

getEstimatedBillablePushersDetailsForProject2(string, Plan)

Schat de pushers die aan het gebruik van de klant worden toegevoegd als Advanced Security voor dit project wordt ingeschakeld.

getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)

Zorg ervoor dat commiters worden gebruikt bij het berekenen van factureringsgegevens.

getOrgEnablementStatus2(boolean)

Haal de huidige status van Advanced Security op voor de organisatie

getProjectEnablementStatus2(string, boolean)

Bekijk de huidige status van Advanced Security voor een project

getRepoEnablementStatus2(string, string, boolean)

Hiermee bepaalt u of Codebeveiliging, Geheime beveiliging en hun functies zijn ingeschakeld voor de opslagplaats.

updateAdvancedSecurityAgentPoolSelection(string)

Werkt Agent Pool Registerwaarde Bij Voor de Geselecteerde Agent Pool Dit gebruikt automatisch de onderliggende HTTP-client voor agentpools om te valideren dat de gebruiker rechten heeft om die pool te gebruiken

updateOrgEnablementStatus2(OrgEnablementSettings)

De status van Geavanceerde beveiliging voor de organisatie bijwerken

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Update de status van Advanced Security voor het project

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

Werk de activeringsstatus van Code Security en Secret Protection, samen met hun respectievelijke functies, bij voor een bepaalde repository.

Constructordetails

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parameters

Methodedetails

createBillingSnapshot2(MeterUsageForPlan, Plan)

Tijdens de berekening van facturering met meerdere organisaties in de primaire schaaleenheid (EUS21) wordt deze API gebruikt om een momentopname van de facturering voor een specifieke organisatie te maken. De primaire schaaleenheid roept deze API aan voor elke organisatie in verschillende scsle-eenheden om een momentopname van de facturering te maken. Gegevens worden opgeslagen in de organisatiespecifieke partitie-DB - factureringsmomentopnametabel. Dit is nodig omdat klanten factureringsgegevens ophalen uit hun organisatiespecifieke partitie-DB.

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

Parameters

meterUsage
MeterUsageForPlan
plan
Plan

Retouren

Promise<void>

getAdvancedSecurityAgentPoolSelection()

Basis-URL voor het verkrijgen van alle beschikbare agentpools + Momenteel geselecteerde agentpool Dit is een alleen-lezen operatie die geen beheerrechten vereist.

function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>

Retouren

Promise<AgentPoolDetails>

getBillableCommitterDetails2(Plan, Date)

Haal alle details van factureerbare committers op, inclusief de gegevens die niet zijn gekoppeld aan een VSID.

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

Parameters

plan
Plan

Het plan om op te vragen. Ondersteunde abonnementen: CodeSecurity en SecretProtection. Dit is een verplichte parameter.

billingDate

Date

De datum om op te vragen, of indien niet opgegeven, vandaag

Retouren

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

Maak een schatting van de pushers die zouden worden toegevoegd aan het gebruik van de klant als Advanced Security was ingeschakeld voor deze opslagplaats.

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

Parameters

project

string

Project-ID of project-naam

repository

string

De naam of id van de opslagplaats

plan
Plan

Het plan om op te vragen.

Retouren

getEstimatedBillablePushersDetailsForOrg2(Plan)

Maak een schatting van de pushers die zouden worden toegevoegd aan het gebruik van de klant als Advanced Security was ingeschakeld voor deze organisatie.

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

Parameters

plan
Plan

Het plan om op te vragen.

Retouren

getEstimatedBillablePushersDetailsForProject2(string, Plan)

Schat de pushers die aan het gebruik van de klant worden toegevoegd als Advanced Security voor dit project wordt ingeschakeld.

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

Parameters

project

string

Project-ID of project-naam

plan
Plan

Retouren

getLastMeterUsage2(Plan)

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

Parameters

plan
Plan

Retouren

getMeterUsage2(Plan, Date)

Zorg ervoor dat commiters worden gebruikt bij het berekenen van factureringsgegevens.

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

Parameters

plan
Plan

Het plan om op te vragen. Ondersteunde abonnementen: CodeSecurity en SecretProtection. Dit is een verplichte parameter.

billingDate

Date

De datum om op te vragen, of indien niet opgegeven, vandaag

Retouren

getOrgEnablementStatus2(boolean)

Haal de huidige status van Advanced Security op voor de organisatie

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

Parameters

includeAllProperties

boolean

Als dit waar is, bepaal dan ook of pushes worden geblokkeerd als ze geheimen bevatten

Retouren

getProjectEnablementStatus2(string, boolean)

Bekijk de huidige status van Advanced Security voor een project

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

Parameters

project

string

Project-ID of project-naam

includeAllProperties

boolean

Als dit waar is, bepaal dan ook of pushes worden geblokkeerd als ze geheimen bevatten

Retouren

getRepoEnablementStatus2(string, string, boolean)

Hiermee bepaalt u of Codebeveiliging, Geheime beveiliging en hun functies zijn ingeschakeld voor de opslagplaats.

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

Parameters

project

string

Project-ID of project-naam

repository

string

De naam of id van de opslagplaats

includeAllProperties

boolean

Als dit waar is, wordt ook bepaald of pushes worden geblokkeerd wanneer geheimen worden gedetecteerd

Retouren

updateAdvancedSecurityAgentPoolSelection(string)

Werkt Agent Pool Registerwaarde Bij Voor de Geselecteerde Agent Pool Dit gebruikt automatisch de onderliggende HTTP-client voor agentpools om te valideren dat de gebruiker rechten heeft om die pool te gebruiken

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

Parameters

agentPoolName

string

Retouren

Promise<AgentPoolDetails>

updateOrgEnablementStatus2(OrgEnablementSettings)

De status van Geavanceerde beveiliging voor de organisatie bijwerken

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

Parameters

orgEnablementSettings
OrgEnablementSettings

De nieuwe status

Retouren

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Update de status van Advanced Security voor het project

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

Parameters

projectEnablementSettings
ProjectEnablementSettings

De nieuwe status

project

string

Project-ID of project-naam

Retouren

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

Werk de activeringsstatus van Code Security en Secret Protection, samen met hun respectievelijke functies, bij voor een bepaalde repository.

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

Parameters

repoEnablementSettings
RepoEnablementSettings

Nieuwe status

project

string

Project-ID of project-naam

repository

string

Naam of ID van de repository

Retouren

Promise<void>