ManagementRestClient class

Пакет:

azure-devops-extension-api

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

Extends

RestClientBase

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

ManagementRestClient(IVssRestClientOptions)

Методы

createBillingSnapshot2(MeterUsageForPlan, Plan)	Во время вычислений выставления счетов с несколькими организациями в основном единице масштабирования (EUS21) этот API используется для создания моментального снимка выставления счетов для конкретной организации. Основной модуль масштабирования вызовет этот API для каждой организации в разных единицах scsle для создания моментального снимка выставления счетов. Данные будут храниться в БД разделов организации - таблица снимков биллинга. Это необходимо, так как клиенты получат данные о выставлении счетов из конкретной базы данных секции организации.
getAdvancedSecurityAgentPoolSelection()	Базовый URL для получения всех доступных пулов агентов + выбранного пула агентов Это операция только для чтения, не требующая разрешений на управление.
getBillableCommitterDetails2(Plan, Date)	Получите все сведения о оплачиваемых фиксациях, включая те, которые не совпадают с VSID.
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)	Оцените push-запросы, которые будут добавлены в использование клиента, если для этого репозитория включена расширенная безопасность.
getEstimatedBillablePushersDetailsForOrg2(Plan)	Оцените push-запросы, которые будут добавлены к использованию клиента, если для этой организации включена расширенная безопасность.
getEstimatedBillablePushersDetailsForProject2(string, Plan)	Оцените количество пушеров, которые будут добавлены к использованию клиента, если Advanced Security будет включена для этого project.
getLastMeterUsage2(Plan)
getMeterUsage2(Plan, Date)	Получение фиксаций, используемых при вычислении сведений о выставлении счетов.
getOrgEnablementStatus2(boolean)	Получение текущего состояния расширенной безопасности для организации
getProjectEnablementStatus2(string, boolean)	Получите текущий статус Advanced Security for a project
getRepoEnablementStatus2(string, string, boolean)	Определяет, включены ли функции безопасности кода, защиты секретов и их функций для репозитория.
updateAdvancedSecurityAgentPoolSelection(string)	Обновляет значение реестра пула агентов для выбранного пула агентов Это автоматически использует базовый http-клиент для пулов агентов для проверки права пользователя на использование этого пула
updateOrgEnablementStatus2(OrgEnablementSettings)	Обновление состояния расширенной безопасности для организации
updateProjectEnablementStatus2(ProjectEnablementSettings, string)	Обновить статус расширенной безопасности для project
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)	Обновите состояние включения защиты кода и секрета вместе с соответствующими функциями для данного репозитория.

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

ManagementRestClient(IVssRestClientOptions)

new ManagementRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

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

createBillingSnapshot2(MeterUsageForPlan, Plan)

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

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

Параметры

meterUsage

MeterUsageForPlan

plan

Plan

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

Promise<void>

getAdvancedSecurityAgentPoolSelection()

Базовый URL для получения всех доступных пулов агентов + выбранного пула агентов Это операция только для чтения, не требующая разрешений на управление.

function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>

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

Promise<AgentPoolDetails>

getBillableCommitterDetails2(Plan, Date)

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

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

Параметры

plan

Plan

План запроса. Поддерживаемые планы: CodeSecurity и SecretProtection. Это обязательный параметр.

billingDate

Date

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

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

Promise<BillableCommitterDetails[]>

getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)

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

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

Параметры

project

string

Project ID или название project

repository

string

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

plan

Plan

План запроса.

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

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForOrg2(Plan)

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

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

Параметры

plan

Plan

План запроса.

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

Promise<MeterUsageEstimate>

getEstimatedBillablePushersDetailsForProject2(string, Plan)

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

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

Параметры

project

string

Project ID или название project

plan

Plan

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

Promise<MeterUsageEstimate>

getLastMeterUsage2(Plan)

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

Параметры

plan

Plan

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

Promise<MeterUsageForPlan>

getMeterUsage2(Plan, Date)

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

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

Параметры

plan

Plan

План запроса. Поддерживаемые планы: CodeSecurity и SecretProtection. Это обязательный параметр.

billingDate

Date

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

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

Promise<MeterUsageForPlan>

getOrgEnablementStatus2(boolean)

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

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

Параметры

includeAllProperties

boolean

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

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

Promise<OrgEnablementSettings>

getProjectEnablementStatus2(string, boolean)

Получите текущий статус Advanced Security for a project

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

Параметры

project

string

Project ID или название project

includeAllProperties

boolean

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

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

Promise<ProjectEnablementSettings>

getRepoEnablementStatus2(string, string, boolean)

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

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

Параметры

project

string

Project ID или название project

repository

string

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

includeAllProperties

boolean

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

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

Promise<RepoEnablementSettings>

updateAdvancedSecurityAgentPoolSelection(string)

Обновляет значение реестра пула агентов для выбранного пула агентов Это автоматически использует базовый http-клиент для пулов агентов для проверки права пользователя на использование этого пула

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

Параметры

agentPoolName

string

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

Promise<AgentPoolDetails>

updateOrgEnablementStatus2(OrgEnablementSettings)

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

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

Параметры

orgEnablementSettings

OrgEnablementSettings

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

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

Promise<void>

updateProjectEnablementStatus2(ProjectEnablementSettings, string)

Обновить статус расширенной безопасности для project

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

Параметры

projectEnablementSettings

ProjectEnablementSettings

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

project

string

Project ID или название project

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

Promise<void>

updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)

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

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

Параметры

repoEnablementSettings

RepoEnablementSettings

Новый статус

project

string

Project ID или название project

repository

string

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

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

Promise<void>