ManagementRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

ManagementRestClient(IVssRestClientOptions)

Yöntemler

createBillingSnapshot3(MeterUsageForPlan, Plan)	Birincil ölçek biriminde (EUS21) çok kuruluşlu faturalama hesaplaması sırasında, bu API belirli bir kuruluş için faturalama anlık görüntüsü oluşturmak için kullanılır. Birincil ölçek birimi, faturalama anlık görüntüsü oluşturmak üzere farklı scsle birimlerindeki her kuruluş için bu API'yi çağırır. Veriler kuruluşa özgü bölüm db'sinde ( faturalama anlık görüntüsü tablosunda>) depolanır. Müşteriler kuruluşa özgü bölüm veritabanından faturalama verilerini getireceği için bu gereklidir.
getBillableCommitterDetails3(Plan, Date)	VSID ile eşleşmeyenler de dahil olmak üzere tüm faturalanabilir işleme ayrıntılarını alın.
getEstimatedBillableCommittersDetailsForRepo3(string, string, Plan)	Bu depo için Gelişmiş Güvenlik etkinleştirildiyse müşterinin kullanımına eklenecek göndericileri tahmin edin.
getEstimatedBillablePushersDetailsForOrg3(Plan)	Bu kuruluş için Gelişmiş Güvenlik etkinleştirildiyse müşterinin kullanımına eklenecek gönderimcileri tahmin edin.
getEstimatedBillablePushersDetailsForProject3(string, Plan)	Bu proje için Gelişmiş Güvenlik etkinleştirildiyse müşterinin kullanımına eklenecek gönderimcileri tahmin edin.
getLastMeterUsage3(Plan)
getMeterUsage3(Plan, Date)	Faturalama bilgilerini hesaplarken kullanılan işlemecileri alma.
getOrgEnablementStatus3(boolean)	Kuruluş için Gelişmiş Güvenlik'in geçerli durumunu alma
getProjectEnablementStatus3(string, boolean)	Bir proje için Gelişmiş Güvenlik'in geçerli durumunu alma
getRepoEnablementStatus3(string, string, boolean)	Kod Güvenliği, Gizli Dizi Koruması ve bunların özelliklerinin depo için etkinleştirilip etkinleştirilmediğini belirler.
updateOrgEnablementStatus3(OrgEnablementSettings)	Kuruluş için Gelişmiş Güvenlik durumunu güncelleştirme
updateProjectEnablementStatus3(ProjectEnablementSettings, string)	Proje için Gelişmiş Güvenlik durumunu güncelleştirme
updateRepoAdvSecEnablementStatus3(RepoEnablementSettings, string, string)	Belirli bir depo için ilgili özellikleriyle birlikte Kod Güvenliği ve Gizli Dizi Koruması'nın etkinleştirme durumunu güncelleştirin.

Oluşturucu Ayrıntıları

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Yöntem Ayrıntıları

createBillingSnapshot3(MeterUsageForPlan, Plan)

Birincil ölçek biriminde (EUS21) çok kuruluşlu faturalama hesaplaması sırasında, bu API belirli bir kuruluş için faturalama anlık görüntüsü oluşturmak için kullanılır. Birincil ölçek birimi, faturalama anlık görüntüsü oluşturmak üzere farklı scsle birimlerindeki her kuruluş için bu API'yi çağırır. Veriler kuruluşa özgü bölüm db'sinde ( faturalama anlık görüntüsü tablosunda>) depolanır. Müşteriler kuruluşa özgü bölüm veritabanından faturalama verilerini getireceği için bu gereklidir.

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

Parametreler

meterUsage

MeterUsageForPlan

plan

Plan

Döndürülenler

Promise<void>

getBillableCommitterDetails3(Plan, Date)

VSID ile eşleşmeyenler de dahil olmak üzere tüm faturalanabilir işleme ayrıntılarını alın.

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

Parametreler

plan

Plan

Sorgulama planı. Desteklenen planlar: CodeSecurity ve SecretProtection. Bu zorunlu bir parametredir.

billingDate

Date

Sorgulanacak tarih veya sağlanmadıysa, bugün

Döndürülenler

Promise<BillableCommitterDetails[]>

