Workbooks interface

  • Reference
Package:
@azure/arm-appinsights

Interface representing a Workbooks.

Methods

createOrUpdate(string, string, Workbook, WorkbooksCreateOrUpdateOptionalParams)

Create a new workbook.
delete(string, string, WorkbooksDeleteOptionalParams)

Delete a workbook.
get(string, string, WorkbooksGetOptionalParams)

Get a single workbook by its resourceName.
listByResourceGroup(string, string, WorkbooksListByResourceGroupOptionalParams)

Get all Workbooks defined within a specified resource group and category.
listBySubscription(string, WorkbooksListBySubscriptionOptionalParams)

Get all Workbooks defined within a specified subscription and category.
listRevisionsList(string, string, WorkbooksRevisionsListOptionalParams)

Get the revisions for the workbook defined by its resourceName.
revisionGet(string, string, string, WorkbooksRevisionGetOptionalParams)

Get a single workbook revision defined by its revisionId.
update(string, string, WorkbooksUpdateOptionalParams)

Updates a workbook that has already been added.

Method Details

createOrUpdate(string, string, Workbook, WorkbooksCreateOrUpdateOptionalParams)

Create a new workbook.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the resource.

workbookProperties
Workbook

Properties that need to be specified to create a new workbook.

options
WorkbooksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Workbook>

delete(string, string, WorkbooksDeleteOptionalParams)

Delete a workbook.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the resource.

options
WorkbooksDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, WorkbooksGetOptionalParams)

Get a single workbook by its resourceName.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the resource.

options
WorkbooksGetOptionalParams

The options parameters.

Returns

Promise<Workbook>

listByResourceGroup(string, string, WorkbooksListByResourceGroupOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

category

string

Category of workbook to return.

options
WorkbooksListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>

listBySubscription(string, WorkbooksListBySubscriptionOptionalParams)

Get all Workbooks defined within a specified subscription and category.

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

Parameters

category

string

Category of workbook to return.

options
WorkbooksListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>

listRevisionsList(string, string, WorkbooksRevisionsListOptionalParams)

Get the revisions for the workbook defined by its resourceName.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the resource.

options
WorkbooksRevisionsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Workbook, Workbook[], PageSettings>

revisionGet(string, string, string, WorkbooksRevisionGetOptionalParams)

Get a single workbook revision defined by its revisionId.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the resource.

revisionId

string

The id of the workbook's revision.

options
WorkbooksRevisionGetOptionalParams

The options parameters.

Returns

Promise<Workbook>

update(string, string, WorkbooksUpdateOptionalParams)

Updates a workbook that has already been added.

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

resourceName

string

The name of the resource.

options
WorkbooksUpdateOptionalParams

The options parameters.

Returns

Promise<Workbook>