azure.mgmt.applicationinsights.v2020_02_02_preview.operations module

class azure.mgmt.applicationinsights.v2020_02_02_preview.operations.ComponentsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

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

create_or_update(resource_group_name: str, resource_name: str, insight_properties: ApplicationInsightsComponent | IO[bytes], **kwargs: Any) → ApplicationInsightsComponent[source]

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

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.

  • insight_properties (ApplicationInsightsComponent or IO[bytes]) – Properties that need to be specified to create an Application Insights component. Is either a ApplicationInsightsComponent type or a IO[bytes] type. Required.

Returns:

ApplicationInsightsComponent or the result of cls(response)

Return type:

ApplicationInsightsComponent

Raises:

HttpResponseError –

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

Deletes an Application Insights component.

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) → ApplicationInsightsComponent[source]

Returns an Application Insights component.

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:

ApplicationInsightsComponent or the result of cls(response)

Return type:

ApplicationInsightsComponent

Raises:

HttpResponseError –

get_purge_status(resource_group_name: str, resource_name: str, purge_id: str, **kwargs: Any) → ComponentPurgeStatusResponse[source]

Get status for an ongoing purge operation.

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.

  • purge_id (str) – In a purge status request, this is the Id of the operation the status of which is returned. Required.

Returns:

ComponentPurgeStatusResponse or the result of cls(response)

Return type:

ComponentPurgeStatusResponse

Raises:

HttpResponseError –

list(**kwargs: Any) → Iterable[ApplicationInsightsComponent][source]

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

Returns:

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

Return type:

ItemPaged[ApplicationInsightsComponent]

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[ApplicationInsightsComponent][source]

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

Parameters:

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

Returns:

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

Return type:

ItemPaged[ApplicationInsightsComponent]

Raises:

HttpResponseError –

purge(resource_group_name: str, resource_name: str, body: ComponentPurgeBody | IO[bytes], **kwargs: Any) → ComponentPurgeResponse[source]

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.

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.

  • body (ComponentPurgeBody or IO[bytes]) – Describes the body of a request to purge data in a single table of an Application Insights component. Is either a ComponentPurgeBody type or a IO[bytes] type. Required.

Returns:

ComponentPurgeResponse or the result of cls(response)

Return type:

ComponentPurgeResponse

Raises:

HttpResponseError –

update_tags(resource_group_name: str, resource_name: str, component_tags: TagsResource | IO[bytes], **kwargs: Any) → ApplicationInsightsComponent[source]

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

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.

  • component_tags (TagsResource or IO[bytes]) – Updated tag information to set into the component instance. Is either a TagsResource type or a IO[bytes] type. Required.

Returns:

ApplicationInsightsComponent or the result of cls(response)

Return type:

ApplicationInsightsComponent

Raises:

HttpResponseError –

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