MyWorkbooks class

Class representing a MyWorkbooks.

Constructors

MyWorkbooks(ApplicationInsightsManagementClientContext)

Create a MyWorkbooks.

Methods

createOrUpdate(string, string, MyWorkbook, MyWorkbooksCreateOrUpdateOptionalParams)

Create a new private workbook.

createOrUpdate(string, string, MyWorkbook, MyWorkbooksCreateOrUpdateOptionalParams, ServiceCallback<MyWorkbook>)
createOrUpdate(string, string, MyWorkbook, ServiceCallback<MyWorkbook>)
deleteMethod(string, string, RequestOptionsBase)

Delete a private workbook.

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

Get a single private workbook by its resourceName.

get(string, string, RequestOptionsBase, ServiceCallback<MyWorkbook>)
get(string, string, ServiceCallback<MyWorkbook>)
listByResourceGroup(string, CategoryType, MyWorkbooksListByResourceGroupOptionalParams)

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

listByResourceGroup(string, CategoryType, MyWorkbooksListByResourceGroupOptionalParams, ServiceCallback<MyWorkbooksListResult>)
listByResourceGroup(string, CategoryType, ServiceCallback<MyWorkbooksListResult>)
listByResourceGroupNext(string, CategoryType, MyWorkbooksListByResourceGroupNextOptionalParams)

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

listByResourceGroupNext(string, CategoryType, MyWorkbooksListByResourceGroupNextOptionalParams, ServiceCallback<MyWorkbooksListResult>)
listByResourceGroupNext(string, CategoryType, ServiceCallback<MyWorkbooksListResult>)
listBySubscription(CategoryType, MyWorkbooksListBySubscriptionOptionalParams)

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

listBySubscription(CategoryType, MyWorkbooksListBySubscriptionOptionalParams, ServiceCallback<MyWorkbooksListResult>)
listBySubscription(CategoryType, ServiceCallback<MyWorkbooksListResult>)
listBySubscriptionNext(string, CategoryType, MyWorkbooksListBySubscriptionNextOptionalParams)

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

listBySubscriptionNext(string, CategoryType, MyWorkbooksListBySubscriptionNextOptionalParams, ServiceCallback<MyWorkbooksListResult>)
listBySubscriptionNext(string, CategoryType, ServiceCallback<MyWorkbooksListResult>)
update(string, string, MyWorkbook, MyWorkbooksUpdateOptionalParams)

Updates a private workbook that has already been added.

update(string, string, MyWorkbook, MyWorkbooksUpdateOptionalParams, ServiceCallback<MyWorkbook>)
update(string, string, MyWorkbook, ServiceCallback<MyWorkbook>)

Constructor Details

MyWorkbooks(ApplicationInsightsManagementClientContext)

Create a MyWorkbooks.

new MyWorkbooks(client: ApplicationInsightsManagementClientContext)

Parameters

client
ApplicationInsightsManagementClientContext

Reference to the service client.

Method Details

createOrUpdate(string, string, MyWorkbook, MyWorkbooksCreateOrUpdateOptionalParams)

Create a new private workbook.

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

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

Returns

Promise<Models.MyWorkbooksCreateOrUpdateResponse>

createOrUpdate(string, string, MyWorkbook, MyWorkbooksCreateOrUpdateOptionalParams, ServiceCallback<MyWorkbook>)

