ManagementRestClient class
Classe di base da usare (derivata da) per effettuare richieste alle API REST vss
- Extends
Costruttori
| Management |
Metodi
| create |
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 verranno archiviati nel database di partizione specifico dell'organizzazione: tabella snapshot di fatturazione. Questa operazione è necessaria perché i clienti recupereranno i dati di fatturazione dal database di partizione specifico dell'organizzazione. |
| get |
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. |
| get |
Ottenere tutti i dettagli dei commit fatturabili, inclusi quelli non corrispondenti a un VSID. |
| get |
Stimare i push che verrebbero aggiunti all'utilizzo del cliente se è stata abilitata la sicurezza avanzata per questo repository. |
| get |
Stimare i push che verrebbero aggiunti all'utilizzo del cliente se la sicurezza avanzata è stata abilitata per questa organizzazione. |
| get |
Stima i pusher che verrebbero aggiunti all'uso del cliente se la Sicurezza Avanzata fosse abilitata per questo project. |
| get |
|
| get |
Ottenere i commiter usati per il calcolo delle informazioni di fatturazione. |
| get |
Ottenere lo stato corrente di Sicurezza avanzata per l'organizzazione |
| get |
Ottieni lo stato attuale di Advanced Security per un project |
| get |
Determina se la sicurezza del codice, la protezione dei segreti e le relative funzionalità sono abilitate per il repository. |
| update |
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 |
| update |
Aggiornare lo stato di Sicurezza avanzata per l'organizzazione |
| update |
Aggiorna lo stato di Advanced Security per il project |
| update |
Aggiornare lo stato di abilitazione della protezione del codice e della protezione dei segreti, insieme alle rispettive funzionalità, per un determinato repository. |
Dettagli costruttore
ManagementRestClient(IVssRestClientOptions)
Dettagli metodo
createBillingSnapshot2(MeterUsageForPlan, Plan)
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 verranno archiviati nel database di partizione specifico dell'organizzazione: tabella 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
- meterUsage
- MeterUsageForPlan
- plan
- Plan
Restituisce
Promise<void>
getAdvancedSecurityAgentPoolSelection()
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>
Restituisce
Promise<AgentPoolDetails>
getBillableCommitterDetails2(Plan, Date)
Ottenere tutti i dettagli dei commit fatturabili, inclusi quelli non corrispondenti a un VSID.
function getBillableCommitterDetails2(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>
Parametri
- plan
- Plan
Piano di query. Piani supportati: CodeSecurity e SecretProtection. Si tratta di un parametro obbligatorio.
- billingDate
-
Date
Data di query, o se non specificata, oggi
Restituisce
Promise<BillableCommitterDetails[]>
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)
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
- project
-
string
ID Project o nome del project
- repository
-
string
Nome o ID del repository
- plan
- Plan
Piano di query.
Restituisce
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForOrg2(Plan)
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
- plan
- Plan
Piano di query.
Restituisce
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject2(string, Plan)
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
- project
-
string
ID Project o nome del project
- plan
- Plan
Restituisce
Promise<MeterUsageEstimate>
getLastMeterUsage2(Plan)
function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>
Parametri
- plan
- Plan
Restituisce
Promise<MeterUsageForPlan>
getMeterUsage2(Plan, Date)
Ottenere i commiter usati per il calcolo delle informazioni di fatturazione.
function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>
Parametri
- plan
- Plan
Piano di query. Piani supportati: CodeSecurity e SecretProtection. Si tratta di un parametro obbligatorio.
- billingDate
-
Date
Data di query, o se non specificata, oggi
Restituisce
Promise<MeterUsageForPlan>
getOrgEnablementStatus2(boolean)
Ottenere lo stato corrente di Sicurezza avanzata per l'organizzazione
function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>
Parametri
- includeAllProperties
-
boolean
Se true, determinare anche se i push vengono bloccati se contengono segreti
Restituisce
Promise<OrgEnablementSettings>
getProjectEnablementStatus2(string, boolean)
Ottieni lo stato attuale di Advanced Security per un project
function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>
Parametri
- project
-
string
ID Project o nome del project
- includeAllProperties
-
boolean
Se true, determinare anche se i push vengono bloccati se contengono segreti
Restituisce
Promise<ProjectEnablementSettings>
getRepoEnablementStatus2(string, string, boolean)
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
- project
-
string
ID Project o nome del project
- repository
-
string
Nome o ID del repository
- includeAllProperties
-
boolean
Se true, determinerà anche se i push vengono bloccati quando vengono rilevati segreti
Restituisce
Promise<RepoEnablementSettings>
updateAdvancedSecurityAgentPoolSelection(string)
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
- agentPoolName
-
string
Restituisce
Promise<AgentPoolDetails>
updateOrgEnablementStatus2(OrgEnablementSettings)
Aggiornare lo stato di Sicurezza avanzata per l'organizzazione
function updateOrgEnablementStatus2(orgEnablementSettings: OrgEnablementSettings): Promise<void>
Parametri
- orgEnablementSettings
- OrgEnablementSettings
Nuovo stato
Restituisce
Promise<void>
updateProjectEnablementStatus2(ProjectEnablementSettings, string)
Aggiorna lo stato di Advanced Security per il project
function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>
Parametri
- projectEnablementSettings
- ProjectEnablementSettings
Nuovo stato
- project
-
string
ID Project o nome del project
Restituisce
Promise<void>
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)
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
- repoEnablementSettings
- RepoEnablementSettings
Nuovo stato
- project
-
string
ID Project o nome del project
- repository
-
string
Nome o ID del repository
Restituisce
Promise<void>