Share via

WorkbookTemplates class

  • Reference
Package:
@azure/arm-appinsights

Class representing a WorkbookTemplates.

Constructors

WorkbookTemplates(ApplicationInsightsManagementClientContext)

Create a WorkbookTemplates.

Methods

createOrUpdate(string, string, WorkbookTemplate, RequestOptionsBase)

Create a new workbook template.
createOrUpdate(string, string, WorkbookTemplate, RequestOptionsBase, ServiceCallback<WorkbookTemplate>)
createOrUpdate(string, string, WorkbookTemplate, ServiceCallback<WorkbookTemplate>)
deleteMethod(string, string, RequestOptionsBase)

Delete a workbook template.
deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>)
deleteMethod(string, string, ServiceCallback<void>)
get(string, string, RequestOptionsBase)

Get a single workbook template by its resourceName.
get(string, string, RequestOptionsBase, ServiceCallback<WorkbookTemplate>)
get(string, string, ServiceCallback<WorkbookTemplate>)
listByResourceGroup(string, RequestOptionsBase)

Get all Workbook templates defined within a specified resource group.
listByResourceGroup(string, RequestOptionsBase, ServiceCallback<WorkbookTemplatesListResult>)
listByResourceGroup(string, ServiceCallback<WorkbookTemplatesListResult>)
update(string, string, ServiceCallback<WorkbookTemplate>)
update(string, string, WorkbookTemplatesUpdateOptionalParams)

Updates a workbook template that has already been added.
update(string, string, WorkbookTemplatesUpdateOptionalParams, ServiceCallback<WorkbookTemplate>)

Constructor Details

WorkbookTemplates(ApplicationInsightsManagementClientContext)

Create a WorkbookTemplates.

new WorkbookTemplates(client: ApplicationInsightsManagementClientContext)

Parameters

client
ApplicationInsightsManagementClientContext

Reference to the service client.

Method Details

createOrUpdate(string, string, WorkbookTemplate, RequestOptionsBase)

Create a new workbook template.

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

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
RequestOptionsBase

The optional parameters

Returns

Promise<WorkbookTemplatesCreateOrUpdateResponse>

Promise<Models.WorkbookTemplatesCreateOrUpdateResponse>

createOrUpdate(string, string, WorkbookTemplate, RequestOptionsBase, ServiceCallback<WorkbookTemplate>) 

function createOrUpdate(resourceGroupName: string, resourceName: string, workbookTemplateProperties: WorkbookTemplate, options: RequestOptionsBase, callback: ServiceCallback<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
RequestOptionsBase

The optional parameters

callback

ServiceCallback<WorkbookTemplate>

The callback

createOrUpdate(string, string, WorkbookTemplate, ServiceCallback<WorkbookTemplate>) 

function createOrUpdate(resourceGroupName: string, resourceName: string, workbookTemplateProperties: WorkbookTemplate, callback: ServiceCallback<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.

callback

ServiceCallback<WorkbookTemplate>

The callback

deleteMethod(string, string, RequestOptionsBase)

Delete a workbook template.

function deleteMethod(resourceGroupName: string, resourceName: string, options?: RequestOptionsBase): Promise<RestResponse>

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
RequestOptionsBase

The optional parameters

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteMethod(string, string, RequestOptionsBase, ServiceCallback<void>) 

function deleteMethod(resourceGroupName: string, resourceName: string, options: RequestOptionsBase, callback: ServiceCallback<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
RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

deleteMethod(string, string, ServiceCallback<void>) 

function deleteMethod(resourceGroupName: string, resourceName: string, callback: ServiceCallback<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.

callback

ServiceCallback<void>

The callback

get(string, string, RequestOptionsBase)

Get a single workbook template by its resourceName.

function get(resourceGroupName: string, resourceName: string, options?: RequestOptionsBase): Promise<WorkbookTemplatesGetResponse>

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
RequestOptionsBase

The optional parameters

Returns

Promise<WorkbookTemplatesGetResponse>

Promise<Models.WorkbookTemplatesGetResponse>

get(string, string, RequestOptionsBase, ServiceCallback<WorkbookTemplate>) 

function get(resourceGroupName: string, resourceName: string, options: RequestOptionsBase, callback: ServiceCallback<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
RequestOptionsBase

The optional parameters

callback

ServiceCallback<WorkbookTemplate>

The callback

get(string, string, ServiceCallback<WorkbookTemplate>) 

function get(resourceGroupName: string, resourceName: string, callback: ServiceCallback<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.

callback

ServiceCallback<WorkbookTemplate>

The callback

listByResourceGroup(string, RequestOptionsBase)

Get all Workbook templates defined within a specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: RequestOptionsBase): Promise<WorkbookTemplatesListByResourceGroupResponse>

Parameters

resourceGroupName

string

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

options
RequestOptionsBase

The optional parameters

Returns

Promise<WorkbookTemplatesListByResourceGroupResponse>

Promise<Models.WorkbookTemplatesListByResourceGroupResponse>

listByResourceGroup(string, RequestOptionsBase, ServiceCallback<WorkbookTemplatesListResult>) 

function listByResourceGroup(resourceGroupName: string, options: RequestOptionsBase, callback: ServiceCallback<WorkbookTemplatesListResult>)

Parameters

resourceGroupName

string

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

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<WorkbookTemplatesListResult>

The callback

listByResourceGroup(string, ServiceCallback<WorkbookTemplatesListResult>) 

function listByResourceGroup(resourceGroupName: string, callback: ServiceCallback<WorkbookTemplatesListResult>)

Parameters

resourceGroupName

string

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

callback

ServiceCallback<WorkbookTemplatesListResult>

The callback

update(string, string, ServiceCallback<WorkbookTemplate>) 

function update(resourceGroupName: string, resourceName: string, callback: ServiceCallback<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.

callback

ServiceCallback<WorkbookTemplate>

The callback

update(string, string, WorkbookTemplatesUpdateOptionalParams)

Updates a workbook template that has already been added.

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

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 optional parameters

Returns

Promise<WorkbookTemplatesUpdateResponse>

Promise<Models.WorkbookTemplatesUpdateResponse>

update(string, string, WorkbookTemplatesUpdateOptionalParams, ServiceCallback<WorkbookTemplate>) 

function update(resourceGroupName: string, resourceName: string, options: WorkbookTemplatesUpdateOptionalParams, callback: ServiceCallback<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 optional parameters

callback

ServiceCallback<WorkbookTemplate>

The callback