WorkbooksOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ApplicationInsightsManagementClient's

<xref:workbooks> attribute.

Inheritance

builtins.object

WorkbooksOperations

Constructor

WorkbooksOperations(*args, **kwargs)

Methods

create_or_update	Create a new workbook.
delete	Delete a workbook.
get	Get a single workbook by its resourceName.
list_by_resource_group	Get all Workbooks defined within a specified resource group and category.
update	Updates a workbook that has already been added.

create_or_update

Create a new workbook.

create_or_update(resource_group_name: str, resource_name: str, source_id: str, workbook_properties: _models.Workbook, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Workbook

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
resource_name Required	str The name of the Application Insights component resource. Required.
source_id Required	str Azure Resource Id that will fetch all related workbooks. Required.
workbook_properties Required	Workbook or IO Properties that need to be specified to create a new workbook. Is either a Workbook type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Workbook	Workbook or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Delete a workbook.

delete(resource_group_name: str, resource_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
resource_name Required	str The name of the Application Insights component resource. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get a single workbook by its resourceName.

get(resource_group_name: str, resource_name: str, **kwargs: Any) -> Workbook

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
resource_name Required	str The name of the Application Insights component resource. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Workbook	Workbook or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

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

list_by_resource_group(resource_group_name: str, category: str | CategoryType, source_id: str, tags: List[str] | None = None, can_fetch_content: bool | None = None, **kwargs: Any) -> Iterable[Workbook]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
category Required	str or CategoryType Category of workbook to return. Known values are: "workbook", "TSG", "performance", and "retention". Required.
source_id Required	str Azure Resource Id that will fetch all related workbooks. Required.
tags Required	list[str] Tags presents on each workbook returned. Default value is None.
can_fetch_content Required	bool Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks. Default value is None.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[Workbook]	An iterator like instance of either Workbook or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Updates a workbook that has already been added.

update(resource_group_name: str, resource_name: str, source_id: str, workbook_update_parameters: _models.WorkbookUpdateParameters | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Workbook

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
resource_name Required	str The name of the Application Insights component resource. Required.
source_id Required	str Azure Resource Id that will fetch all related workbooks. Required.
workbook_update_parameters Required	WorkbookUpdateParameters or IO Properties that need to be specified to create a new workbook. Is either a WorkbookUpdateParameters type or a IO type. Default value is None.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Workbook	Workbook or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.applicationinsights.v2018_06_17_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\applicationinsights\\v2018_06_17_preview\\models\\__init__.py'>