ManagementRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

RestClientBase

Konstruktor

ManagementRestClient(IVssRestClientOptions)

Metode

createBillingSnapshot2(MeterUsageForPlan, Plan)	Selama komputasi penagihan multi-organisasi di unit skala utama (EUS21), API ini digunakan untuk membuat rekam jepret penagihan untuk organisasi tertentu. Unit skala utama akan memanggil API ini untuk setiap organisasi di unit scsle yang berbeda untuk membuat rekam jepret penagihan. Data akan disimpan dalam tabel rekam jepret partisi spesifik organisasi DB -. Ini diperlukan karena pelanggan akan mengambil data penagihan dari DB partisi spesifik organisasi mereka.
getAdvancedSecurityAgentPoolSelection()	URL dasar untuk mendapatkan Semua Kumpulan Agen yang Tersedia + Kumpulan Agen yang Saat Ini Dipilih Ini adalah operasi baca-saja yang tidak memerlukan izin kelola.
getBillableCommitterDetails2(Plan, Date)	Dapatkan semua detail committer yang dapat ditagih, termasuk yang tidak cocok dengan VSID.
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)	Perkirakan pendorong yang akan ditambahkan ke penggunaan pelanggan jika Advanced Security diaktifkan untuk repositori ini.
getEstimatedBillablePushersDetailsForOrg2(Plan)	Perkirakan pendorong yang akan ditambahkan ke penggunaan pelanggan jika Advanced Security diaktifkan untuk organisasi ini.
getEstimatedBillablePushersDetailsForProject2(string, Plan)	Perkirakan pendorong yang akan ditambahkan ke penggunaan pelanggan jika Keamanan Lanjutan diaktifkan untuk project ini.
getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)	Dapatkan komiter yang digunakan saat menghitung informasi penagihan.
getOrgEnablementStatus2(boolean)	Mendapatkan status Keamanan Tingkat Lanjut saat ini untuk organisasi
getProjectEnablementStatus2(string, boolean)	Dapatkan status Keamanan Lanjutan saat ini untuk project
getRepoEnablementStatus2(string, string, boolean)	Menentukan apakah Keamanan Kode, Perlindungan Rahasia, dan fiturnya diaktifkan untuk repositori.
updateAdvancedSecurityAgentPoolSelection(string)	Memperbarui Nilai Registri Kumpulan Agen Untuk Kumpulan Agen yang Dipilih Ini secara otomatis menggunakan klien http yang mendasarinya untuk kumpulan agen untuk memvalidasi bahwa pengguna memiliki izin untuk menggunakan kumpulan tersebut
updateOrgEnablementStatus2(OrgEnablementSettings)	Memperbarui status Keamanan Tingkat Lanjut untuk organisasi
updateProjectEnablementStatus2(ProjectEnablementSettings, string)	Perbarui status Keamanan Lanjutan untuk project
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)	Perbarui status pengaktifan Keamanan Kode dan Perlindungan Rahasia, bersama dengan fitur masing-masing, untuk repositori tertentu.

Detail Konstruktor

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Metode

createBillingSnapshot2(MeterUsageForPlan, Plan)

Selama komputasi penagihan multi-organisasi di unit skala utama (EUS21), API ini digunakan untuk membuat rekam jepret penagihan untuk organisasi tertentu. Unit skala utama akan memanggil API ini untuk setiap organisasi di unit scsle yang berbeda untuk membuat rekam jepret penagihan. Data akan disimpan dalam tabel rekam jepret partisi spesifik organisasi DB -. Ini diperlukan karena pelanggan akan mengambil data penagihan dari DB partisi spesifik organisasi mereka.

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

Parameter

meterUsage

MeterUsageForPlan

plan

Plan

Mengembalikan

Promise<void>

getAdvancedSecurityAgentPoolSelection()

URL dasar untuk mendapatkan Semua Kumpulan Agen yang Tersedia + Kumpulan Agen yang Saat Ini Dipilih Ini adalah operasi baca-saja yang tidak memerlukan izin kelola.

function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>

Mengembalikan

Promise<AgentPoolDetails>

getBillableCommitterDetails2(Plan, Date)

Dapatkan semua detail committer yang dapat ditagih, termasuk yang tidak cocok dengan VSID.

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

