ManagementRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

ManagementRestClient(IVssRestClientOptions)

Методы

createBillingSnapshot(MeterUsage)	При расчете выставления счетов для нескольких организаций в основной единице масштабирования (EUS21) этот API используется для создания snapshot выставления счетов для конкретной организации. Основная единица масштабирования будет вызывать этот API для каждой организации в разных единицах scsle, чтобы создать snapshot выставления счетов. Данные будут храниться в базе данных секций организации —> выставлении счетов snapshot таблице. Это необходимо, так как клиенты будут получить данные о выставлении счетов из базы данных раздела организации.
deleteBillingInfo(string)	Удалите сведения для выставления счетов для организации.
deleteMeterUsageHistory(string)	Удалите журнал использования счетчика из основного su для организации.
getBillableCommitterDetails(Date)	Получение сведений обо всех оплачиваемых фиксациях, включая сведения, не соответствующие VSID.
getBillingInfo(string)	Получение сведений о выставлении счетов для организации.
getEstimatedOrgBillablePushers()	Оцените фиксации, которые будут добавлены к использованию клиента, если для этой организации была включена расширенная безопасность.
getEstimatedProjectBillablePushers(string)	Оцените количество фиксаций, которые будут добавлены к использованию клиентом, если для этого проекта была включена расширенная безопасность.
getEstimatedRepoBillableCommitters(string, string)	Оцените фиксации, которые будут добавлены к использованию клиентом, если для этого репозитория включена расширенная безопасность.
getLastMeterUsage()
getMeterUsage(Date)	Получение фиксаций, используемых при расчете сведений о выставлении счетов.
getOrgEnablementStatus(boolean)	Получение текущего состояния "Расширенная безопасность" для организации
getProjectEnablementStatus(string, boolean)	Получение текущего состояния "Расширенная безопасность" для проекта
getRepoEnablementStatus(string, string, boolean)	Определение того, включена ли расширенная безопасность для репозитория
saveBillingInfo(BillingInfo, string)	Сохраните сведения для выставления счетов для организации.
updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)	Обновление состояния "Расширенная безопасность" для организации
updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)	Обновление состояния "Расширенная безопасность" для проекта
updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)	Обновление включения расширенной безопасности для репозитория

Сведения о конструкторе

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о методе

createBillingSnapshot(MeterUsage)

При расчете выставления счетов для нескольких организаций в основной единице масштабирования (EUS21) этот API используется для создания snapshot выставления счетов для конкретной организации. Основная единица масштабирования будет вызывать этот API для каждой организации в разных единицах scsle, чтобы создать snapshot выставления счетов. Данные будут храниться в базе данных секций организации —> выставлении счетов snapshot таблице. Это необходимо, так как клиенты будут получить данные о выставлении счетов из базы данных раздела организации.

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

Параметры

meterUsage

MeterUsage

Возвращаемое значение

Promise<void>

deleteBillingInfo(string)

Удалите сведения для выставления счетов для организации.

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

Параметры

organizationId

string

Возвращаемое значение

Promise<void>

deleteMeterUsageHistory(string)

Удалите журнал использования счетчика из основного su для организации.

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

Параметры

organizationId

string

Возвращаемое значение

Promise<void>

getBillableCommitterDetails(Date)

Получение сведений обо всех оплачиваемых фиксациях, включая сведения, не соответствующие VSID.

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

Параметры

billingDate

Date

Дата запроса или, если она не указана, сегодня

Возвращаемое значение

Promise<BillableCommitterDetails[]>

getBillingInfo(string)

Получение сведений о выставлении счетов для организации.

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

Параметры

organizationId

string

Идентификатор организации для получения сведений о выставлении счетов.

Возвращаемое значение

Promise<BillingInfo>

getEstimatedOrgBillablePushers()

Оцените фиксации, которые будут добавлены к использованию клиента, если для этой организации была включена расширенная безопасность.

function getEstimatedOrgBillablePushers(): Promise<string[]>

Возвращаемое значение

Promise<string[]>

getEstimatedProjectBillablePushers(string)

Оцените количество фиксаций, которые будут добавлены к использованию клиентом, если для этого проекта была включена расширенная безопасность.

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

Параметры

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<string[]>

getEstimatedRepoBillableCommitters(string, string)

Оцените фиксации, которые будут добавлены к использованию клиентом, если для этого репозитория включена расширенная безопасность.

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

Параметры

project

string

Идентификатор проекта или имя проекта

repository

string

Имя или идентификатор репозитория

Возвращаемое значение

Promise<string[]>

getLastMeterUsage()

function getLastMeterUsage(): Promise<MeterUsage>

Возвращаемое значение

Promise<MeterUsage>

getMeterUsage(Date)

Получение фиксаций, используемых при расчете сведений о выставлении счетов.

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

Параметры

billingDate

Date

Дата запроса или, если она не указана, сегодня

Возвращаемое значение

Promise<MeterUsage>

getOrgEnablementStatus(boolean)

Получение текущего состояния "Расширенная безопасность" для организации

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

Параметры

includeAllProperties

boolean

При значении true также определите, блокируются ли отправки, если они содержат секреты.

Возвращаемое значение

Promise<AdvSecEnablementSettings>

getProjectEnablementStatus(string, boolean)

Получение текущего состояния "Расширенная безопасность" для проекта

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

Параметры

project

string

Идентификатор проекта или имя проекта

includeAllProperties

boolean

При значении true также определите, блокируются ли отправки, если они содержат секреты.

Возвращаемое значение

Promise<AdvSecEnablementSettings>

getRepoEnablementStatus(string, string, boolean)

Определение того, включена ли расширенная безопасность для репозитория

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

Параметры

project

string

Идентификатор проекта или имя проекта

repository

string

Имя или идентификатор репозитория

includeAllProperties

boolean

При значении true также определяет, блокируются ли push-уведомления при обнаружении секретов.

Возвращаемое значение

Promise<AdvSecEnablementStatus>

saveBillingInfo(BillingInfo, string)

Сохраните сведения для выставления счетов для организации.

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

Параметры

billingInfo

BillingInfo

organizationId

string

Возвращаемое значение

Promise<void>

updateOrgEnablementStatus(AdvSecEnablementSettingsUpdate)

Обновление состояния "Расширенная безопасность" для организации

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

Параметры

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Новое состояние

Возвращаемое значение

Promise<void>

updateProjectEnablementStatus(AdvSecEnablementSettingsUpdate, string)

Обновление состояния "Расширенная безопасность" для проекта

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

Параметры

savedAdvSecEnablementStatus

AdvSecEnablementSettingsUpdate

Новое состояние

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<void>

updateRepoAdvSecEnablementStatus(AdvSecEnablementStatusUpdate, string, string)

Обновление включения расширенной безопасности для репозитория

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

Параметры

savedAdvSecEnablementStatus

AdvSecEnablementStatusUpdate

новое состояние

project

string

Идентификатор проекта или имя проекта

repository

string

Имя или идентификатор репозитория

Возвращаемое значение

Promise<void>