Udostępnij za pomocą


ManagementRestClient class

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

Rozszerza

Konstruktorów

ManagementRestClient(IVssRestClientOptions)

Metody

createBillingSnapshot2(MeterUsageForPlan, Plan)

Podczas obliczeń dotyczących 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 tabeli migawek partycji specyficznej dla organizacji — rozliczenia> . Jest to konieczne, ponieważ klienci będą pobierać dane rozliczeniowe z bazy danych partycji określonej w organizacji.

getBillableCommitterDetails2(Plan, Date)

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

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

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

getEstimatedBillablePushersDetailsForOrg2(Plan)

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

getEstimatedBillablePushersDetailsForProject2(string, Plan)

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

getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)

Pobierz osoby zatwierdzane używane podczas obliczania informacji rozliczeniowych.

getOrgEnablementStatus2(boolean)

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

getProjectEnablementStatus2(string, boolean)

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

getRepoEnablementStatus2(string, string, boolean)

Określa, czy zabezpieczenia kodu, ochrona wpisów tajnych i ich funkcje są włączone dla repozytorium.

updateOrgEnablementStatus2(OrgEnablementSettings)

Aktualizowanie stanu usługi Advanced Security dla organizacji

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Aktualizowanie stanu usługi Advanced Security dla projektu

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

Zaktualizuj stan włączania zabezpieczeń kodu i ochrony wpisów tajnych wraz z odpowiednimi funkcjami dla danego repozytorium.

Szczegóły konstruktora

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Parametry

Szczegóły metody

createBillingSnapshot2(MeterUsageForPlan, Plan)

Podczas obliczeń dotyczących 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 tabeli migawek partycji specyficznej dla organizacji — rozliczenia> . Jest to konieczne, ponieważ klienci będą pobierać dane rozliczeniowe z bazy danych partycji określonej w organizacji.

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

Parametry

meterUsage
MeterUsageForPlan
plan
Plan

Zwraca

Promise<void>

getBillableCommitterDetails2(Plan, Date)

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

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

Parametry

plan
Plan

Plan wykonywania zapytań. Obsługiwane plany: CodeSecurity i SecretProtection. Jest to obowiązkowy parametr.

billingDate

Date

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

Zwraca

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

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

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

plan
Plan

Plan wykonywania zapytań.

Zwraca

getEstimatedBillablePushersDetailsForOrg2(Plan)

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

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

Parametry

plan
Plan

Plan wykonywania zapytań.

Zwraca

getEstimatedBillablePushersDetailsForProject2(string, Plan)

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

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

plan
Plan

Zwraca

getLastMeterUsage2(Plan)

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

Parametry

plan
Plan

Zwraca

getMeterUsage2(Plan, Date)

Pobierz osoby zatwierdzane używane podczas obliczania informacji rozliczeniowych.

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

Parametry

plan
Plan

Plan wykonywania zapytań. Obsługiwane plany: CodeSecurity i SecretProtection. Jest to obowiązkowy parametr.

billingDate

Date

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

Zwraca

getOrgEnablementStatus2(boolean)

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

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

Parametry

includeAllProperties

boolean

W przypadku wartości true ustal również, czy wypchnięcia są blokowane, jeśli zawierają wpisy tajne

Zwraca

getProjectEnablementStatus2(string, boolean)

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

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

includeAllProperties

boolean

W przypadku wartości true ustal również, czy wypchnięcia są blokowane, jeśli zawierają wpisy tajne

Zwraca

getRepoEnablementStatus2(string, string, boolean)

Określa, czy zabezpieczenia kodu, ochrona wpisów tajnych i ich funkcje są włączone dla repozytorium.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

includeAllProperties

boolean

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

Zwraca

updateOrgEnablementStatus2(OrgEnablementSettings)

Aktualizowanie stanu usługi Advanced Security dla organizacji

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

Parametry

orgEnablementSettings
OrgEnablementSettings

Nowy stan

Zwraca

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Aktualizowanie stanu usługi Advanced Security dla projektu

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

Parametry

projectEnablementSettings
ProjectEnablementSettings

Nowy stan

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

Zaktualizuj stan włączania zabezpieczeń kodu i ochrony wpisów tajnych wraz z odpowiednimi funkcjami dla danego repozytorium.

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

Parametry

repoEnablementSettings
RepoEnablementSettings

Nowy status

project

string

Identyfikator projektu lub nazwa projektu

repository

string

Nazwa lub identyfikator repozytorium

Zwraca

Promise<void>