ManagementRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

RestClientBase

Konstruktory

ManagementRestClient(IVssRestClientOptions)

Metody

cancelCodeQLJobs()	Ruší všechny běžící a frontované CodeQL úlohy a běhy dynamického pipeline během běhu organizace.
createBillingSnapshot2(MeterUsageForPlan, Plan)	Během výpočtu fakturace ve více organizacích v primární jednotce škálování (EUS21) se toto rozhraní API používá k vytvoření snímku fakturace pro konkrétní organizaci. Primární jednotka škálování bude volat toto rozhraní API pro každou organizaci v různých jednotkách scsle, aby vytvořila snímek fakturace. Data budou uložena v oddílu DB specifickém pro organizaci –> tabulka snímků fakturace. To je potřeba, protože zákazníci budou načítat fakturační údaje z databáze oddílů specifických pro jejich organizaci.
getAdvancedSecurityAgentPoolSelection()	Základní URL pro získání všech dostupných agentních poolů + aktuálně vybraného agentního poolu Toto je operace pouze pro čtení, která nevyžaduje oprávnění spravovat.
getBillableCommitterDetails2(Plan, Date)	Získejte všechny podrobnosti o fakturovatelných vývojářích, včetně těch, které nejsou spárovány s VSID.
getCodeQLJobCount()	Získává počet spuštěných a zařazených CodeQL úloh a spuštěných Dynamic Pipeline během běhu pro organizaci.
getCodeQLSchedule()	Získá aktuální výchozí konfiguraci CodeQL pro organizaci.
getCodeQLScheduleLegacy()	Získá aktuální výchozí konfiguraci CodeQL pro organizaci.
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)	Odhadněte nabízené servery, které by byly přidány k využití zákazníkem, pokud by pro toto úložiště bylo povoleno pokročilé zabezpečení.
getEstimatedBillablePushersDetailsForOrg2(Plan)	Odhadněte pushery, které by byly přidány k využití zákazníkem, pokud by bylo pro tuto organizaci povoleno pokročilé zabezpečení.
getEstimatedBillablePushersDetailsForProject2(string, Plan)	Odhadněte pushery, které by byly přidány k využití zákazníka, pokud by byl pro tento projekt povolen Advanced Security.
getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)	Získejte potvrzení, které se používají při výpočtu fakturačních údajů.
getOrgEnablementStatus2(boolean)	Získání aktuálního stavu rozšířeného zabezpečení pro organizaci
getProjectEnablementStatus2(string, boolean)	Zjistěte aktuální stav Pokročilé bezpečnosti pro projekt
getRepoEnablementStatus2(string, string, boolean)	Určuje, jestli je pro úložiště povolené zabezpečení kódu, ochrana tajných kódů a jejich funkce.
updateAdvancedSecurityAgentPoolSelection(string)	Aktualizuje hodnotu registru agentního poolu pro vybraný agent pool Tímto se automaticky používá základní HTTP klient pro agentní pooly k ověření, že uživatel má oprávnění tento pool používat
updateCodeQLSchedule(number)	Nastavuje den v týdnu, kdy by měl pro organizaci běžet výchozí setup scan CodeQL.
updateCodeQLScheduleLegacy(number)	Nastavuje den v týdnu, kdy by měl pro organizaci běžet výchozí setup scan CodeQL.
updateOrgEnablementStatus2(OrgEnablementSettings)	Aktualizace stavu rozšířeného zabezpečení pro organizaci
updateProjectEnablementStatus2(ProjectEnablementSettings, string)	Aktualizovat stav pokročilé bezpečnosti pro projekt
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)	Aktualizujte stav povolení zabezpečení kódu a ochrany tajných kódů spolu s příslušnými funkcemi pro dané úložiště.

Podrobnosti konstruktoru

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti metody

cancelCodeQLJobs()

Ruší všechny běžící a frontované CodeQL úlohy a běhy dynamického pipeline během běhu organizace.

function cancelCodeQLJobs(): Promise<number>

Návraty

Promise<number>

createBillingSnapshot2(MeterUsageForPlan, Plan)

Během výpočtu fakturace ve více organizacích v primární jednotce škálování (EUS21) se toto rozhraní API používá k vytvoření snímku fakturace pro konkrétní organizaci. Primární jednotka škálování bude volat toto rozhraní API pro každou organizaci v různých jednotkách scsle, aby vytvořila snímek fakturace. Data budou uložena v oddílu DB specifickém pro organizaci –> tabulka snímků fakturace. To je potřeba, protože zákazníci budou načítat fakturační údaje z databáze oddílů specifických pro jejich organizaci.

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

Parametry

meterUsage

MeterUsageForPlan

plan

Plan

Návraty

Promise<void>

getAdvancedSecurityAgentPoolSelection()

Základní URL pro získání všech dostupných agentních poolů + aktuálně vybraného agentního poolu Toto je operace pouze pro čtení, která nevyžaduje oprávnění spravovat.

function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>

Návraty

Promise<AgentPoolDetails>

getBillableCommitterDetails2(Plan, Date)

Získejte všechny podrobnosti o fakturovatelných vývojářích, včetně těch, které nejsou spárovány s VSID.

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

Parametry

plan

Plan

Plán dotazování. Podporované plány: CodeSecurity a SecretProtection. Toto je povinný parametr.

