ManagementRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igényléséhez (származtatásából) kell használni

Kiterjeszti

RestClientBase

Konstruktorok

ManagementRestClient(IVssRestClientOptions)

Módszerek

createBillingSnapshot2(MeterUsageForPlan, Plan)	Az elsődleges skálázási egység (EUS21) több szervezeti számlázási számítása során ez az API egy adott szervezet számlázási pillanatképének létrehozására szolgál. Az elsődleges skálázási egység meghívja ezt az API-t minden különböző scsle-egységben lévő szervezethez a számlázási pillanatkép létrehozásához. Az adatokat a rendszer a szervezet adott partícióadatbázisában tárolja – számlázási pillanatkép-táblában. Erre azért van szükség, mert az ügyfelek lekérik a számlázási adatokat a szervezetspecifikus partíció-adatbázisból.
getAdvancedSecurityAgentPoolSelection()	Alap URL az összes elérhető ügynök pool + Jelenleg kiválasztott ügynök pool megszerzéséhez Ez egy csak olvasható művelet, amely nem igényel kezelési jogosultságokat.
getBillableCommitterDetails2(Plan, Date)	Kérje le az összes számlázható véglegesítés adatait, beleértve a VSID-vel nem egyezőket is.
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)	Becsülje meg azokat a leküldéses adatokat, amelyeket az ügyfél használatába adna, ha az Advanced Security engedélyezve lett volna ehhez az adattárhoz.
getEstimatedBillablePushersDetailsForOrg2(Plan)	Becsülje meg azokat a leküldéses adatokat, amelyeket az ügyfél használatához adna hozzá, ha az Advanced Security engedélyezve lett volna ehhez a szervezethez.
getEstimatedBillablePushersDetailsForProject2(string, Plan)	Becsüld meg azokat a pushereket, amelyek hozzáadnák az ügyfél használatát, ha az Advanced Security bekapcsolva lenne ehhez a projekthez.
getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)	Lekérheti a számlázási adatok kiszámításához használt véglegesítőket.
getOrgEnablementStatus2(boolean)	Az Advanced Security aktuális állapotának lekérése a szervezet számára
getProjectEnablementStatus2(string, boolean)	Szerezze meg az Advanced Security aktuális státuszát egy project esetében
getRepoEnablementStatus2(string, string, boolean)	Meghatározza, hogy a kódbiztonság, a titkos kódvédelem és azok szolgáltatásai engedélyezve vannak-e az adattárban.
updateAdvancedSecurityAgentPoolSelection(string)	Frissíti az ügynök pool adatbázis értékét a kiválasztott ügynök poolhoz Ez automatikusan használja az ügynökpoolok http klienszét annak ellenőrzésére, hogy a felhasználónak van jogosultsága a pool használatára
updateOrgEnablementStatus2(OrgEnablementSettings)	Az Advanced Security állapotának frissítése a szervezet számára
updateProjectEnablementStatus2(ProjectEnablementSettings, string)	Frissítse az Advanced Security állapotát a project számára
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)	Frissítse a Code Security és a Secret Protection engedélyezési állapotát, valamint a hozzájuk tartozó funkciókat egy adott adattárhoz.

Építő részletek

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Módszer részletei

createBillingSnapshot2(MeterUsageForPlan, Plan)

Az elsődleges skálázási egység (EUS21) több szervezeti számlázási számítása során ez az API egy adott szervezet számlázási pillanatképének létrehozására szolgál. Az elsődleges skálázási egység meghívja ezt az API-t minden különböző scsle-egységben lévő szervezethez a számlázási pillanatkép létrehozásához. Az adatokat a rendszer a szervezet adott partícióadatbázisában tárolja – számlázási pillanatkép-táblában. Erre azért van szükség, mert az ügyfelek lekérik a számlázási adatokat a szervezetspecifikus partíció-adatbázisból.

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

Paraméterek

meterUsage

MeterUsageForPlan

plan

Plan

Visszatér

Promise<void>

getAdvancedSecurityAgentPoolSelection()

Alap URL az összes elérhető ügynök pool + Jelenleg kiválasztott ügynök pool megszerzéséhez Ez egy csak olvasható művelet, amely nem igényel kezelési jogosultságokat.

function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>

Visszatér

Promise<AgentPoolDetails>

getBillableCommitterDetails2(Plan, Date)

Kérje le az összes számlázható véglegesítés adatait, beleértve a VSID-vel nem egyezőket is.

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

