azure.mgmt.applicationinsights.v2022_04_01.operations module

class azure.mgmt.applicationinsights.v2022_04_01.operations.WorkbooksOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

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

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

Create a new 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 resource. Required.
workbook_properties (Workbook or IO[bytes]) – Properties that need to be specified to create a new workbook. Is either a Workbook type or a IO[bytes] type. Required.
source_id (str) – Azure Resource Id that will fetch all linked workbooks. Default value is None.

Returns:

Workbook or the result of cls(response)

Return type:

Workbook

Raises:

HttpResponseError –

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

Delete a 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 resource. Required.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, resource_name: str, can_fetch_content: bool | None = None, **kwargs: Any) → Workbook[source]

Get a single 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 resource. Required.
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:

Workbook or the result of cls(response)

Return type:

Workbook

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[Workbook][source]

Get all 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 Workbook or the result of cls(response)

Return type:

ItemPaged[Workbook]

Raises:

HttpResponseError –

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

Get all 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 Workbook or the result of cls(response)

Return type:

ItemPaged[Workbook]

Raises:

HttpResponseError –

revision_get(resource_group_name: str, resource_name: str, revision_id: str, **kwargs: Any) → Workbook[source]

Get a single workbook revision defined by its revisionId.

Parameters:

resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
resource_name (str) – The name of the resource. Required.
revision_id (str) – The id of the workbook’s revision. Required.

Returns:

Workbook or the result of cls(response)

Return type:

Workbook

Raises:

HttpResponseError –

revisions_list(resource_group_name: str, resource_name: str, **kwargs: Any) → Iterable[Workbook][source]

Get the revisions for the workbook defined 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 resource. Required.

Returns:

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

Return type:

ItemPaged[Workbook]

Raises:

HttpResponseError –

update(resource_group_name: str, resource_name: str, source_id: str | None = None, workbook_update_parameters: WorkbookUpdateParameters | IO[bytes] | None = None, **kwargs: Any) → Workbook[source]

Updates a 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 resource. Required.
source_id (str) – Azure Resource Id that will fetch all linked workbooks. Default value is None.
workbook_update_parameters (WorkbookUpdateParameters or IO[bytes]) – Properties that need to be specified to create a new workbook. Is either a WorkbookUpdateParameters type or a IO[bytes] type. Default value is None.

Returns:

Workbook or the result of cls(response)

Return type:

Workbook

Raises:

HttpResponseError –

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