billingDate

Date

Datum dotazování nebo pokud není k dispozici dnes

Návraty

Promise<BillableCommitterDetails[]>

getCodeQLJobCount()

Získává počet spuštěných a zařazených CodeQL úloh a spuštěných Dynamic Pipeline během běhu pro organizaci.

function getCodeQLJobCount(): Promise<number>

Návraty

Promise<number>

getCodeQLSchedule()

Získá aktuální výchozí konfiguraci CodeQL pro organizaci.

function getCodeQLSchedule(): Promise<CodeQLScheduleDetails>

Návraty

Promise<CodeQLScheduleDetails>

getCodeQLScheduleLegacy()

Získá aktuální výchozí konfiguraci CodeQL pro organizaci.

function getCodeQLScheduleLegacy(): Promise<CodeQLScheduleDetails>

Návraty

Promise<CodeQLScheduleDetails>

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

Odhadněte nabízené servery, které by byly přidány k využití zákazníkem, pokud by pro toto úložiště bylo povoleno pokročilé zabezpečení.

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

Parametry

project

string

Project ID nebo název project

repository

string

Název nebo ID úložiště

plan

Plan

Plán dotazování.

Návraty

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForOrg2(Plan)

Odhadněte pushery, které by byly přidány k využití zákazníkem, pokud by bylo pro tuto organizaci povoleno pokročilé zabezpečení.

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

Parametry

plan

Plan

Plán dotazování.

Návraty

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForProject2(string, Plan)

Odhadněte pushery, které by byly přidány k využití zákazníka, pokud by byl pro tento projekt povolen Advanced Security.

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

Parametry

project

string

Project ID nebo název project

plan

Plan

Návraty

Promise<MeterUsageEstimate>

getLastMeterUsage2(Plan)

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

Parametry

plan

Plan

Návraty

Promise<MeterUsageForPlan>

getMeterUsage2(Plan, Date)

Získejte potvrzení, které se používají při výpočtu fakturačních údajů.

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

Parametry

plan

Plan

Plán dotazování. Podporované plány: CodeSecurity a SecretProtection. Toto je povinný parametr.

billingDate

Date

Datum dotazování nebo pokud není k dispozici dnes

Návraty

Promise<MeterUsageForPlan>

getOrgEnablementStatus2(boolean)

Získání aktuálního stavu rozšířeného zabezpečení pro organizaci

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

Parametry

includeAllProperties

boolean

Pokud je true, určete také, jestli jsou nabízená oznámení blokovaná, pokud obsahují tajné kódy.

Návraty

Promise<OrgEnablementSettings>

getProjectEnablementStatus2(string, boolean)

Zjistěte aktuální stav Pokročilé bezpečnosti pro projekt

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

Parametry

project

string

Project ID nebo název project

includeAllProperties

boolean

Pokud je true, určete také, jestli jsou nabízená oznámení blokovaná, pokud obsahují tajné kódy.

Návraty

Promise<ProjectEnablementSettings>

getRepoEnablementStatus2(string, string, boolean)

Určuje, jestli je pro úložiště povolené zabezpečení kódu, ochrana tajných kódů a jejich funkce.

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

Parametry

project

string

Project ID nebo název project

repository

string

Název nebo ID úložiště

includeAllProperties

boolean

Pokud je true, určí se také, jestli se zápisy zablokují, když se zjistí tajné kódy.

Návraty

Promise<RepoEnablementSettings>

updateAdvancedSecurityAgentPoolSelection(string)

Aktualizuje hodnotu registru agentního poolu pro vybraný agent pool Tímto se automaticky používá základní HTTP klient pro agentní pooly k ověření, že uživatel má oprávnění tento pool používat

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

Parametry

agentPoolName

string

Návraty

Promise<AgentPoolDetails>

updateCodeQLSchedule(number)

Nastavuje den v týdnu, kdy by měl pro organizaci běžet výchozí setup scan CodeQL.

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

Parametry

scheduleDayOfWeek

number

Den v týdnu jako celé číslo: 0=neděle, 1=pondělí, ..., 6=sobota.

Návraty

Promise<CodeQLScheduleDetails>

updateCodeQLScheduleLegacy(number)

Nastavuje den v týdnu, kdy by měl pro organizaci běžet výchozí setup scan CodeQL.

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

Parametry

scheduleDayOfWeek

number

Den v týdnu jako celé číslo: 0=neděle, 1=pondělí, ..., 6=sobota.

Návraty

Promise<CodeQLScheduleDetails>

updateOrgEnablementStatus2(OrgEnablementSettings)

Aktualizace stavu rozšířeného zabezpečení pro organizaci

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

Parametry

orgEnablementSettings

OrgEnablementSettings

Nový stav

Návraty

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Aktualizovat stav pokročilé bezpečnosti pro projekt

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

Parametry

projectEnablementSettings

ProjectEnablementSettings

Nový stav

project

string

Project ID nebo název project

Návraty

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

Aktualizujte stav povolení zabezpečení kódu a ochrany tajných kódů spolu s příslušnými funkcemi pro dané úložiště.

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

Parametry

repoEnablementSettings

RepoEnablementSettings

Nový stav

project

string

Project ID nebo název project

repository

string

Název nebo ID úložiště

Návraty

Promise<void>