ManagementRestClient class

Pakiet:

azure-devops-extension-api

Klasa podstawowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends

RestClientBase

Konstruktory

ManagementRestClient(IVssRestClientOptions)

Metody

createBillingSnapshot(MeterUsage)	Podczas obliczania rozliczeń w wielu organizacjach w podstawowej jednostce skalowania (EUS21) ten interfejs API służy do tworzenia migawki rozliczeń dla określonej organizacji. Podstawowa jednostka skalowania wywoła ten interfejs API dla każdej organizacji w różnych jednostkach scsle w celu utworzenia migawki rozliczeń. Dane będą przechowywane w bazie danych partycji określonej w organizacji —> tabela migawek rozliczeniowych. Jest to konieczne, ponieważ klienci będą pobierać dane rozliczeniowe z bazy danych partycji określonej w organizacji.
deleteBillingInfo(string)	Usuń informacje rozliczeniowe dla organizacji.
deleteMeterUsageHistory(string)	Usuń historię użycia miernika z podstawowej jednostki SU dla organizacji.
getBillableCommitterDetails(Date)	Pobierz wszystkie szczegóły rozliczanych osób zatwierdzających, w tym te, które nie są zgodne z identyfikatorem VSID.
getBillingInfo(string)	Pobierz informacje rozliczeniowe dla organizacji.
getEstimatedOrgBillablePushers()	Szacuj osoby zatwierdzające, które zostaną dodane do użycia klienta, jeśli usługa Advanced Security została włączona dla tej organizacji.
getEstimatedProjectBillablePushers(string)	Szacuj liczbę osób zatwierdzających, które zostaną dodane do użycia klienta, jeśli dla tego projektu włączono zabezpieczenia zaawansowane.
getEstimatedRepoBillableCommitters(string, string)	Szacuj osoby zatwierdzające, które zostaną dodane do użycia klienta, jeśli usługa Advanced Security została włączona dla tego repozytorium.
getLastMeterUsage()
getMeterUsage(Date)	Pobieranie zatwierdzeniów używanych podczas obliczania informacji rozliczeniowych.
getOrgEnablementStatus(boolean)	Uzyskiwanie bieżącego stanu usługi Advanced Security dla organizacji
getProjectEnablementStatus(string, boolean)	Uzyskiwanie bieżącego stanu usługi Advanced Security dla projektu
getRepoEnablementStatus(string, string, boolean)	Określanie, czy usługa Advanced Security jest włączona dla repozytorium
saveBillingInfo(BillingInfo, string)	Zapisz informacje rozliczeniowe dla organizacji.
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	Aktualizowanie stanu usługi Advanced Security dla organizacji
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	Aktualizowanie stanu usługi Advanced Security dla projektu
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)	Aktualizowanie włączania usługi Advanced Security dla repozytorium

Szczegóły konstruktora

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły metody

createBillingSnapshot(MeterUsage)

Podczas obliczania rozliczeń w wielu organizacjach w podstawowej jednostce skalowania (EUS21) ten interfejs API służy do tworzenia migawki rozliczeń dla określonej organizacji. Podstawowa jednostka skalowania wywoła ten interfejs API dla każdej organizacji w różnych jednostkach scsle w celu utworzenia migawki rozliczeń. Dane będą przechowywane w bazie danych partycji określonej w organizacji —> tabela migawek rozliczeniowych. Jest to konieczne, ponieważ klienci będą pobierać dane rozliczeniowe z bazy danych partycji określonej w organizacji.

function createBillingSnapshot(meterUsage: MeterUsage): Promise<void>

Parametry

meterUsage

MeterUsage

Zwraca

Promise<void>

deleteBillingInfo(string)

Usuń informacje rozliczeniowe dla organizacji.

function deleteBillingInfo(organizationId: string): Promise<void>

Parametry

organizationId

string

Zwraca

Promise<void>

deleteMeterUsageHistory(string)

Usuń historię użycia miernika z podstawowej jednostki SU dla organizacji.

function deleteMeterUsageHistory(organizationId: string): Promise<void>

Parametry

organizationId

string

Zwraca

