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

createBillingSnapshot2(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.
getAdvancedSecurityAgentPoolSelection()	Tüm Mevcut Ajan Havuzlarını + Şu Anda Seçilmiş Ajan Havuzunu almak için temel URL Bu, yönetme izni gerektirmeyen yalnızca okunabilir bir işlemdir.
getBillableCommitterDetails2(Plan, Date)	VSID ile eşleşmeyenler de dahil olmak üzere tüm faturalanabilir işleme ayrıntılarını alın.
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)	Bu depo için Gelişmiş Güvenlik etkinleştirildiyse müşterinin kullanımına eklenecek göndericileri tahmin edin.
getEstimatedBillablePushersDetailsForOrg2(Plan)	Bu kuruluş için Gelişmiş Güvenlik etkinleştirildiyse müşterinin kullanımına eklenecek gönderimcileri tahmin edin.
getEstimatedBillablePushersDetailsForProject2(string, Plan)	Bu proje için Gelişmiş Güvenlik etkinleştirilseydi müşterinin kullanımına eklenecek pusher'ları tahmin edin.
getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)	Faturalama bilgilerini hesaplarken kullanılan işlemecileri alma.
getOrgEnablementStatus2(boolean)	Kuruluş için Gelişmiş Güvenlik'in geçerli durumunu alma
getProjectEnablementStatus2(string, boolean)	Bir proje için Gelişmiş Güvenlik'in güncel durumunu öğrenin
getRepoEnablementStatus2(string, string, boolean)	Kod Güvenliği, Gizli Dizi Koruması ve bunların özelliklerinin depo için etkinleştirilip etkinleştirilmediğini belirler.
updateAdvancedSecurityAgentPoolSelection(string)	Seçilen Ajan Havuzu için Ajan Havuzu Kayıt Değerini Günceller Bu, kullanıcının o havuzu kullanma iznine sahip olup olmadığını doğrulamak için otomatik olarak altta yatan http istemcisini kullanır
updateOrgEnablementStatus2(OrgEnablementSettings)	Kuruluş için Gelişmiş Güvenlik durumunu güncelleştirme
updateProjectEnablementStatus2(ProjectEnablementSettings, string)	Gelişmiş Güvenlik durumunu proje için güncelleyin
updateRepoAdvSecEnablementStatus2(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ı

createBillingSnapshot2(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 createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>

Parametreler

meterUsage

MeterUsageForPlan

plan

Plan

Döndürülenler

Promise<void>

getAdvancedSecurityAgentPoolSelection()

Tüm Mevcut Ajan Havuzlarını + Şu Anda Seçilmiş Ajan Havuzunu almak için temel URL Bu, yönetme izni gerektirmeyen yalnızca okunabilir bir işlemdir.

function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>

Döndürülenler

Promise<AgentPoolDetails>

getBillableCommitterDetails2(Plan, Date)

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

function getBillableCommitterDetails2(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[]>

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

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

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

Parametreler

project

string

Project ID veya project adı

repository

string

Deponun adı veya kimliği

plan

Plan

Sorgulama planı.

Döndürülenler

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForOrg2(Plan)

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

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

Parametreler

plan

Plan

Sorgulama planı.

Döndürülenler

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForProject2(string, Plan)

Bu proje için Gelişmiş Güvenlik etkinleştirilseydi müşterinin kullanımına eklenecek pusher'ları tahmin edin.

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

Parametreler

project

string

Project ID veya project adı

plan

Plan

Döndürülenler

Promise<MeterUsageEstimate>

getLastMeterUsage2(Plan)

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

Parametreler

plan

Plan

Döndürülenler

Promise<MeterUsageForPlan>

getMeterUsage2(Plan, Date)

Faturalama bilgilerini hesaplarken kullanılan işlemecileri alma.

function getMeterUsage2(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>

getOrgEnablementStatus2(boolean)

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

function getOrgEnablementStatus2(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>

getProjectEnablementStatus2(string, boolean)

Bir proje için Gelişmiş Güvenlik'in güncel durumunu öğrenin

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

Parametreler

project

string

Project ID veya project adı

includeAllProperties

boolean

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

Döndürülenler

Promise<ProjectEnablementSettings>

getRepoEnablementStatus2(string, string, boolean)

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

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

Parametreler

project

string

Project ID veya project 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>

updateAdvancedSecurityAgentPoolSelection(string)

Seçilen Ajan Havuzu için Ajan Havuzu Kayıt Değerini Günceller Bu, kullanıcının o havuzu kullanma iznine sahip olup olmadığını doğrulamak için otomatik olarak altta yatan http istemcisini kullanır

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

Parametreler

agentPoolName

string

Döndürülenler

Promise<AgentPoolDetails>

updateOrgEnablementStatus2(OrgEnablementSettings)

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

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

Parametreler

orgEnablementSettings

OrgEnablementSettings

Yeni durum

Döndürülenler

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Gelişmiş Güvenlik durumunu proje için güncelleyin

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

Parametreler

projectEnablementSettings

ProjectEnablementSettings

Yeni durum

project

string

Project ID veya project adı

Döndürülenler

Promise<void>

updateRepoAdvSecEnablementStatus2(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 updateRepoAdvSecEnablementStatus2(repoEnablementSettings: RepoEnablementSettings, project: string, repository: string): Promise<void>

Parametreler

repoEnablementSettings

RepoEnablementSettings

Yeni Statü

project

string

Project ID veya project adı

repository

string

Deponun adı veya kimliği

Döndürülenler

Promise<void>