Share via

Workbooks class

  • Reference
Package:
@azure/arm-appinsights

Class representing a Workbooks.

Constructors

Workbooks(ApplicationInsightsManagementClientContext)

Create a Workbooks.

Methods

createOrUpdate(string, string, Workbook, ServiceCallback<Workbook>)
createOrUpdate(string, string, Workbook, WorkbooksCreateOrUpdateOptionalParams)

Create a new workbook.
createOrUpdate(string, string, Workbook, WorkbooksCreateOrUpdateOptionalParams, ServiceCallback<Workbook>)
deleteMethod(string, string, RequestOptionsBase)

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

Get a single workbook by its resourceName.
get(string, string, RequestOptionsBase, ServiceCallback<Workbook>)
get(string, string, ServiceCallback<Workbook>)
listByResourceGroup(string, CategoryType, ServiceCallback<WorkbooksListResult>)
listByResourceGroup(string, CategoryType, WorkbooksListByResourceGroupOptionalParams)

Get all Workbooks defined within a specified resource group and category.
listByResourceGroup(string, CategoryType, WorkbooksListByResourceGroupOptionalParams, ServiceCallback<WorkbooksListResult>)
listByResourceGroupNext(string, CategoryType, ServiceCallback<WorkbooksListResult>)
listByResourceGroupNext(string, CategoryType, WorkbooksListByResourceGroupNextOptionalParams)

Get all Workbooks defined within a specified resource group and category.
listByResourceGroupNext(string, CategoryType, WorkbooksListByResourceGroupNextOptionalParams, ServiceCallback<WorkbooksListResult>)
listBySubscription(CategoryType, ServiceCallback<WorkbooksListResult>)
listBySubscription(CategoryType, WorkbooksListBySubscriptionOptionalParams)

Get all private workbooks defined within a specified subscription and category.
listBySubscription(CategoryType, WorkbooksListBySubscriptionOptionalParams, ServiceCallback<WorkbooksListResult>)
listBySubscriptionNext(string, CategoryType, ServiceCallback<WorkbooksListResult>)
listBySubscriptionNext(string, CategoryType, WorkbooksListBySubscriptionNextOptionalParams)

Get all private workbooks defined within a specified subscription and category.
listBySubscriptionNext(string, CategoryType, WorkbooksListBySubscriptionNextOptionalParams, ServiceCallback<WorkbooksListResult>)
revisionGet(string, string, string, RequestOptionsBase)

Get a single workbook revision defined by its revisionId.
revisionGet(string, string, string, RequestOptionsBase, ServiceCallback<Workbook>)
revisionGet(string, string, string, ServiceCallback<Workbook>)
revisionsList(string, string, RequestOptionsBase)

Get the revisions for the workbook defined by its resourceName.
revisionsList(string, string, RequestOptionsBase, ServiceCallback<WorkbooksListResult>)
revisionsList(string, string, ServiceCallback<WorkbooksListResult>)
revisionsListNext(string, RequestOptionsBase)

Get the revisions for the workbook defined by its resourceName.
revisionsListNext(string, RequestOptionsBase, ServiceCallback<WorkbooksListResult>)
revisionsListNext(string, ServiceCallback<WorkbooksListResult>)
update(string, string, ServiceCallback<Workbook>)
update(string, string, WorkbooksUpdateOptionalParams)

Updates a workbook that has already been added.
update(string, string, WorkbooksUpdateOptionalParams, ServiceCallback<Workbook>)

Constructor Details

Workbooks(ApplicationInsightsManagementClientContext)

Create a Workbooks.

new Workbooks(client: ApplicationInsightsManagementClientContext)

Parameters

client
ApplicationInsightsManagementClientContext

Reference to the service client.

Method Details

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

function createOrUpdate(resourceGroupName: string, resourceName: string, workbookProperties: Workbook, callback: ServiceCallback<Workbook>)

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
Workbook

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

callback

ServiceCallback<Workbook>

The callback

createOrUpdate(string, string, Workbook, WorkbooksCreateOrUpdateOptionalParams)

Create a new workbook.

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

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
Workbook

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

options
WorkbooksCreateOrUpdateOptionalParams

The optional parameters

Returns

Promise<WorkbooksCreateOrUpdateResponse>

Promise<Models.WorkbooksCreateOrUpdateResponse>

createOrUpdate(string, string, Workbook, WorkbooksCreateOrUpdateOptionalParams, ServiceCallback<Workbook>) 

function createOrUpdate(resourceGroupName: string, resourceName: string, workbookProperties: Workbook, options: WorkbooksCreateOrUpdateOptionalParams, callback: ServiceCallback<Workbook>)

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
Workbook

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

options
WorkbooksCreateOrUpdateOptionalParams

The optional parameters

callback

ServiceCallback<Workbook>

The callback

