Workbooks interface

包:

@azure/arm-appinsights

表示工作簿的接口。

方法

createOrUpdate(string, string, Workbook, WorkbooksCreateOrUpdateOptionalParams)	创建新工作簿。
delete(string, string, WorkbooksDeleteOptionalParams)	删除工作簿。
get(string, string, WorkbooksGetOptionalParams)	按其 resourceName 获取单个工作簿。
listByResourceGroup(string, string, WorkbooksListByResourceGroupOptionalParams)	获取在指定资源组和类别中定义的所有工作簿。
listBySubscription(string, WorkbooksListBySubscriptionOptionalParams)	获取在指定订阅和类别中定义的所有工作簿。
listRevisionsList(string, string, WorkbooksRevisionsListOptionalParams)	获取其 resourceName 定义的工作簿的修订。
revisionGet(string, string, string, WorkbooksRevisionGetOptionalParams)	获取由其 revisionId 定义的单个工作簿修订。
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)

按其 resourceName 获取单个工作簿。

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)

获取由其 revisionId 定义的单个工作簿修订。

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

参数

resourceGroupName

string

资源组的名称。 名称不区分大小写。

resourceName

string

工作簿资源的名称。 该值必须是 UUID。

revisionId

string

工作簿修订的 ID。

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>