Paraméterek

plan

Plan

A lekérdezés terve. Támogatott csomagok: CodeSecurity és SecretProtection. Ez egy kötelező paraméter.

billingDate

Date

A lekérdezés dátuma, vagy ha nincs megadva, ma

Visszatér

Promise<BillableCommitterDetails[]>

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

Becsülje meg azokat a leküldéses adatokat, amelyeket az ügyfél használatába adna, ha az Advanced Security engedélyezve lett volna ehhez az adattárhoz.

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

Paraméterek

project

string

Project ID vagy project név

repository

string

Az adattár neve vagy azonosítója

plan

Plan

A lekérdezés terve.

Visszatér

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForOrg2(Plan)

Becsülje meg azokat a leküldéses adatokat, amelyeket az ügyfél használatához adna hozzá, ha az Advanced Security engedélyezve lett volna ehhez a szervezethez.

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

Paraméterek

plan

Plan

A lekérdezés terve.

Visszatér

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForProject2(string, Plan)

Becsüld meg azokat a pushereket, amelyek hozzáadnák az ügyfél használatát, ha az Advanced Security bekapcsolva lenne ehhez a projekthez.

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

Paraméterek

project

string

Project ID vagy project név

plan

Plan

Visszatér

Promise<MeterUsageEstimate>

getLastMeterUsage2(Plan)

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

Paraméterek

plan

Plan

Visszatér

Promise<MeterUsageForPlan>

getMeterUsage2(Plan, Date)

Lekérheti a számlázási adatok kiszámításához használt véglegesítőket.

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

Paraméterek

plan

Plan

A lekérdezés terve. Támogatott csomagok: CodeSecurity és SecretProtection. Ez egy kötelező paraméter.

billingDate

Date

A lekérdezés dátuma, vagy ha nincs megadva, ma

Visszatér

Promise<MeterUsageForPlan>

getOrgEnablementStatus2(boolean)

Az Advanced Security aktuális állapotának lekérése a szervezet számára

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

Paraméterek

includeAllProperties

boolean

Ha igaz, azt is megállapíthatja, hogy a leküldések blokkolva vannak-e, ha titkos kulcsokat tartalmaznak

Visszatér

Promise<OrgEnablementSettings>

getProjectEnablementStatus2(string, boolean)

Szerezze meg az Advanced Security aktuális státuszát egy project esetében

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

Paraméterek

project

string

Project ID vagy project név

includeAllProperties

boolean

Ha igaz, azt is megállapíthatja, hogy a leküldések blokkolva vannak-e, ha titkos kulcsokat tartalmaznak

Visszatér

Promise<ProjectEnablementSettings>

getRepoEnablementStatus2(string, string, boolean)

Meghatározza, hogy a kódbiztonság, a titkos kódvédelem és azok szolgáltatásai engedélyezve vannak-e az adattárban.

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

Paraméterek

project

string

Project ID vagy project név

repository

string

Az adattár neve vagy azonosítója

includeAllProperties

boolean

Ha igaz, azt is meghatározza, hogy a leküldések blokkolva vannak-e a titkos kódok észlelésekor

Visszatér

Promise<RepoEnablementSettings>

updateAdvancedSecurityAgentPoolSelection(string)

Frissíti az ügynök pool adatbázis értékét a kiválasztott ügynök poolhoz Ez automatikusan használja az ügynökpoolok http klienszét annak ellenőrzésére, hogy a felhasználónak van jogosultsága a pool használatára

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

Paraméterek

agentPoolName

string

Visszatér

Promise<AgentPoolDetails>

updateOrgEnablementStatus2(OrgEnablementSettings)

Az Advanced Security állapotának frissítése a szervezet számára

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

Paraméterek

orgEnablementSettings

OrgEnablementSettings

Az új állapot

Visszatér

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Frissítse az Advanced Security állapotát a project számára

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

Paraméterek

projectEnablementSettings

ProjectEnablementSettings

Az új állapot

project

string

Project ID vagy project név

Visszatér

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

Frissítse a Code Security és a Secret Protection engedélyezési állapotát, valamint a hozzájuk tartozó funkciókat egy adott adattárhoz.

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

Paraméterek

repoEnablementSettings

RepoEnablementSettings

új állapot

project

string

Project ID vagy project név

repository

string

Az adattár neve vagy azonosítója

Visszatér

Promise<void>