ManagementRestClient class

Pakiet:

azure-devops-extension-api

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

Rozszerza

RestClientBase

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.
getAdvancedSecurityAgentPoolSelection()	Podstawowy URL do pobierania wszystkich dostępnych pul agentów + Obecnie wybranej puli agentów To operacja tylko do odczytu, która nie wymaga uprawnień do zarządzania.
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)	Oszacuj, ile pusherów zostałoby dodane do użytkowania klienta, gdyby dla tego projektu włączono Advanced Security.
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)	Sprawdź aktualny status Zaawansowanego Bezpieczeństwa dla projektu
getRepoEnablementStatus2(string, string, boolean)	Określa, czy zabezpieczenia kodu, ochrona wpisów tajnych i ich funkcje są włączone dla repozytorium.
updateAdvancedSecurityAgentPoolSelection(string)	Aktualizacja wartości rejestru puli agentów dla wybranej puli agentów Automatycznie wykorzystuje to klienta HTTP dla pul agentów, aby zweryfikować, czy użytkownik ma uprawnienia do korzystania z tej puli
updateOrgEnablementStatus2(OrgEnablementSettings)	Aktualizowanie stanu usługi Advanced Security dla organizacji
updateProjectEnablementStatus2(ProjectEnablementSettings, string)	Aktualizacja statusu Zaawansowanego Bezpieczeństwa 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

options

IVssRestClientOptions

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>

getAdvancedSecurityAgentPoolSelection()

Podstawowy URL do pobierania wszystkich dostępnych pul agentów + Obecnie wybranej puli agentów To operacja tylko do odczytu, która nie wymaga uprawnień do zarządzania.

function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>

Zwraca

Promise<AgentPoolDetails>

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

Promise<BillableCommitterDetails[]>

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 Project lub nazwa project

repository

string

Nazwa lub identyfikator repozytorium

plan

Plan

Plan wykonywania zapytań.

Zwraca

Promise<MeterUsageEstimate>

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

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForProject2(string, Plan)

Oszacuj, ile pusherów zostałoby dodane do użytkowania klienta, gdyby dla tego projektu włączono Advanced Security.

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

Parametry

project

string

Identyfikator Project lub nazwa project

plan

Plan

Zwraca

Promise<MeterUsageEstimate>

getLastMeterUsage2(Plan)

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

Parametry

plan

Plan

Zwraca

Promise<MeterUsageForPlan>

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

Promise<MeterUsageForPlan>

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

Promise<OrgEnablementSettings>

getProjectEnablementStatus2(string, boolean)

Sprawdź aktualny status Zaawansowanego Bezpieczeństwa dla projektu

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

Parametry

project

string

Identyfikator Project lub nazwa project

includeAllProperties

boolean

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

Zwraca

Promise<ProjectEnablementSettings>

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 Project lub nazwa project

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

Promise<RepoEnablementSettings>

updateAdvancedSecurityAgentPoolSelection(string)

Aktualizacja wartości rejestru puli agentów dla wybranej puli agentów Automatycznie wykorzystuje to klienta HTTP dla pul agentów, aby zweryfikować, czy użytkownik ma uprawnienia do korzystania z tej puli

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

Parametry

agentPoolName

string

Zwraca

Promise<AgentPoolDetails>

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)

Aktualizacja statusu Zaawansowanego Bezpieczeństwa dla projektu

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

Parametry

projectEnablementSettings

ProjectEnablementSettings

Nowy stan

project

string

Identyfikator Project lub nazwa project

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 Project lub nazwa project

repository

string

Nazwa lub identyfikator repozytorium

Zwraca

Promise<void>