WorkbookTemplates interface

Package:

@azure/arm-appinsights

Interface representing a WorkbookTemplates.

Methods

createOrUpdate(string, string, WorkbookTemplate, WorkbookTemplatesCreateOrUpdateOptionalParams)	Create a new workbook template.
delete(string, string, WorkbookTemplatesDeleteOptionalParams)	Delete a workbook template.
get(string, string, WorkbookTemplatesGetOptionalParams)	Get a single workbook template by its resourceName.
listByResourceGroup(string, WorkbookTemplatesListByResourceGroupOptionalParams)	Get all Workbook templates defined within a specified resource group.
update(string, string, WorkbookTemplatesUpdateOptionalParams)	Updates a workbook template that has already been added.

Method Details

createOrUpdate(string, string, WorkbookTemplate, WorkbookTemplatesCreateOrUpdateOptionalParams)

Create a new workbook template.

function createOrUpdate(resourceGroupName: string, resourceName: string, workbookTemplateProperties: WorkbookTemplate, options?: WorkbookTemplatesCreateOrUpdateOptionalParams): Promise<WorkbookTemplate>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Application Insights component resource.

workbookTemplateProperties

WorkbookTemplate

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

options

WorkbookTemplatesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<WorkbookTemplate>

delete(string, string, WorkbookTemplatesDeleteOptionalParams)

Delete a workbook template.

function delete(resourceGroupName: string, resourceName: string, options?: WorkbookTemplatesDeleteOptionalParams): 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

WorkbookTemplatesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, WorkbookTemplatesGetOptionalParams)

Get a single workbook template by its resourceName.

function get(resourceGroupName: string, resourceName: string, options?: WorkbookTemplatesGetOptionalParams): Promise<WorkbookTemplate>

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

WorkbookTemplatesGetOptionalParams

The options parameters.

Returns

Promise<WorkbookTemplate>

listByResourceGroup(string, WorkbookTemplatesListByResourceGroupOptionalParams)

Get all Workbook templates defined within a specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: WorkbookTemplatesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<WorkbookTemplate, WorkbookTemplate[], PageSettings>

Parameters

resourceGroupName

string

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

options

WorkbookTemplatesListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<WorkbookTemplate, WorkbookTemplate[], PageSettings>

update(string, string, WorkbookTemplatesUpdateOptionalParams)

Updates a workbook template that has already been added.

function update(resourceGroupName: string, resourceName: string, options?: WorkbookTemplatesUpdateOptionalParams): Promise<WorkbookTemplate>

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

WorkbookTemplatesUpdateOptionalParams

The options parameters.

Returns

Promise<WorkbookTemplate>