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 |
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 |
Stimare i push che verrebbero aggiunti all'utilizzo del cliente se è stata abilitata la sicurezza avanzata per questo progetto. |
| 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 |
Ottenere lo stato corrente di Sicurezza avanzata per un progetto |
| get |
Determina se la sicurezza del codice, la protezione dei segreti e le relative funzionalità sono abilitate per il repository. |
| update |
Aggiornare lo stato di Sicurezza avanzata per l'organizzazione |
| update |
Aggiornare lo stato di Sicurezza avanzata per il progetto |
| 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
createBillingSnapshot3(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 createBillingSnapshot3(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>Parametri
- meterUsage
- MeterUsageForPlan
- plan
- Plan
Restituisce
Promise<void>
getBillableCommitterDetails3(Plan, Date)
Ottenere tutti i dettagli dei commit fatturabili, inclusi quelli non corrispondenti a un VSID.
function getBillableCommitterDetails3(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[]>
getEstimatedBillableCommittersDetailsForRepo3(string, string, Plan)
Stimare i push che verrebbero aggiunti all'utilizzo del cliente se è stata abilitata la sicurezza avanzata per questo repository.
function getEstimatedBillableCommittersDetailsForRepo3(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>Parametri
- project
-
string
ID progetto o nome progetto
- repository
-
string
Nome o ID del repository
- plan
- Plan
Piano di query.
Restituisce
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForOrg3(Plan)
Stimare i push che verrebbero aggiunti all'utilizzo del cliente se la sicurezza avanzata è stata abilitata per questa organizzazione.
function getEstimatedBillablePushersDetailsForOrg3(plan: Plan): Promise<MeterUsageEstimate>Parametri
- plan
- Plan
Piano di query.
Restituisce
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject3(string, Plan)
Stimare i push che verrebbero aggiunti all'utilizzo del cliente se è stata abilitata la sicurezza avanzata per questo progetto.
function getEstimatedBillablePushersDetailsForProject3(project: string, plan?: Plan): Promise<MeterUsageEstimate>Parametri
- project
-
string
ID progetto o nome progetto
- plan
- Plan
Restituisce
Promise<MeterUsageEstimate>
getLastMeterUsage3(Plan)
function getLastMeterUsage3(plan: Plan): Promise<MeterUsageForPlan>Parametri
- plan
- Plan
Restituisce
Promise<MeterUsageForPlan>
getMeterUsage3(Plan, Date)
Ottenere i commiter usati per il calcolo delle informazioni di fatturazione.
function getMeterUsage3(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>
getOrgEnablementStatus3(boolean)
Ottenere lo stato corrente di Sicurezza avanzata per l'organizzazione
function getOrgEnablementStatus3(includeAllProperties?: boolean): Promise<OrgEnablementSettings>Parametri
- includeAllProperties
-
boolean
Se true, determinare anche se i push vengono bloccati se contengono segreti
Restituisce
Promise<OrgEnablementSettings>
getProjectEnablementStatus3(string, boolean)
Ottenere lo stato corrente di Sicurezza avanzata per un progetto
function getProjectEnablementStatus3(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>Parametri
- project
-
string
ID progetto o nome progetto
- includeAllProperties
-
boolean
Se true, determinare anche se i push vengono bloccati se contengono segreti
Restituisce
Promise<ProjectEnablementSettings>
getRepoEnablementStatus3(string, string, boolean)
Determina se la sicurezza del codice, la protezione dei segreti e le relative funzionalità sono abilitate per il repository.
function getRepoEnablementStatus3(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>Parametri
- project
-
string
ID progetto o nome progetto
- 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>
updateOrgEnablementStatus3(OrgEnablementSettings)
Aggiornare lo stato di Sicurezza avanzata per l'organizzazione
function updateOrgEnablementStatus3(orgEnablementSettings: OrgEnablementSettings): Promise<void>Parametri
- orgEnablementSettings
- OrgEnablementSettings
Nuovo stato
Restituisce
Promise<void>
updateProjectEnablementStatus3(ProjectEnablementSettings, string)
Aggiornare lo stato di Sicurezza avanzata per il progetto
function updateProjectEnablementStatus3(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>Parametri
- projectEnablementSettings
- ProjectEnablementSettings
Nuovo stato
- project
-
string
ID progetto o nome progetto
Restituisce
Promise<void>
updateRepoAdvSecEnablementStatus3(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 updateRepoAdvSecEnablementStatus3(savedAdvSecEnablementStatus: RepoEnablementSettings, project: string, repository: string): Promise<void>Parametri
- savedAdvSecEnablementStatus
- RepoEnablementSettings
new status
- project
-
string
ID progetto o nome progetto
- repository
-
string
Nome o ID del repository
Restituisce
Promise<void>