MyWorkbooks interface

Package:

@azure/arm-appinsights

Interface representing a MyWorkbooks.

Methods

createOrUpdate(string, string, MyWorkbook, MyWorkbooksCreateOrUpdateOptionalParams)	Create a new private workbook.
delete(string, string, MyWorkbooksDeleteOptionalParams)	Delete a private workbook.
get(string, string, MyWorkbooksGetOptionalParams)	Get a single private workbook by its resourceName.
listByResourceGroup(string, string, MyWorkbooksListByResourceGroupOptionalParams)	Get all private workbooks defined within a specified resource group and category.
listBySubscription(string, MyWorkbooksListBySubscriptionOptionalParams)	Get all private workbooks defined within a specified subscription and category.
update(string, string, MyWorkbook, MyWorkbooksUpdateOptionalParams)	Updates a private workbook that has already been added.

Method Details

createOrUpdate(string, string, MyWorkbook, MyWorkbooksCreateOrUpdateOptionalParams)

Create a new private workbook.

function createOrUpdate(resourceGroupName: string, resourceName: string, workbookProperties: MyWorkbook, options?: MyWorkbooksCreateOrUpdateOptionalParams): Promise<MyWorkbook>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Application Insights component resource.

workbookProperties

MyWorkbook

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

options

MyWorkbooksCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<MyWorkbook>

delete(string, string, MyWorkbooksDeleteOptionalParams)

Delete a private workbook.

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

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Application Insights component resource.

options

MyWorkbooksDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, MyWorkbooksGetOptionalParams)

Get a single private workbook by its resourceName.

function get(resourceGroupName: string, resourceName: string, options?: MyWorkbooksGetOptionalParams): Promise<MyWorkbook>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Application Insights component resource.

options

MyWorkbooksGetOptionalParams

The options parameters.

Returns

Promise<MyWorkbook>

listByResourceGroup(string, string, MyWorkbooksListByResourceGroupOptionalParams)

Get all private workbooks defined within a specified resource group and category.

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

Parameters

resourceGroupName

string

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

category

string

Category of workbook to return.

options

MyWorkbooksListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MyWorkbook, MyWorkbook[], PageSettings>

listBySubscription(string, MyWorkbooksListBySubscriptionOptionalParams)

Get all private workbooks defined within a specified subscription and category.

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

Parameters

category

string

Category of workbook to return.

options

MyWorkbooksListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MyWorkbook, MyWorkbook[], PageSettings>

update(string, string, MyWorkbook, MyWorkbooksUpdateOptionalParams)

Updates a private workbook that has already been added.

function update(resourceGroupName: string, resourceName: string, workbookProperties: MyWorkbook, options?: MyWorkbooksUpdateOptionalParams): Promise<MyWorkbook>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Application Insights component resource.

workbookProperties

MyWorkbook

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

options

MyWorkbooksUpdateOptionalParams

The options parameters.

Returns

Promise<MyWorkbook>