deleteMethod(string, string, RequestOptionsBase)

Delete a workbook.

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 by its resourceName.

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

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<WorkbooksGetResponse>

Promise<Models.WorkbooksGetResponse>

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

function get(resourceGroupName: string, resourceName: string, options: RequestOptionsBase, callback: ServiceCallback<Workbook>)

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<Workbook>

The callback

get(string, string, ServiceCallback<Workbook>) 

function get(resourceGroupName: string, resourceName: string, callback: ServiceCallback<Workbook>)

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<Workbook>

The callback

listByResourceGroup(string, CategoryType, ServiceCallback<WorkbooksListResult>) 

function listByResourceGroup(resourceGroupName: string, category: CategoryType, callback: ServiceCallback<WorkbooksListResult>)

Parameters

resourceGroupName

string

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

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

callback

ServiceCallback<WorkbooksListResult>

The callback

listByResourceGroup(string, CategoryType, WorkbooksListByResourceGroupOptionalParams)

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

function listByResourceGroup(resourceGroupName: string, category: CategoryType, options?: WorkbooksListByResourceGroupOptionalParams): Promise<WorkbooksListByResourceGroupResponse>

Parameters

resourceGroupName

string

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

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

options
WorkbooksListByResourceGroupOptionalParams

The optional parameters

Returns

Promise<WorkbooksListByResourceGroupResponse>

Promise<Models.WorkbooksListByResourceGroupResponse>

listByResourceGroup(string, CategoryType, WorkbooksListByResourceGroupOptionalParams, ServiceCallback<WorkbooksListResult>) 

function listByResourceGroup(resourceGroupName: string, category: CategoryType, options: WorkbooksListByResourceGroupOptionalParams, callback: ServiceCallback<WorkbooksListResult>)

Parameters

resourceGroupName

string

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

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

options
WorkbooksListByResourceGroupOptionalParams

The optional parameters

callback

ServiceCallback<WorkbooksListResult>

The callback

listByResourceGroupNext(string, CategoryType, ServiceCallback<WorkbooksListResult>) 

