azure.mgmt.applicationinsights.v2021_03_08.operations module

class azure.mgmt.applicationinsights.v2021_03_08.operations.MyWorkbooksOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApplicationInsightsManagementClient’s my_workbooks attribute.

create_or_update(resource_group_name: str, resource_name: str, workbook_properties: MyWorkbook | IO[bytes], source_id: str | None = None, **kwargs: Any) → MyWorkbook[source]

Create a new private workbook.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • resource_name (str) – The name of the Application Insights component resource. Required.

  • workbook_properties (MyWorkbook or IO[bytes]) – Properties that need to be specified to create a new private workbook. Is either a MyWorkbook type or a IO[bytes] type. Required.

  • source_id (str) – Azure Resource Id that will fetch all linked workbooks. Default value is None.

Returns:

MyWorkbook or the result of cls(response)

Return type:

MyWorkbook

Raises:

HttpResponseError –

delete(resource_group_name: str, resource_name: str, **kwargs: Any) → None[source]

Delete a private workbook.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • resource_name (str) – The name of the Application Insights component resource. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, resource_name: str, **kwargs: Any) → MyWorkbook[source]

Get a single private workbook by its resourceName.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • resource_name (str) – The name of the Application Insights component resource. Required.

Returns:

MyWorkbook or the result of cls(response)

Return type:

MyWorkbook

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, category: str | CategoryType, tags: List[str] | None = None, source_id: str | None = None, can_fetch_content: bool | None = None, **kwargs: Any) → Iterable[MyWorkbook][source]

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

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • category (str or CategoryType) – Category of workbook to return. Known values are: “workbook”, “TSG”, “performance”, and “retention”. Required.

  • tags (list[str]) – Tags presents on each workbook returned. Default value is None.

  • source_id (str) – Azure Resource Id that will fetch all linked workbooks. Default value is None.

  • can_fetch_content (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.

Returns:

An iterator like instance of either MyWorkbook or the result of cls(response)

Return type:

ItemPaged[MyWorkbook]

Raises:

HttpResponseError –

list_by_subscription(category: str | CategoryType, tags: List[str] | None = None, can_fetch_content: bool | None = None, **kwargs: Any) → Iterable[MyWorkbook][source]

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

Parameters:

  • category (str or CategoryType) – Category of workbook to return. Known values are: “workbook”, “TSG”, “performance”, and “retention”. Required.

  • tags (list[str]) – Tags presents on each workbook returned. Default value is None.

  • can_fetch_content (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.

Returns:

An iterator like instance of either MyWorkbook or the result of cls(response)

Return type:

ItemPaged[MyWorkbook]

Raises:

HttpResponseError –

update(resource_group_name: str, resource_name: str, workbook_properties: MyWorkbook | IO[bytes], source_id: str | None = None, **kwargs: Any) → MyWorkbook[source]

Updates a private workbook that has already been added.

Parameters:

  • resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.

  • resource_name (str) – The name of the Application Insights component resource. Required.

  • workbook_properties (MyWorkbook or IO[bytes]) – Properties that need to be specified to create a new private workbook. Is either a MyWorkbook type or a IO[bytes] type. Required.

  • source_id (str) – Azure Resource Id that will fetch all linked workbooks. Default value is None.

Returns:

MyWorkbook or the result of cls(response)

Return type:

MyWorkbook

Raises:

HttpResponseError –

models = <module 'azure.mgmt.applicationinsights.v2021_03_08.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2021_03_08/models/__init__.py'>