Dela via


ManagementRestClient class

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

Extends

Konstruktorer

ManagementRestClient(IVssRestClientOptions)

Metoder

createBillingSnapshot3(MeterUsageForPlan, Plan)

Under faktureringsberäkning för flera organisationer i primär skalningsenhet (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 –> ögonblicksbildstabellen för fakturering. Detta behövs eftersom kunderna hämtar faktureringsdata från sin organisationsspecifika partitionsdatabas.

getBillableCommitterDetails3(Plan, Date)

Hämta all information om fakturerbara incheckningar, inklusive de som inte matchas med ett VSID.

getEstimatedBillableCommittersDetailsForRepo3(string, string, Plan)

Beräkna de pushare som skulle läggas till i kundens användning om Avancerad säkerhet var aktiverat för den här lagringsplatsen.

getEstimatedBillablePushersDetailsForOrg3(Plan)

Beräkna de push-funktioner som skulle läggas till i kundens användning om Avancerad säkerhet har aktiverats för den här organisationen.

getEstimatedBillablePushersDetailsForProject3(string, Plan)

Beräkna de pushare som skulle läggas till i kundens användning om Avancerad säkerhet har aktiverats för det här projektet.

getLastMeterUsage3(Plan)
getMeterUsage3(Plan, Date)

Få incheckningar som används vid beräkning av faktureringsinformation.

getOrgEnablementStatus3(boolean)

Hämta aktuell status för Avancerad säkerhet för organisationen

getProjectEnablementStatus3(string, boolean)

Hämta aktuell status för Avancerad säkerhet för ett projekt

getRepoEnablementStatus3(string, string, boolean)

Avgör om kodsäkerhet, hemlighetsskydd och deras funktioner är aktiverade för databasen.

updateOrgEnablementStatus3(OrgEnablementSettings)

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

updateProjectEnablementStatus3(ProjectEnablementSettings, string)

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

updateRepoAdvSecEnablementStatus3(RepoEnablementSettings, string, string)

Uppdatera aktiveringsstatusen för kodsäkerhet och hemlighetsskydd, tillsammans med deras respektive funktioner, för en viss lagringsplats.

Konstruktorinformation

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parametrar

Metodinformation

createBillingSnapshot3(MeterUsageForPlan, Plan)

Under faktureringsberäkning för flera organisationer i primär skalningsenhet (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 –> ögonblicksbildstabellen för fakturering. Detta behövs eftersom kunderna hämtar faktureringsdata från sin organisationsspecifika partitionsdatabas.

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

Parametrar

meterUsage
MeterUsageForPlan
plan
Plan

Returer

Promise<void>

getBillableCommitterDetails3(Plan, Date)

Hämta all information om fakturerbara incheckningar, inklusive de som inte matchas med ett VSID.

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

Parametrar

plan
Plan

Planen att fråga. Planer som stöds: CodeSecurity och SecretProtection. Det här är en obligatorisk parameter.

billingDate

Date

Datumet för att fråga, eller om det inte anges, idag

Returer

getEstimatedBillableCommittersDetailsForRepo3(string, string, Plan)

Beräkna de pushare som skulle läggas till i kundens användning om Avancerad säkerhet var aktiverat för den här lagringsplatsen.

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

Lagringsplatsens namn eller ID

plan
Plan

Planen att fråga.

Returer

getEstimatedBillablePushersDetailsForOrg3(Plan)

Beräkna de push-funktioner som skulle läggas till i kundens användning om Avancerad säkerhet har aktiverats för den här organisationen.

function getEstimatedBillablePushersDetailsForOrg3(plan: Plan): Promise<MeterUsageEstimate>

Parametrar

plan
Plan

Planen att fråga.

Returer

getEstimatedBillablePushersDetailsForProject3(string, Plan)

Beräkna de pushare som skulle läggas till i kundens användning om Avancerad säkerhet har aktiverats för det här projektet.

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

Parametrar

project

string

Projekt-ID eller projektnamn

plan
Plan

Returer

getLastMeterUsage3(Plan)

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

Parametrar

plan
Plan

Returer

getMeterUsage3(Plan, Date)

Få incheckningar som används vid beräkning av faktureringsinformation.

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

Parametrar

plan
Plan

Planen att fråga. Planer som stöds: CodeSecurity och SecretProtection. Det här är en obligatorisk parameter.

billingDate

Date

Datumet för att fråga, eller om det inte anges, idag

Returer

getOrgEnablementStatus3(boolean)

Hämta aktuell status för Avancerad säkerhet för organisationen

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

Parametrar

includeAllProperties

boolean

När det är sant avgör du även om push-meddelanden blockeras om de innehåller hemligheter

Returer

getProjectEnablementStatus3(string, boolean)

Hämta aktuell status för Avancerad säkerhet för ett projekt

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

Parametrar

project

string

Projekt-ID eller projektnamn

includeAllProperties

boolean

När det är sant avgör du även om push-meddelanden blockeras om de innehåller hemligheter

Returer

getRepoEnablementStatus3(string, string, boolean)

Avgör om kodsäkerhet, hemlighetsskydd och deras funktioner är aktiverade för databasen.

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

Parametrar

project

string

Projekt-ID eller projektnamn

repository

string

Lagringsplatsens namn eller ID

includeAllProperties

boolean

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

Returer

updateOrgEnablementStatus3(OrgEnablementSettings)

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

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

Parametrar

orgEnablementSettings
OrgEnablementSettings

Den nya statusen

Returer

Promise<void>

updateProjectEnablementStatus3(ProjectEnablementSettings, string)

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

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

Parametrar

projectEnablementSettings
ProjectEnablementSettings

Den nya statusen

project

string

Projekt-ID eller projektnamn

Returer

Promise<void>

updateRepoAdvSecEnablementStatus3(RepoEnablementSettings, string, string)

Uppdatera aktiveringsstatusen för kodsäkerhet och hemlighetsskydd, tillsammans med deras respektive funktioner, för en viss lagringsplats.

function updateRepoAdvSecEnablementStatus3(savedAdvSecEnablementStatus: RepoEnablementSettings, project: string, repository: string): Promise<void>

Parametrar

savedAdvSecEnablementStatus
RepoEnablementSettings

new status

project

string

Projekt-ID eller projektnamn

repository

string

Databasens namn eller ID

Returer

Promise<void>