Parameter

plan

Plan

Rencana untuk mengkueri. Paket yang didukung: CodeSecurity dan SecretProtection. Ini adalah parameter wajib.

billingDate

Date

Tanggal untuk mengkueri, atau jika tidak disediakan, hari ini

Mengembalikan

Promise<BillableCommitterDetails[]>

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

Perkirakan pendorong yang akan ditambahkan ke penggunaan pelanggan jika Advanced Security diaktifkan untuk repositori ini.

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

Parameter

project

string

ID Project atau nama project

repository

string

Nama atau ID repositori

plan

Plan

Rencana untuk mengkueri.

Mengembalikan

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForOrg2(Plan)

Perkirakan pendorong yang akan ditambahkan ke penggunaan pelanggan jika Advanced Security diaktifkan untuk organisasi ini.

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

Parameter

plan

Plan

Rencana untuk mengkueri.

Mengembalikan

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForProject2(string, Plan)

Perkirakan pendorong yang akan ditambahkan ke penggunaan pelanggan jika Keamanan Lanjutan diaktifkan untuk project ini.

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

Parameter

project

string

ID Project atau nama project

plan

Plan

Mengembalikan

Promise<MeterUsageEstimate>

getLastMeterUsage2(Plan)

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

Parameter

plan

Plan

Mengembalikan

Promise<MeterUsageForPlan>

getMeterUsage2(Plan, Date)

Dapatkan komiter yang digunakan saat menghitung informasi penagihan.

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

Parameter

plan

Plan

Rencana untuk mengkueri. Paket yang didukung: CodeSecurity dan SecretProtection. Ini adalah parameter wajib.

billingDate

Date

Tanggal untuk mengkueri, atau jika tidak disediakan, hari ini

Mengembalikan

Promise<MeterUsageForPlan>

getOrgEnablementStatus2(boolean)

Mendapatkan status Keamanan Tingkat Lanjut saat ini untuk organisasi

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

Parameter

includeAllProperties

boolean

Jika true, tentukan juga apakah dorongan diblokir jika berisi rahasia

Mengembalikan

Promise<OrgEnablementSettings>

getProjectEnablementStatus2(string, boolean)

Dapatkan status Keamanan Lanjutan saat ini untuk project

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

Parameter

project

string

ID Project atau nama project

includeAllProperties

boolean

Jika true, tentukan juga apakah dorongan diblokir jika berisi rahasia

Mengembalikan

Promise<ProjectEnablementSettings>

getRepoEnablementStatus2(string, string, boolean)

Menentukan apakah Keamanan Kode, Perlindungan Rahasia, dan fiturnya diaktifkan untuk repositori.

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

Parameter

project

string

ID Project atau nama project

repository

string

Nama atau ID repositori

includeAllProperties

boolean

Ketika true, juga akan menentukan apakah dorongan diblokir ketika rahasia terdeteksi

Mengembalikan

Promise<RepoEnablementSettings>

updateAdvancedSecurityAgentPoolSelection(string)

Memperbarui Nilai Registri Kumpulan Agen Untuk Kumpulan Agen yang Dipilih Ini secara otomatis menggunakan klien http yang mendasarinya untuk kumpulan agen untuk memvalidasi bahwa pengguna memiliki izin untuk menggunakan kumpulan tersebut

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

Parameter

agentPoolName

string

Mengembalikan

Promise<AgentPoolDetails>

updateOrgEnablementStatus2(OrgEnablementSettings)

Memperbarui status Keamanan Tingkat Lanjut untuk organisasi

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

Parameter

orgEnablementSettings

OrgEnablementSettings

Status baru

Mengembalikan

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Perbarui status Keamanan Lanjutan untuk project

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

Parameter

projectEnablementSettings

ProjectEnablementSettings

Status baru

project

string

ID Project atau nama project

Mengembalikan

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

Perbarui status pengaktifan Keamanan Kode dan Perlindungan Rahasia, bersama dengan fitur masing-masing, untuk repositori tertentu.

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

Parameter

repoEnablementSettings

RepoEnablementSettings

status baru

project

string

ID Project atau nama project

repository

string

Nama atau ID repositori

Mengembalikan

Promise<void>