getEstimatedBillableCommittersDetailsForRepo3(string, string, Plan)

Bu depo için Gelişmiş Güvenlik etkinleştirildiyse müşterinin kullanımına eklenecek göndericileri tahmin edin.

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

Parametreler

project

string

Proje kimliği veya proje adı

repository

string

Deponun adı veya kimliği

plan

Plan

Sorgulama planı.

Döndürülenler

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForOrg3(Plan)

Bu kuruluş için Gelişmiş Güvenlik etkinleştirildiyse müşterinin kullanımına eklenecek gönderimcileri tahmin edin.

function getEstimatedBillablePushersDetailsForOrg3(plan: Plan): Promise<MeterUsageEstimate>

Parametreler

plan

Plan

Sorgulama planı.

Döndürülenler

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForProject3(string, Plan)

Bu proje için Gelişmiş Güvenlik etkinleştirildiyse müşterinin kullanımına eklenecek gönderimcileri tahmin edin.

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

Parametreler

project

string

Proje kimliği veya proje adı

plan

Plan

Döndürülenler

Promise<MeterUsageEstimate>

getLastMeterUsage3(Plan)

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

Parametreler

plan

Plan

Döndürülenler

Promise<MeterUsageForPlan>

getMeterUsage3(Plan, Date)

Faturalama bilgilerini hesaplarken kullanılan işlemecileri alma.

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

Parametreler

plan

Plan

Sorgulama planı. Desteklenen planlar: CodeSecurity ve SecretProtection. Bu zorunlu bir parametredir.

billingDate

Date

Sorgulanacak tarih veya sağlanmadıysa, bugün

Döndürülenler

Promise<MeterUsageForPlan>

getOrgEnablementStatus3(boolean)

Kuruluş için Gelişmiş Güvenlik'in geçerli durumunu alma

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

Parametreler

includeAllProperties

boolean

True olduğunda, gizli diziler içeren göndermelerin engellenip engellenmediğini de belirleyin

Döndürülenler

Promise<OrgEnablementSettings>

getProjectEnablementStatus3(string, boolean)

Bir proje için Gelişmiş Güvenlik'in geçerli durumunu alma

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

Parametreler

project

string

Proje kimliği veya proje adı

includeAllProperties

boolean

True olduğunda, gizli diziler içeren göndermelerin engellenip engellenmediğini de belirleyin

Döndürülenler

Promise<ProjectEnablementSettings>

getRepoEnablementStatus3(string, string, boolean)

Kod Güvenliği, Gizli Dizi Koruması ve bunların özelliklerinin depo için etkinleştirilip etkinleştirilmediğini belirler.

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

Parametreler

project

string

Proje kimliği veya proje adı

repository

string

Deponun adı veya kimliği

includeAllProperties

boolean

True olduğunda, gizli diziler algılandığında gönderimlerin engellenip engellenmediğini de belirler

Döndürülenler

Promise<RepoEnablementSettings>

updateOrgEnablementStatus3(OrgEnablementSettings)

Kuruluş için Gelişmiş Güvenlik durumunu güncelleştirme

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

Parametreler

orgEnablementSettings

OrgEnablementSettings

Yeni durum

Döndürülenler

Promise<void>

updateProjectEnablementStatus3(ProjectEnablementSettings, string)

Proje için Gelişmiş Güvenlik durumunu güncelleştirme

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

Parametreler

projectEnablementSettings

ProjectEnablementSettings

Yeni durum

project

string

Proje kimliği veya proje adı

Döndürülenler

Promise<void>

updateRepoAdvSecEnablementStatus3(RepoEnablementSettings, string, string)

Belirli bir depo için ilgili özellikleriyle birlikte Kod Güvenliği ve Gizli Dizi Koruması'nın etkinleştirme durumunu güncelleştirin.

function updateRepoAdvSecEnablementStatus3(savedAdvSecEnablementStatus: RepoEnablementSettings, project: string, repository: string): Promise<void>

Parametreler

savedAdvSecEnablementStatus

RepoEnablementSettings

new status

project

string

Proje kimliği veya proje adı

repository

string

Deponun adı veya kimliği

Döndürülenler

Promise<void>