Workbooks interface

Пакет:

@azure/arm-appinsights

Интерфейс, представляющий книги.

Методы

createOrUpdate(string, string, Workbook, WorkbooksCreateOrUpdateOptionalParams)	Создайте книгу.
delete(string, string, WorkbooksDeleteOptionalParams)	Удаление книги.
get(string, string, WorkbooksGetOptionalParams)	Получение одной книги по имени ресурса.
listByResourceGroup(string, string, WorkbooksListByResourceGroupOptionalParams)	Получение всех книг, определенных в указанной группе ресурсов и категории.
listBySubscription(string, WorkbooksListBySubscriptionOptionalParams)	Получите все книги, определенные в указанной подписке и категории.
listRevisionsList(string, string, WorkbooksRevisionsListOptionalParams)	Получите редакции книги, определенной его resourceName.
revisionGet(string, string, string, WorkbooksRevisionGetOptionalParams)	Получение одной редакции книги, определенной его идентификатором редакции.
update(string, string, WorkbooksUpdateOptionalParams)	Обновляет книгу, которая уже добавлена.

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

createOrUpdate(string, string, Workbook, WorkbooksCreateOrUpdateOptionalParams)

Создайте книгу.

function createOrUpdate(resourceGroupName: string, resourceName: string, workbookProperties: Workbook, options?: WorkbooksCreateOrUpdateOptionalParams): Promise<Workbook>

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

resourceName

string

Имя ресурса книги. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

workbookProperties

Workbook

Свойства, которые необходимо указать для создания новой книги.

options

WorkbooksCreateOrUpdateOptionalParams

Параметры параметров.

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

Promise<Workbook>

delete(string, string, WorkbooksDeleteOptionalParams)

Удаление книги.

function delete(resourceGroupName: string, resourceName: string, options?: WorkbooksDeleteOptionalParams): Promise<void>

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

resourceName

string

Имя ресурса книги. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

options

WorkbooksDeleteOptionalParams

Параметры параметров.

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

Promise<void>

get(string, string, WorkbooksGetOptionalParams)

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

function get(resourceGroupName: string, resourceName: string, options?: WorkbooksGetOptionalParams): Promise<Workbook>

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

resourceName

string

Имя ресурса книги. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

options

WorkbooksGetOptionalParams

Параметры параметров.

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

Promise<Workbook>

listByResourceGroup(string, string, WorkbooksListByResourceGroupOptionalParams)

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

function listByResourceGroup(resourceGroupName: string, category: string, options?: WorkbooksListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

category

string

Категория возвращаемой книги.

options

WorkbooksListByResourceGroupOptionalParams

Параметры параметров.

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

PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>

listBySubscription(string, WorkbooksListBySubscriptionOptionalParams)

Получите все книги, определенные в указанной подписке и категории.

function listBySubscription(category: string, options?: WorkbooksListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>

Параметры

category

string

Категория возвращаемой книги.

options

WorkbooksListBySubscriptionOptionalParams

Параметры параметров.

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

PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>

listRevisionsList(string, string, WorkbooksRevisionsListOptionalParams)

Получите редакции книги, определенной его resourceName.

function listRevisionsList(resourceGroupName: string, resourceName: string, options?: WorkbooksRevisionsListOptionalParams): PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

resourceName

string

Имя ресурса книги. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

options

WorkbooksRevisionsListOptionalParams

Параметры параметров.

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

PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>

revisionGet(string, string, string, WorkbooksRevisionGetOptionalParams)

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

function revisionGet(resourceGroupName: string, resourceName: string, revisionId: string, options?: WorkbooksRevisionGetOptionalParams): Promise<Workbook>

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

resourceName

string

Имя ресурса книги. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

revisionId

string

Идентификатор редакции книги.

options

WorkbooksRevisionGetOptionalParams

Параметры параметров.

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

Promise<Workbook>

update(string, string, WorkbooksUpdateOptionalParams)

Обновляет книгу, которая уже добавлена.

function update(resourceGroupName: string, resourceName: string, options?: WorkbooksUpdateOptionalParams): Promise<Workbook>

Параметры

resourceGroupName

string

Имя группы ресурсов. Имя не учитывает регистр.

resourceName

string

Имя ресурса книги. Значение должно быть Универсальным Уникальным Идентификатором (UUID).

options

WorkbooksUpdateOptionalParams

Параметры параметров.

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

Promise<Workbook>