function listByResourceGroupNext(nextPageLink: string, category: CategoryType, callback: ServiceCallback<WorkbooksListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

callback

ServiceCallback<WorkbooksListResult>

The callback

listByResourceGroupNext(string, CategoryType, WorkbooksListByResourceGroupNextOptionalParams)

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

function listByResourceGroupNext(nextPageLink: string, category: CategoryType, options?: WorkbooksListByResourceGroupNextOptionalParams): Promise<WorkbooksListByResourceGroupNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

options
WorkbooksListByResourceGroupNextOptionalParams

The optional parameters

Returns

Promise<WorkbooksListByResourceGroupNextResponse>

Promise<Models.WorkbooksListByResourceGroupNextResponse>

listByResourceGroupNext(string, CategoryType, WorkbooksListByResourceGroupNextOptionalParams, ServiceCallback<WorkbooksListResult>) 

function listByResourceGroupNext(nextPageLink: string, category: CategoryType, options: WorkbooksListByResourceGroupNextOptionalParams, callback: ServiceCallback<WorkbooksListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

options
WorkbooksListByResourceGroupNextOptionalParams

The optional parameters

callback

ServiceCallback<WorkbooksListResult>

The callback

listBySubscription(CategoryType, ServiceCallback<WorkbooksListResult>) 

function listBySubscription(category: CategoryType, callback: ServiceCallback<WorkbooksListResult>)

Parameters

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

callback

ServiceCallback<WorkbooksListResult>

The callback

listBySubscription(CategoryType, WorkbooksListBySubscriptionOptionalParams)

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

function listBySubscription(category: CategoryType, options?: WorkbooksListBySubscriptionOptionalParams): Promise<WorkbooksListBySubscriptionResponse>

Parameters

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

options
WorkbooksListBySubscriptionOptionalParams

The optional parameters

Returns

Promise<WorkbooksListBySubscriptionResponse>

Promise<Models.WorkbooksListBySubscriptionResponse>

listBySubscription(CategoryType, WorkbooksListBySubscriptionOptionalParams, ServiceCallback<WorkbooksListResult>) 

function listBySubscription(category: CategoryType, options: WorkbooksListBySubscriptionOptionalParams, callback: ServiceCallback<WorkbooksListResult>)

Parameters

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

options
WorkbooksListBySubscriptionOptionalParams

The optional parameters

callback

ServiceCallback<WorkbooksListResult>

The callback

listBySubscriptionNext(string, CategoryType, ServiceCallback<WorkbooksListResult>) 

function listBySubscriptionNext(nextPageLink: string, category: CategoryType, callback: ServiceCallback<WorkbooksListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

callback

ServiceCallback<WorkbooksListResult>

The callback

listBySubscriptionNext(string, CategoryType, WorkbooksListBySubscriptionNextOptionalParams)

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

function listBySubscriptionNext(nextPageLink: string, category: CategoryType, options?: WorkbooksListBySubscriptionNextOptionalParams): Promise<WorkbooksListBySubscriptionNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

options
WorkbooksListBySubscriptionNextOptionalParams

The optional parameters

Returns

Promise<WorkbooksListBySubscriptionNextResponse>

Promise<Models.WorkbooksListBySubscriptionNextResponse>

listBySubscriptionNext(string, CategoryType, WorkbooksListBySubscriptionNextOptionalParams, ServiceCallback<WorkbooksListResult>) 

function listBySubscriptionNext(nextPageLink: string, category: CategoryType, options: WorkbooksListBySubscriptionNextOptionalParams, callback: ServiceCallback<WorkbooksListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

category
CategoryType

Category of workbook to return. Possible values include: 'workbook', 'TSG', 'performance', 'retention'

options
WorkbooksListBySubscriptionNextOptionalParams

The optional parameters

callback

ServiceCallback<WorkbooksListResult>

The callback

revisionGet(string, string, string, RequestOptionsBase)

Get a single workbook revision defined by its revisionId.

function revisionGet(resourceGroupName: string, resourceName: string, revisionId: string, options?: RequestOptionsBase): Promise<WorkbooksRevisionGetResponse>

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Application Insights component resource.

revisionId

string

The id of the workbook's revision.

options
RequestOptionsBase

The optional parameters

Returns

Promise<WorkbooksRevisionGetResponse>

Promise<Models.WorkbooksRevisionGetResponse>

revisionGet(string, string, string, RequestOptionsBase, ServiceCallback<Workbook>) 

function revisionGet(resourceGroupName: string, resourceName: string, revisionId: string, options: RequestOptionsBase, callback: ServiceCallback<Workbook>)

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Application Insights component resource.

revisionId

string

The id of the workbook's revision.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<Workbook>

The callback

revisionGet(string, string, string, ServiceCallback<Workbook>) 

function revisionGet(resourceGroupName: string, resourceName: string, revisionId: string, callback: ServiceCallback<Workbook>)

Parameters

resourceGroupName

string

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

resourceName

string

The name of the Application Insights component resource.

revisionId

string

The id of the workbook's revision.

callback

ServiceCallback<Workbook>

The callback

revisionsList(string, string, RequestOptionsBase)

Get the revisions for the workbook defined by its resourceName.

function revisionsList(resourceGroupName: string, resourceName: string, options?: RequestOptionsBase): Promise<WorkbooksRevisionsListResponse>

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<WorkbooksRevisionsListResponse>

Promise<Models.WorkbooksRevisionsListResponse>

revisionsList(string, string, RequestOptionsBase, ServiceCallback<WorkbooksListResult>) 

function revisionsList(resourceGroupName: string, resourceName: string, options: RequestOptionsBase, callback: ServiceCallback<WorkbooksListResult>)

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<WorkbooksListResult>

The callback

revisionsList(string, string, ServiceCallback<WorkbooksListResult>) 

function revisionsList(resourceGroupName: string, resourceName: string, callback: ServiceCallback<WorkbooksListResult>)

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<WorkbooksListResult>

The callback

revisionsListNext(string, RequestOptionsBase)

Get the revisions for the workbook defined by its resourceName.

function revisionsListNext(nextPageLink: string, options?: RequestOptionsBase): Promise<WorkbooksRevisionsListNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<WorkbooksRevisionsListNextResponse>

Promise<Models.WorkbooksRevisionsListNextResponse>

revisionsListNext(string, RequestOptionsBase, ServiceCallback<WorkbooksListResult>) 

function revisionsListNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<WorkbooksListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<WorkbooksListResult>

The callback

revisionsListNext(string, ServiceCallback<WorkbooksListResult>) 

function revisionsListNext(nextPageLink: string, callback: ServiceCallback<WorkbooksListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<WorkbooksListResult>

The callback

update(string, string, ServiceCallback<Workbook>) 

function update(resourceGroupName: string, resourceName: string, callback: ServiceCallback<Workbook>)

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<Workbook>

The callback

update(string, string, WorkbooksUpdateOptionalParams)

Updates a workbook that has already been added.

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

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
WorkbooksUpdateOptionalParams

The optional parameters

Returns

Promise<WorkbooksUpdateResponse>

Promise<Models.WorkbooksUpdateResponse>

update(string, string, WorkbooksUpdateOptionalParams, ServiceCallback<Workbook>) 

function update(resourceGroupName: string, resourceName: string, options: WorkbooksUpdateOptionalParams, callback: ServiceCallback<Workbook>)

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
WorkbooksUpdateOptionalParams

The optional parameters

callback

ServiceCallback<Workbook>

The callback