Promise<void>

getBillableCommitterDetails(Date)

Pobierz wszystkie szczegóły rozliczanych osób zatwierdzających, w tym te, które nie są zgodne z identyfikatorem VSID.

function getBillableCommitterDetails(billingDate?: Date): Promise<BillableCommitterDetails[]>

Parametry

billingDate

Date

Data wykonania zapytania lub jeśli nie została podana, dzisiaj

Zwraca

Promise<BillableCommitterDetails[]>

getBillingInfo(string)

Pobierz informacje rozliczeniowe dla organizacji.

function getBillingInfo(organizationId: string): Promise<BillingInfo>

Parametry

organizationId

string

Identyfikator organizacji, aby uzyskać informacje o rozliczeniach.

Zwraca

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

Szacuj osoby zatwierdzające, które zostaną dodane do użycia klienta, jeśli usługa Advanced Security została włączona dla tej organizacji.

function getEstimatedOrgBillablePushers(): Promise<string[]>

Zwraca

Promise<string[]>

getEstimatedProjectBillablePushers(string)

Szacuj liczbę osób zatwierdzających, które zostaną dodane do użycia klienta, jeśli dla tego projektu włączono zabezpieczenia zaawansowane.

function getEstimatedProjectBillablePushers(project: string): Promise<string[]>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

Szacuj osoby zatwierdzające, które zostaną dodane do użycia klienta, jeśli usługa Advanced Security została włączona dla tego repozytorium.

function getEstimatedRepoBillableCommitters(project: string, repository: string): Promise<string[]>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

Zwraca

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Zwraca

Promise<MeterUsage>

getMeterUsage(Date)

Pobieranie zatwierdzeniów używanych podczas obliczania informacji rozliczeniowych.

function getMeterUsage(billingDate?: Date): Promise<MeterUsage>

Parametry

billingDate

Date

Data wykonania zapytania lub jeśli nie została podana, dzisiaj

Zwraca

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

Uzyskiwanie bieżącego stanu usługi Advanced Security dla organizacji

function getOrgEnablementStatus(includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>

Parametry

includeAllProperties

boolean

W przypadku wartości true określ również, czy wypychania są blokowane, jeśli zawierają wpisy tajne

Zwraca

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus(string, boolean)

Uzyskiwanie bieżącego stanu usługi Advanced Security dla projektu

function getProjectEnablementStatus(project: string, includeAllProperties?: boolean): Promise<AdvSecEnablementSettings>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

includeAllProperties

boolean

W przypadku wartości true określ również, czy wypychania są blokowane, jeśli zawierają wpisy tajne

Zwraca

Promise<AdvSecEnablementSettings>

getRepoEnablementStatus(string, string, boolean)

Określanie, czy usługa Advanced Security jest włączona dla repozytorium

function getRepoEnablementStatus(project: string, repository: string, includeAllProperties?: boolean): Promise<AdvSecEnablementStatus>

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

includeAllProperties

boolean

W przypadku wartości true określi również, czy wypychania są blokowane po wykryciu wpisów tajnych

Zwraca

Promise<AdvSecEnablementStatus>

saveBillingInfo(BillingInfo, string)

Zapisz informacje rozliczeniowe dla organizacji.

function saveBillingInfo(billingInfo: BillingInfo, organizationId: string): Promise<void>

Parametry

billingInfo

BillingInfo

organizationId

string

Zwraca

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

Aktualizowanie stanu usługi Advanced Security dla organizacji

function updateOrgEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate): Promise<void>

Parametry

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Nowy stan

Zwraca

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

Aktualizowanie stanu usługi Advanced Security dla projektu

function updateProjectEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementSettingsUpdate, project: string): Promise<void>

Parametry

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Nowy stan

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

Aktualizowanie włączania usługi Advanced Security dla repozytorium

function updateRepoAdvSecEnablementStatus(savedAdvSecEnablementStatus: AdvSecEnablementStatusUpdate, project: string, repository: string): Promise<void>

Parametry

savedAdvSecEnablementStatus

AdvSecEnablementStatusUpdate

nowy stan

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

Zwraca

Promise<void>