ComponentsOperations Class

ComponentsOperations 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

ComponentsOperations

Constructor

ComponentsOperations(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: "2020-02-02-preview".

Methods

create_or_update	Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.
delete	Deletes an Application Insights component.
get	Returns an Application Insights component.
get_purge_status	Get status for an ongoing purge operation.
list	Gets a list of all Application Insights components within a subscription.
list_by_resource_group	Gets a list of Application Insights components within a resource group.
purge	Purges data in an Application Insights component by a set of user-defined filters. In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.
update_tags	Updates an existing component's tags. To update other fields use the CreateOrUpdate method.

create_or_update

Creates (or updates) an Application Insights component. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.

create_or_update(resource_group_name, resource_name, insight_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.

insight_properties

ApplicationInsightsComponent

Required

Properties that need to be specified to create an Application Insights component.

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

ApplicationInsightsComponent or ClientRawResponse if raw=true

Return type

ApplicationInsightsComponent,

ClientRawResponse

Exceptions

CloudError

delete

Deletes an Application Insights component.

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

CloudError

get

Returns an Application Insights component.

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

ApplicationInsightsComponent or ClientRawResponse if raw=true

Return type

ApplicationInsightsComponent,

ClientRawResponse

Exceptions

CloudError

get_purge_status

Get status for an ongoing purge operation.

get_purge_status(resource_group_name, resource_name, purge_id, 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.

purge_id

str

Required

In a purge status request, this is the Id of the operation the status of which is returned.

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

ComponentPurgeStatusResponse or ClientRawResponse if raw=true

Return type

ComponentPurgeStatusResponse,

ClientRawResponse

Exceptions

CloudError

list

Gets a list of all Application Insights components within a subscription.

list(custom_headers=None, raw=False, **operation_config)

Parameters

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 ApplicationInsightsComponent

Return type

ApplicationInsightsComponentPaged[ApplicationInsightsComponent]

Exceptions

CloudError

list_by_resource_group

Gets a list of Application Insights components within a resource group.

list_by_resource_group(resource_group_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.

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 ApplicationInsightsComponent

Return type

ApplicationInsightsComponentPaged[ApplicationInsightsComponent]

Exceptions

CloudError

purge

Purges data in an Application Insights component by a set of user-defined filters. In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.

purge(resource_group_name, resource_name, table, filters, 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.

table

str

Required

Table from which to purge data.

filters

list[ComponentPurgeBodyFilters]

Required

The set of columns and filters (queries) to run over them to purge the resulting data.

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

ComponentPurgeResponse or ClientRawResponse if raw=true

Return type

ComponentPurgeResponse,

ClientRawResponse

Exceptions

CloudError

update_tags

Updates an existing component's tags. To update other fields use the CreateOrUpdate method.

update_tags(resource_group_name, resource_name, tags=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.

tags

dict[str, str]

default value: None

Resource tags

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

ApplicationInsightsComponent or ClientRawResponse if raw=true

Return type

ApplicationInsightsComponent,

ClientRawResponse

Exceptions

CloudError

Attributes

models

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