ReportingRestClient class

Пакет:

azure-devops-extension-api

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

Extends

RestClientBase

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

ReportingRestClient(IVssRestClientOptions)

Методы

createAdvancedFilter(AdvancedFilterCreate)	Создаёт новый продвинутый фильтр для организации.
deleteAdvancedFilter(string)	Удаляет продвинутый фильтр.
getAdvancedFilter(string)	Получает специфический продвинутый фильтр по своему ID.
getAlertSummaryForOrg(FilterCriteria)	Получение сводки оповещений по серьезности для организации
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)	Получение объединенных оповещений для организации
getDependencyComponentNamesForOrg()	Получите все разные имена компонентов зависимостей для организации (используемые для UX-фильтрации).
getEnablementSummaryForOrg(EnablementFilterCriteria)	Получение сводки по включению для организации
getProjectsAndReposForOrg()	Получите все проекты и репозитории организации (используются для UX-фильтрации)
getRuleNamesForOrg(string)	Получите все разные имена правил для сканирования кода для организации (используемые для фильтрации UX)
getSecretTypesForOrg()	Получите все разные типы секретов для организации (используемые для UX-фильтрации)
getUXComputedFilters()
listAdvancedFilters(boolean, string)	Получает все продвинутые фильтры для организации.
updateAdvancedFilter(AdvancedFilterUpdate, string)	Обновляет расширенный фильтр. Обновлять можно только имя.

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

ReportingRestClient(IVssRestClientOptions)

new ReportingRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

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

createAdvancedFilter(AdvancedFilterCreate)

Создаёт новый продвинутый фильтр для организации.

function createAdvancedFilter(filter: AdvancedFilterCreate): Promise<AdvancedFilter>

Параметры

filter

AdvancedFilterCreate

Продвинутый фильтр для создания.

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

Promise<AdvancedFilter>

deleteAdvancedFilter(string)

Удаляет продвинутый фильтр.

function deleteAdvancedFilter(filterId: string): Promise<void>

Параметры

filterId

string

ID расширенного фильтра для удаления.

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

Promise<void>

getAdvancedFilter(string)

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

function getAdvancedFilter(filterId: string): Promise<AdvancedFilter>

Параметры

filterId

string

ID расширенного фильтра для извлечения.

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

Promise<AdvancedFilter>

getAlertSummaryForOrg(FilterCriteria)

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

function getAlertSummaryForOrg(criteria?: FilterCriteria): Promise<OrgAlertSummary>

Параметры

criteria

FilterCriteria

Варианты ограничения возвращаемых резюме

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

Promise<OrgAlertSummary>

getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)

Получение объединенных оповещений для организации

function getCombinedAlertsForOrg(criteria?: CombinedAlertFilterCriteria, top?: number, continuationToken?: string): Promise<PagedList<DashboardAlert>>

Параметры

criteria

CombinedAlertFilterCriteria

Опции фильтрации объединённых оповещений возвращённых

top

number

Максимальное количество возвращаемых оповещений

continuationToken

string

Если есть больше оповещений, чем может быть возвращено, маркер продолжения помещается в заголовок x-ms-continuationtoken. Используйте этот маркер здесь, чтобы получить следующую страницу оповещений

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

Promise<PagedList<DashboardAlert>>

getDependencyComponentNamesForOrg()

Получите все разные имена компонентов зависимостей для организации (используемые для UX-фильтрации).

function getDependencyComponentNamesForOrg(): Promise<string[]>

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

Promise<string[]>

getEnablementSummaryForOrg(EnablementFilterCriteria)

Получение сводки по включению для организации

function getEnablementSummaryForOrg(criteria?: EnablementFilterCriteria): Promise<OrgEnablementSummary>

Параметры

criteria

EnablementFilterCriteria

Варианты ограничения возвращаемых резюме

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

Promise<OrgEnablementSummary>

getProjectsAndReposForOrg()

Получите все проекты и репозитории организации (используются для UX-фильтрации)

function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>

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

Promise<ProjectAndRepoInfo[]>

getRuleNamesForOrg(string)

Получите все разные имена правил для сканирования кода для организации (используемые для фильтрации UX)

function getRuleNamesForOrg(toolName?: string): Promise<CodeScanningRuleInfo[]>

Параметры

toolName

string

Опциональное имя инструмента для фильтрации правил по

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

Promise<CodeScanningRuleInfo[]>

getSecretTypesForOrg()

Получите все разные типы секретов для организации (используемые для UX-фильтрации)

function getSecretTypesForOrg(): Promise<string[]>

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

Promise<string[]>

getUXComputedFilters()

function getUXComputedFilters(): Promise<ReportingUXComputedFilters>

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

Promise<ReportingUXComputedFilters>

listAdvancedFilters(boolean, string)

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

function listAdvancedFilters(includeDeleted?: boolean, keywords?: string): Promise<AdvancedFilter[]>

Параметры

includeDeleted

boolean

Стоит ли включать фильтры с мягким удалением.

keywords

string

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

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

Promise<AdvancedFilter[]>

updateAdvancedFilter(AdvancedFilterUpdate, string)

Обновляет расширенный фильтр. Обновлять можно только имя.

function updateAdvancedFilter(filter: AdvancedFilterUpdate, filterId: string): Promise<void>

Параметры

filter

AdvancedFilterUpdate

Данные обновления, содержащие новое имя.

filterId

string

ID расширенного фильтра для обновления.

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

Promise<void>