function createOrUpdate(resourceGroupName: string, resourceName: string, workbookProperties: MyWorkbook, options: MyWorkbooksCreateOrUpdateOptionalParams, callback: ServiceCallback<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 optional parameters

callback

ServiceCallback<MyWorkbook>

The callback

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

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

callback

ServiceCallback<MyWorkbook>

The callback

deleteMethod(string, string, RequestOptionsBase)

Delete a private 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 private workbook by its resourceName.

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

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<Models.MyWorkbooksGetResponse>

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

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

The optional parameters

callback

ServiceCallback<MyWorkbook>

The callback

get(string, string, ServiceCallback<MyWorkbook>)

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

callback

ServiceCallback<MyWorkbook>

The callback

listByResourceGroup(string, CategoryType, MyWorkbooksListByResourceGroupOptionalParams)

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

function listByResourceGroup(resourceGroupName: string, category: CategoryType, options?: MyWorkbooksListByResourceGroupOptionalParams): Promise<MyWorkbooksListByResourceGroupResponse>

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
MyWorkbooksListByResourceGroupOptionalParams

The optional parameters

Returns

Promise<Models.MyWorkbooksListByResourceGroupResponse>

listByResourceGroup(string, CategoryType, MyWorkbooksListByResourceGroupOptionalParams, ServiceCallback<MyWorkbooksListResult>)

function listByResourceGroup(resourceGroupName: string, category: CategoryType, options: MyWorkbooksListByResourceGroupOptionalParams, callback: ServiceCallback<MyWorkbooksListResult>)

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
MyWorkbooksListByResourceGroupOptionalParams

The optional parameters

callback

ServiceCallback<MyWorkbooksListResult>

The callback

listByResourceGroup(string, CategoryType, ServiceCallback<MyWorkbooksListResult>)

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

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

The callback

listByResourceGroupNext(string, CategoryType, MyWorkbooksListByResourceGroupNextOptionalParams)

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

function listByResourceGroupNext(nextPageLink: string, category: CategoryType, options?: MyWorkbooksListByResourceGroupNextOptionalParams): Promise<MyWorkbooksListByResourceGroupNextResponse>

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
MyWorkbooksListByResourceGroupNextOptionalParams

The optional parameters

Returns

Promise<Models.MyWorkbooksListByResourceGroupNextResponse>

listByResourceGroupNext(string, CategoryType, MyWorkbooksListByResourceGroupNextOptionalParams, ServiceCallback<MyWorkbooksListResult>)

function listByResourceGroupNext(nextPageLink: string, category: CategoryType, options: MyWorkbooksListByResourceGroupNextOptionalParams, callback: ServiceCallback<MyWorkbooksListResult>)

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
MyWorkbooksListByResourceGroupNextOptionalParams

The optional parameters

callback

ServiceCallback<MyWorkbooksListResult>

The callback

listByResourceGroupNext(string, CategoryType, ServiceCallback<MyWorkbooksListResult>)

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

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

The callback

listBySubscription(CategoryType, MyWorkbooksListBySubscriptionOptionalParams)

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

function listBySubscription(category: CategoryType, options?: MyWorkbooksListBySubscriptionOptionalParams): Promise<MyWorkbooksListBySubscriptionResponse>

Parameters

category
CategoryType

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

options
MyWorkbooksListBySubscriptionOptionalParams

The optional parameters

Returns

Promise<Models.MyWorkbooksListBySubscriptionResponse>

listBySubscription(CategoryType, MyWorkbooksListBySubscriptionOptionalParams, ServiceCallback<MyWorkbooksListResult>)

function listBySubscription(category: CategoryType, options: MyWorkbooksListBySubscriptionOptionalParams, callback: ServiceCallback<MyWorkbooksListResult>)

Parameters

category
CategoryType

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

options
MyWorkbooksListBySubscriptionOptionalParams

The optional parameters

callback

ServiceCallback<MyWorkbooksListResult>

The callback

listBySubscription(CategoryType, ServiceCallback<MyWorkbooksListResult>)

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

Parameters

category
CategoryType

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

callback

ServiceCallback<MyWorkbooksListResult>

The callback

listBySubscriptionNext(string, CategoryType, MyWorkbooksListBySubscriptionNextOptionalParams)

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

function listBySubscriptionNext(nextPageLink: string, category: CategoryType, options?: MyWorkbooksListBySubscriptionNextOptionalParams): Promise<MyWorkbooksListBySubscriptionNextResponse>

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
MyWorkbooksListBySubscriptionNextOptionalParams

The optional parameters

Returns

Promise<Models.MyWorkbooksListBySubscriptionNextResponse>

listBySubscriptionNext(string, CategoryType, MyWorkbooksListBySubscriptionNextOptionalParams, ServiceCallback<MyWorkbooksListResult>)

function listBySubscriptionNext(nextPageLink: string, category: CategoryType, options: MyWorkbooksListBySubscriptionNextOptionalParams, callback: ServiceCallback<MyWorkbooksListResult>)

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
MyWorkbooksListBySubscriptionNextOptionalParams

The optional parameters

callback

ServiceCallback<MyWorkbooksListResult>

The callback

listBySubscriptionNext(string, CategoryType, ServiceCallback<MyWorkbooksListResult>)

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

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

The callback

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

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

Returns

Promise<Models.MyWorkbooksUpdateResponse>

update(string, string, MyWorkbook, MyWorkbooksUpdateOptionalParams, ServiceCallback<MyWorkbook>)

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

callback

ServiceCallback<MyWorkbook>

The callback

update(string, string, MyWorkbook, ServiceCallback<MyWorkbook>)

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

callback

ServiceCallback<MyWorkbook>

The callback