Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Workbooks

Package version

Class representing a Workbooks.

Hierarchy

  • Workbooks

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(resourceGroupName: string, resourceName: string, workbookProperties: Workbook, options?: msRest.RequestOptionsBase): Promise<Models.WorkbooksCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, resourceName: string, workbookProperties: Workbook, callback: msRest.ServiceCallback<Workbook>): void
  • createOrUpdate(resourceGroupName: string, resourceName: string, workbookProperties: Workbook, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Workbook>): void

  • Create a new workbook.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • workbookProperties: Workbook

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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkbooksCreateOrUpdateResponse>

    Promise<Models.WorkbooksCreateOrUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • workbookProperties: Workbook

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

    • callback: msRest.ServiceCallback<Workbook>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • workbookProperties: Workbook

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

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Workbook>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Delete a workbook.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, resourceName: string, options?: msRest.RequestOptionsBase): Promise<Models.WorkbooksGetResponse>
  • get(resourceGroupName: string, resourceName: string, callback: msRest.ServiceCallback<Workbook>): void
  • get(resourceGroupName: string, resourceName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Workbook>): void

  • Get a single workbook by its resourceName.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkbooksGetResponse>

    Promise<Models.WorkbooksGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • callback: msRest.ServiceCallback<Workbook>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Workbook>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, category: Models.CategoryType, options?: Models.WorkbooksListByResourceGroupOptionalParams): Promise<Models.WorkbooksListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, category: Models.CategoryType, callback: msRest.ServiceCallback<WorkbooksListResult>): void
  • listByResourceGroup(resourceGroupName: string, category: Models.CategoryType, options: WorkbooksListByResourceGroupOptionalParams, callback: msRest.ServiceCallback<WorkbooksListResult>): void

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

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • category: Models.CategoryType

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

    • Optional options: Models.WorkbooksListByResourceGroupOptionalParams

    Returns Promise<Models.WorkbooksListByResourceGroupResponse>

    Promise<Models.WorkbooksListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • category: Models.CategoryType

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

    • callback: msRest.ServiceCallback<WorkbooksListResult>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • category: Models.CategoryType

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

    • options: WorkbooksListByResourceGroupOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<WorkbooksListResult>

      The callback

    Returns void

update

  • update(resourceGroupName: string, resourceName: string, workbookProperties: Workbook, options?: msRest.RequestOptionsBase): Promise<Models.WorkbooksUpdateResponse>
  • update(resourceGroupName: string, resourceName: string, workbookProperties: Workbook, callback: msRest.ServiceCallback<Workbook>): void
  • update(resourceGroupName: string, resourceName: string, workbookProperties: Workbook, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Workbook>): void

  • Updates a workbook that has already been added.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • workbookProperties: Workbook

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

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.WorkbooksUpdateResponse>

    Promise<Models.WorkbooksUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • workbookProperties: Workbook

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

    • callback: msRest.ServiceCallback<Workbook>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • resourceName: string

      The name of the Application Insights component resource.

    • workbookProperties: Workbook

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

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Workbook>

      The callback

    Returns void

Generated using TypeDoc