DashboardRestClient class

Пакет:

azure-devops-extension-api

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

Extends

RestClientBase

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

DashboardRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

createDashboard(Dashboard, TeamContext)	Создайте предоставленную панель мониторинга.
createWidget(Widget, TeamContext, string)	Создайте мини-приложение на указанной панели мониторинга.
deleteDashboard(TeamContext, string)	Удаление панели мониторинга с учетом ее идентификатора. При этом также удаляются мини-приложения, связанные с этой панелью мониторинга.
deleteWidget(TeamContext, string, string)	Удалите указанное мини-приложение.
getDashboard(TeamContext, string)	Получение панели мониторинга по ее идентификатору.
getDashboardsByProject(TeamContext)	Получение списка панелей мониторинга в проекте.
getWidget(TeamContext, string, string)	Получение текущего состояния указанного мини-приложения.
getWidgetMetadata(string, string)	Получите метаданные мини-приложения, удовлетворяющие указанному идентификатору вклада.
getWidgetTypes(WidgetScope, string)	Получение всех доступных метаданных мини-приложения в алфавитном порядке, включая мини-приложения, помеченные параметром isVisibleFromCatalog == false.
replaceDashboard(Dashboard, TeamContext, string)	Замените конфигурацию для указанной панели мониторинга. Заменяет список мини-приложений на панели мониторинга, только если задано свойство .
replaceDashboards(DashboardGroup, TeamContext)	Обновите имя и положение панелей мониторинга в предоставленной группе и удалите опущенные панели мониторинга. Не изменяет содержимое панели мониторинга.
replaceWidget(Widget, TeamContext, string, string)	Переопределите состояние указанного мини-приложения.
updateWidget(Widget, TeamContext, string, string)	Выполните частичное обновление указанного мини-приложения.

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

DashboardRestClient(IVssRestClientOptions)

new DashboardRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

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

createDashboard(Dashboard, TeamContext)

Создайте предоставленную панель мониторинга.

function createDashboard(dashboard: Dashboard, teamContext: TeamContext): Promise<Dashboard>

Параметры

dashboard

Dashboard

Начальное состояние панели мониторинга

teamContext

TeamContext

Контекст команды для операции

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

Promise<Dashboard>

createWidget(Widget, TeamContext, string)

Создайте мини-приложение на указанной панели мониторинга.

function createWidget(widget: Widget, teamContext: TeamContext, dashboardId: string): Promise<Widget>

Параметры

widget

Widget

Состояние добавляемого мини-приложения

teamContext

TeamContext

Контекст команды для операции

dashboardId

string

Идентификатор панели мониторинга, в который будет добавлено мини-приложение.

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

Promise<Widget>

deleteDashboard(TeamContext, string)

Удаление панели мониторинга с учетом ее идентификатора. При этом также удаляются мини-приложения, связанные с этой панелью мониторинга.

function deleteDashboard(teamContext: TeamContext, dashboardId: string): Promise<void>

Параметры

teamContext

TeamContext

Контекст команды для операции

dashboardId

string

Идентификатор удаляемой панели мониторинга.

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

Promise<void>

deleteWidget(TeamContext, string, string)

Удалите указанное мини-приложение.

function deleteWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Dashboard>

Параметры

teamContext

TeamContext

Контекст команды для операции

dashboardId

string

Идентификатор панели мониторинга, содержащей мини-приложение.

widgetId

string

Идентификатор мини-приложения для обновления.

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

Promise<Dashboard>

getDashboard(TeamContext, string)

Получение панели мониторинга по ее идентификатору.

function getDashboard(teamContext: TeamContext, dashboardId: string): Promise<Dashboard>

Параметры

teamContext

TeamContext

Контекст команды для операции

dashboardId

string

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

Promise<Dashboard>

getDashboardsByProject(TeamContext)

Получение списка панелей мониторинга в проекте.

function getDashboardsByProject(teamContext: TeamContext): Promise<Dashboard[]>

Параметры

teamContext

TeamContext

Контекст команды для операции

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

Promise<Dashboard[]>

getWidget(TeamContext, string, string)

Получение текущего состояния указанного мини-приложения.

function getWidget(teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

Параметры

teamContext

TeamContext

Контекст команды для операции

dashboardId

string

Идентификатор панели мониторинга, содержащей мини-приложение.

widgetId

string

Идентификатор считываемого мини-приложения.

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

Promise<Widget>

getWidgetMetadata(string, string)

Получите метаданные мини-приложения, удовлетворяющие указанному идентификатору вклада.

function getWidgetMetadata(contributionId: string, project?: string): Promise<WidgetMetadataResponse>

Параметры

contributionId

string

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

project

string

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

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

Promise<WidgetMetadataResponse>

getWidgetTypes(WidgetScope, string)

Получение всех доступных метаданных мини-приложения в алфавитном порядке, включая мини-приложения, помеченные параметром isVisibleFromCatalog == false.

function getWidgetTypes(scope: WidgetScope, project?: string): Promise<WidgetTypesResponse>

Параметры

scope

WidgetScope

project

string

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

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

Promise<WidgetTypesResponse>

replaceDashboard(Dashboard, TeamContext, string)

Замените конфигурацию для указанной панели мониторинга. Заменяет список мини-приложений на панели мониторинга, только если задано свойство .

function replaceDashboard(dashboard: Dashboard, teamContext: TeamContext, dashboardId: string): Promise<Dashboard>

Параметры

dashboard

Dashboard

Конфигурация заменяемой панели мониторинга.

teamContext

TeamContext

Контекст команды для операции

dashboardId

string

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

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

Promise<Dashboard>

replaceDashboards(DashboardGroup, TeamContext)

Обновите имя и положение панелей мониторинга в предоставленной группе и удалите опущенные панели мониторинга. Не изменяет содержимое панели мониторинга.

function replaceDashboards(group: DashboardGroup, teamContext: TeamContext): Promise<DashboardGroup>

Параметры

group

DashboardGroup

teamContext

TeamContext

Контекст команды для операции

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

Promise<DashboardGroup>

replaceWidget(Widget, TeamContext, string, string)

Переопределите состояние указанного мини-приложения.

function replaceWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

Параметры

widget

Widget

Состояние, записываемое для мини-приложения.

teamContext

TeamContext

Контекст команды для операции

dashboardId

string

Идентификатор панели мониторинга, содержащей мини-приложение.

widgetId

string

Идентификатор мини-приложения для обновления.

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

Promise<Widget>

updateWidget(Widget, TeamContext, string, string)

Выполните частичное обновление указанного мини-приложения.

function updateWidget(widget: Widget, teamContext: TeamContext, dashboardId: string, widgetId: string): Promise<Widget>

Параметры

widget

Widget

Описание применяемых изменений мини-приложения. Все поля, отличные от NULL, будут заменены.

teamContext

TeamContext

Контекст команды для операции

dashboardId

string

Идентификатор панели мониторинга, содержащей мини-приложение.

widgetId

string

Идентификатор мини-приложения для обновления.

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

Promise<Widget>