ManagementRestClient class

new ManagementRestClient(options: IVssRestClientOptions)

Parametri

Annulla tutti i job CodeQL in esecuzione e in coda e le esecuzioni dinamiche di pipeline in volo per l'organizzazione.

function cancelCodeQLJobs(): Promise<number>

Valori restituiti

Durante il calcolo della fatturazione multi-organizzazione nell'unità di scala primaria (EUS21), questa API viene usata per creare uno snapshot di fatturazione per un'organizzazione specifica. L'unità di scala primaria chiamerà questa API per ogni organizzazione in unità di scsle diverse per creare uno snapshot di fatturazione. I dati saranno memorizzati nella tabella snapshot di partizione specifica dell'organizzazione -> tabella di snapshot di fatturazione. Questa operazione è necessaria perché i clienti recupereranno i dati di fatturazione dal database di partizione specifico dell'organizzazione.

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

Parametri

Valori restituiti

URL base per ottenere tutti i pool di agenti disponibili + pool di agenti attualmente selezionati Questa è un'operazione di sola lettura che non richiede permessi di gestione.

function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>

Valori restituiti

Ottenere tutti i dettagli dei commit fatturabili, inclusi quelli non corrispondenti a un VSID.

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

Parametri

Valori restituiti

Ottiene il conteggio dei job CodeQL in esecuzione e in coda e delle esecuzioni dinamiche di pipeline in volo per l'organizzazione.

function getCodeQLJobCount(): Promise<number>

Valori restituiti

Ottiene la configurazione predefinita attuale del programma di configurazione di CodeQL per l'organizzazione.

function getCodeQLSchedule(): Promise<CodeQLScheduleDetails>

Valori restituiti

Ottiene la configurazione predefinita attuale del programma di configurazione di CodeQL per l'organizzazione.

function getCodeQLScheduleLegacy(): Promise<CodeQLScheduleDetails>

Valori restituiti

Stimare i push che verrebbero aggiunti all'utilizzo del cliente se è stata abilitata la sicurezza avanzata per questo repository.

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

Parametri

Valori restituiti

Stimare i push che verrebbero aggiunti all'utilizzo del cliente se la sicurezza avanzata è stata abilitata per questa organizzazione.

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

Parametri

Valori restituiti

Stima i pusher che verrebbero aggiunti all'uso del cliente se la Sicurezza Avanzata fosse abilitata per questo project.

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

Parametri

Valori restituiti

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

Parametri

Valori restituiti

Ottenere i commiter usati per il calcolo delle informazioni di fatturazione.

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

Parametri

Valori restituiti

Ottenere lo stato corrente di Sicurezza avanzata per l'organizzazione

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

Parametri

Valori restituiti

Ottieni lo stato attuale di Advanced Security per un project

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

Parametri

Valori restituiti

Determina se la sicurezza del codice, la protezione dei segreti e le relative funzionalità sono abilitate per il repository.

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

Parametri

Valori restituiti

Aggiornamenti Valore del registro del pool di agenti per il pool di agenti selezionato Questo utilizza automaticamente il client http sottostante per i pool di agenti per validare che l'utente abbia i permessi di usare quel pool

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

Parametri

Valori restituiti

Imposta il giorno della settimana in cui la scansione predefinita di configurazione di CodeQL dovrebbe essere eseguita per l'organizzazione.

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

Parametri

Valori restituiti

Imposta il giorno della settimana in cui la scansione predefinita di configurazione di CodeQL dovrebbe essere eseguita per l'organizzazione.

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

Parametri

Valori restituiti

Aggiornare lo stato di Sicurezza avanzata per l'organizzazione

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

Parametri

Valori restituiti

Aggiorna lo stato di Advanced Security per il project

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

Parametri

Valori restituiti

Aggiornare lo stato di abilitazione della protezione del codice e della protezione dei segreti, insieme alle rispettive funzionalità, per un determinato repository.

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

Parametri

Valori restituiti