WorkbooksOperations Class

WorkbooksOperations operations.

You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.

Inheritance

builtins.object

WorkbooksOperations

Constructor

WorkbooksOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

api_version

The API version to use for this operation. Constant value: "2018-06-17-preview".

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, resource_name, source_id, workbook_properties, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

The name of the Application Insights component resource.

source_id

str

Required

Azure Resource Id that will fetch all related workbooks.

workbook_properties

Workbook

Required

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

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

Workbook or ClientRawResponse if raw=true

Return type

Workbook,

ClientRawResponse

Exceptions

WorkbookErrorException

delete

Delete a workbook.

delete(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

The name of the Application Insights component resource.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None,

ClientRawResponse

Exceptions

WorkbookErrorException

get

Get a single workbook by its resourceName.

get(resource_group_name, resource_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

The name of the Application Insights component resource.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

Workbook or ClientRawResponse if raw=true

Return type

Workbook,

ClientRawResponse

Exceptions

WorkbookErrorException

list_by_resource_group

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

list_by_resource_group(resource_group_name, category, source_id, tags=None, can_fetch_content=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

category

str or CategoryType

Required

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

source_id

str

Required

Azure Resource Id that will fetch all related workbooks.

tags

list[str]

default value: None

Tags presents on each workbook returned.

can_fetch_content

bool

default value: None

Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

An iterator like instance of Workbook

Return type

WorkbookPaged[Workbook]

Exceptions

WorkbookErrorException

update

Updates a workbook that has already been added.

update(resource_group_name, resource_name, source_id, workbook_update_parameters=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name

str

Required

The name of the resource group. The name is case insensitive.

resource_name

str

Required

The name of the Application Insights component resource.

source_id

str

Required

Azure Resource Id that will fetch all related workbooks.

workbook_update_parameters

WorkbookUpdateParameters

default value: None

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

custom_headers

dict

default value: None

headers that will be added to the request

raw

bool

default value: False

returns the direct response alongside the deserialized response

operation_config

Required

Operation configuration overrides.

Returns

Workbook or ClientRawResponse if raw=true

Return type

Workbook,

ClientRawResponse

Exceptions

WorkbookErrorException

Attributes

models

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