WorkbooksOperations interface

Package:
@azure/arm-appinsights

Interface representing a Workbooks operations.

Properties

createOrUpdate

Create a new workbook.
delete

Delete a workbook.
get

Get a single workbook by its resourceName.
listByResourceGroup

Get all Workbooks defined within a specified resource group and category.
listBySubscription

Get all Workbooks defined within a specified subscription and category.
listRevisionsList

Get the revisions for the workbook defined by its resourceName.
revisionGet

Get a single workbook revision defined by its revisionId.
update

Updates a workbook that has already been added.

Property Details

createOrUpdate

Create a new workbook.

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

Property Value

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

delete

Delete a workbook.

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

Property Value

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

get

Get a single workbook by its resourceName.

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

Property Value

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

listByResourceGroup

Get all Workbooks defined within a specified resource group and category.

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

Property Value

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

listBySubscription

Get all Workbooks defined within a specified subscription and category.

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

Property Value

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

listRevisionsList

Get the revisions for the workbook defined by its resourceName.

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

Property Value

(resourceGroupName: string, resourceName: string, options?: WorkbooksListRevisionsListOptionalParams) => PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>

revisionGet

Get a single workbook revision defined by its revisionId.

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

Property Value

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

update

Updates a workbook that has already been added.

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

Property Value

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