ManagementRestClient class

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

Extends

Metoder

cancelCodeQLJobs()

Avbryter alla körande och köade CodeQL-jobb och Dynamic Pipeline körs under flygning för organisationen.

createBillingSnapshot2(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 kommer att lagras i organisationsspecifika partitionsdatabasen –> faktureringsögonblickstabellen. Detta behövs eftersom kunderna hämtar faktureringsdata från sin organisationsspecifika partitionsdatabas.

getAdvancedSecurityAgentPoolSelection()

Bas-URL för att hämta alla tillgängliga agentpooler + För närvarande valda agentpooler Detta är en skrivskyddad operation som inte kräver hanteringsbehörigheter.

getBillableCommitterDetails2(Plan, Date)

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

getCodeQLJobCount()

Får räkningen på körande och köade CodeQL-jobb och Dynamic Pipeline körs under flygning för organisationen.

getCodeQLSchedule()

Får den aktuella CodeQL-standardkonfigurationen för installationsschemat för organisationen.

getCodeQLScheduleLegacy()

Får den aktuella CodeQL-standardkonfigurationen för installationsschemat för organisationen.

getEstimatedBillableCommittersDetailsForRepo2(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.

getEstimatedBillablePushersDetailsForOrg2(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.

getEstimatedBillablePushersDetailsForProject2(string, Plan)

Uppskatta vilka pushers som skulle läggas till kundens användning om Advanced Security aktiverades för detta projekt.

getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)

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

getOrgEnablementStatus2(boolean)

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

getProjectEnablementStatus2(string, boolean)

Få aktuell status för Advanced Security för ett projekt

getRepoEnablementStatus2(string, string, boolean)

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

updateAdvancedSecurityAgentPoolSelection(string)

Uppdaterar Agent Pool-registervärde För den valda agentpoolen Detta använder automatiskt den underliggande http-klienten för agentpooler för att validera att användaren har behörighet att använda den poolen

updateCodeQLSchedule(number)

Sätter veckodagen då CodeQL:s standardinställningsskanning ska köras för organisationen.

updateCodeQLScheduleLegacy(number)

Sätter veckodagen då CodeQL:s standardinställningsskanning ska köras för organisationen.

updateOrgEnablementStatus2(OrgEnablementSettings)

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

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Uppdatera statusen för Advanced Security för projektet

updateRepoAdvSecEnablementStatus2(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

cancelCodeQLJobs()

Avbryter alla körande och köade CodeQL-jobb och Dynamic Pipeline körs under flygning för organisationen.

function cancelCodeQLJobs(): Promise<number>

Returer

Promise<number>

createBillingSnapshot2(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 kommer att lagras i organisationsspecifika partitionsdatabasen –> faktureringsögonblickstabellen. Detta behövs eftersom kunderna hämtar faktureringsdata från sin organisationsspecifika partitionsdatabas.

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

Parametrar

meterUsage
MeterUsageForPlan
plan
Plan

Returer

Promise<void>

getAdvancedSecurityAgentPoolSelection()

Bas-URL för att hämta alla tillgängliga agentpooler + För närvarande valda agentpooler Detta är en skrivskyddad operation som inte kräver hanteringsbehörigheter.

function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>

Returer

Promise<AgentPoolDetails>

getBillableCommitterDetails2(Plan, Date)

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

function getBillableCommitterDetails2(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

getCodeQLJobCount()

Får räkningen på körande och köade CodeQL-jobb och Dynamic Pipeline körs under flygning för organisationen.

function getCodeQLJobCount(): Promise<number>

Returer

Promise<number>

getCodeQLSchedule()

Får den aktuella CodeQL-standardkonfigurationen för installationsschemat för organisationen.

function getCodeQLSchedule(): Promise<CodeQLScheduleDetails>

Returer

getCodeQLScheduleLegacy()

Får den aktuella CodeQL-standardkonfigurationen för installationsschemat för organisationen.

function getCodeQLScheduleLegacy(): Promise<CodeQLScheduleDetails>

Returer

getEstimatedBillableCommittersDetailsForRepo2(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 getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>

Parametrar

project

string

Project-ID eller projekt namn

repository

string

Lagringsplatsens namn eller ID

plan
Plan

Planen att fråga.

Returer

getEstimatedBillablePushersDetailsForOrg2(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 getEstimatedBillablePushersDetailsForOrg2(plan?: Plan): Promise<MeterUsageEstimate>

Parametrar

plan
Plan

Planen att fråga.

Returer

getEstimatedBillablePushersDetailsForProject2(string, Plan)

Uppskatta vilka pushers som skulle läggas till kundens användning om Advanced Security aktiverades för detta projekt.

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

Parametrar

project

string

Project-ID eller projekt namn

plan
Plan

Returer

getLastMeterUsage2(Plan)

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

Parametrar

plan
Plan

Returer

getMeterUsage2(Plan, Date)

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

function getMeterUsage2(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

getOrgEnablementStatus2(boolean)

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

function getOrgEnablementStatus2(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

getProjectEnablementStatus2(string, boolean)

Få aktuell status för Advanced Security för ett projekt

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

Parametrar

project

string

Project-ID eller projekt namn

includeAllProperties

boolean

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

Returer

getRepoEnablementStatus2(string, string, boolean)

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

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

Parametrar

project

string

Project-ID eller projekt namn

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

updateAdvancedSecurityAgentPoolSelection(string)

Uppdaterar Agent Pool-registervärde För den valda agentpoolen Detta använder automatiskt den underliggande http-klienten för agentpooler för att validera att användaren har behörighet att använda den poolen

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

Parametrar

agentPoolName

string

Returer

Promise<AgentPoolDetails>

updateCodeQLSchedule(number)

Sätter veckodagen då CodeQL:s standardinställningsskanning ska köras för organisationen.

function updateCodeQLSchedule(scheduleDayOfWeek: number): Promise<CodeQLScheduleDetails>

Parametrar

scheduleDayOfWeek

number

Veckodag som heltal: 0=Söndag, 1=Måndag, ..., 6=Lördag.

Returer

updateCodeQLScheduleLegacy(number)

Sätter veckodagen då CodeQL:s standardinställningsskanning ska köras för organisationen.

function updateCodeQLScheduleLegacy(scheduleDayOfWeek: number): Promise<CodeQLScheduleDetails>

Parametrar

scheduleDayOfWeek

number

Veckodag som heltal: 0=Söndag, 1=Måndag, ..., 6=Lördag.

Returer

updateOrgEnablementStatus2(OrgEnablementSettings)

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

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

Parametrar

orgEnablementSettings
OrgEnablementSettings

Den nya statusen

Returer

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Uppdatera statusen för Advanced Security för projektet

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

Parametrar

projectEnablementSettings
ProjectEnablementSettings

Den nya statusen

project

string

Project-ID eller projekt namn

Returer

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

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

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

Parametrar

repoEnablementSettings
RepoEnablementSettings

Ny status

project

string

Project-ID eller projekt namn

repository

string

Databasens namn eller ID

Returer

Promise<void>