azure.mgmt.applicationinsights.v2015_05_01.operations module
- class azure.mgmt.applicationinsights.v2015_05_01.operations.APIKeysOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’sapi_keys
attribute.- create(resource_group_name: str, resource_name: str, api_key_properties: APIKeyRequest | IO[bytes], **kwargs: Any) ApplicationInsightsComponentAPIKey [source]
Create an API Key of 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.
api_key_properties (APIKeyRequest or IO[bytes]) – Properties that need to be specified to create an API key of a Application Insights component. Is either a APIKeyRequest type or a IO[bytes] type. Required.
- Returns:
ApplicationInsightsComponentAPIKey or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, resource_name: str, key_id: str, **kwargs: Any) ApplicationInsightsComponentAPIKey [source]
Delete an API Key of an Application Insights component.
- Parameters:
- Returns:
ApplicationInsightsComponentAPIKey or the result of cls(response)
- Return type:
- Raises:
- get(resource_group_name: str, resource_name: str, key_id: str, **kwargs: Any) ApplicationInsightsComponentAPIKey [source]
Get the API Key for this key id.
- Parameters:
- Returns:
ApplicationInsightsComponentAPIKey or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, resource_name: str, **kwargs: Any) Iterable[ApplicationInsightsComponentAPIKey] [source]
Gets a list of API keys of an Application Insights component.
- Parameters:
- Returns:
An iterator like instance of either ApplicationInsightsComponentAPIKey or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.AnalyticsItemsOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’sanalytics_items
attribute.- delete(resource_group_name: str, resource_name: str, scope_path: str | ItemScopePath, id: str | None = None, name: str | None = None, **kwargs: Any) None [source]
Deletes a specific Analytics Items defined within 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.
scope_path (str or ItemScopePath) – Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: “analyticsItems” and “myanalyticsItems”. Required.
id (str) – The Id of a specific item defined in the Application Insights component. Default value is None.
name (str) – The name of a specific item defined in the Application Insights component. Default value is None.
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- get(resource_group_name: str, resource_name: str, scope_path: str | ItemScopePath, id: str | None = None, name: str | None = None, **kwargs: Any) ApplicationInsightsComponentAnalyticsItem [source]
Gets a specific Analytics Items defined within 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.
scope_path (str or ItemScopePath) – Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: “analyticsItems” and “myanalyticsItems”. Required.
id (str) – The Id of a specific item defined in the Application Insights component. Default value is None.
name (str) – The name of a specific item defined in the Application Insights component. Default value is None.
- Returns:
ApplicationInsightsComponentAnalyticsItem or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, resource_name: str, scope_path: str | ItemScopePath, scope: str | ItemScope | None = None, type: str | ItemTypeParameter = 'none', include_content: bool | None = None, **kwargs: Any) List[ApplicationInsightsComponentAnalyticsItem] [source]
Gets a list of Analytics Items defined within 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.
scope_path (str or ItemScopePath) – Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: “analyticsItems” and “myanalyticsItems”. Required.
scope (str or ItemScope) – Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: “shared” and “user”. Default value is None.
type (str or ItemTypeParameter) – Enum indicating the type of the Analytics item. Known values are: “none”, “query”, “function”, “folder”, and “recent”. Default value is “none”.
include_content (bool) – Flag indicating whether or not to return the content of each applicable item. If false, only return the item information. Default value is None.
- Returns:
list of ApplicationInsightsComponentAnalyticsItem or the result of cls(response)
- Return type:
- Raises:
- put(resource_group_name: str, resource_name: str, scope_path: str | ItemScopePath, item_properties: ApplicationInsightsComponentAnalyticsItem | IO[bytes], override_item: bool | None = None, **kwargs: Any) ApplicationInsightsComponentAnalyticsItem [source]
Adds or Updates a specific Analytics Item within 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.
scope_path (str or ItemScopePath) – Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component. Known values are: “analyticsItems” and “myanalyticsItems”. Required.
item_properties (ApplicationInsightsComponentAnalyticsItem or IO[bytes]) – Properties that need to be specified to create a new item and add it to an Application Insights component. Is either a ApplicationInsightsComponentAnalyticsItem type or a IO[bytes] type. Required.
override_item (bool) – Flag indicating whether or not to force save an item. This allows overriding an item if it already exists. Default value is None.
- Returns:
ApplicationInsightsComponentAnalyticsItem or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.AnnotationsOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’sannotations
attribute.- create(resource_group_name: str, resource_name: str, annotation_properties: Annotation | IO[bytes], **kwargs: Any) List[Annotation] [source]
Create an Annotation of 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.
annotation_properties (Annotation or IO[bytes]) – Properties that need to be specified to create an annotation of a Application Insights component. Is either a Annotation type or a IO[bytes] type. Required.
- Returns:
list of Annotation or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, resource_name: str, annotation_id: str, **kwargs: Any) None [source]
Delete an Annotation of 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.
annotation_id (str) – The unique annotation ID. This is unique within a Application Insights component. Required.
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- get(resource_group_name: str, resource_name: str, annotation_id: str, **kwargs: Any) List[Annotation] [source]
Get the annotation for given id.
- 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.
annotation_id (str) – The unique annotation ID. This is unique within a Application Insights component. Required.
- Returns:
list of Annotation or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, resource_name: str, start: str, end: str, **kwargs: Any) Iterable[Annotation] [source]
Gets the list of annotations for a component for given time range.
- 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.
start (str) – The start time to query from for annotations, cannot be older than 90 days from current date. Required.
end (str) – The end time to query for annotations. Required.
- Returns:
An iterator like instance of either Annotation or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.ComponentAvailableFeaturesOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’scomponent_available_features
attribute.- get(resource_group_name: str, resource_name: str, **kwargs: Any) ApplicationInsightsComponentAvailableFeatures [source]
Returns all available features of the application insights component.
- Parameters:
- Returns:
ApplicationInsightsComponentAvailableFeatures or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.ComponentCurrentBillingFeaturesOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’scomponent_current_billing_features
attribute.- get(resource_group_name: str, resource_name: str, **kwargs: Any) ApplicationInsightsComponentBillingFeatures [source]
Returns current billing features for an Application Insights component.
- Parameters:
- Returns:
ApplicationInsightsComponentBillingFeatures or the result of cls(response)
- Return type:
- Raises:
- update(resource_group_name: str, resource_name: str, billing_features_properties: ApplicationInsightsComponentBillingFeatures | IO[bytes], **kwargs: Any) ApplicationInsightsComponentBillingFeatures [source]
Update current billing features for 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.
billing_features_properties (ApplicationInsightsComponentBillingFeatures or IO[bytes]) – Properties that need to be specified to update billing features for an Application Insights component. Is either a ApplicationInsightsComponentBillingFeatures type or a IO[bytes] type. Required.
- Returns:
ApplicationInsightsComponentBillingFeatures or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.ComponentFeatureCapabilitiesOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’scomponent_feature_capabilities
attribute.- get(resource_group_name: str, resource_name: str, **kwargs: Any) ApplicationInsightsComponentFeatureCapabilities [source]
Returns feature capabilities of the application insights component.
- Parameters:
- Returns:
ApplicationInsightsComponentFeatureCapabilities or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.ComponentQuotaStatusOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’scomponent_quota_status
attribute.- get(resource_group_name: str, resource_name: str, **kwargs: Any) ApplicationInsightsComponentQuotaStatus [source]
Returns daily data volume cap (quota) status for an Application Insights component.
- Parameters:
- Returns:
ApplicationInsightsComponentQuotaStatus or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.ComponentsOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’scomponents
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:
- Raises:
- delete(resource_group_name: str, resource_name: str, **kwargs: Any) None [source]
Deletes an Application Insights component.
- Parameters:
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- get(resource_group_name: str, resource_name: str, **kwargs: Any) ApplicationInsightsComponent [source]
Returns an Application Insights component.
- Parameters:
- Returns:
ApplicationInsightsComponent or the result of cls(response)
- Return type:
- Raises:
- 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:
- Raises:
- 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:
- Raises:
- 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:
- Raises:
- 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:
- Raises:
- 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:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.ExportConfigurationsOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’sexport_configurations
attribute.- create(resource_group_name: str, resource_name: str, export_properties: ApplicationInsightsComponentExportRequest | IO[bytes], **kwargs: Any) List[ApplicationInsightsComponentExportConfiguration] [source]
Create a Continuous Export configuration of 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.
export_properties (ApplicationInsightsComponentExportRequest or IO[bytes]) – Properties that need to be specified to create a Continuous Export configuration of a Application Insights component. Is either a ApplicationInsightsComponentExportRequest type or a IO[bytes] type. Required.
- Returns:
list of ApplicationInsightsComponentExportConfiguration or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, resource_name: str, export_id: str, **kwargs: Any) ApplicationInsightsComponentExportConfiguration [source]
Delete a Continuous Export configuration of 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.
export_id (str) – The Continuous Export configuration ID. This is unique within a Application Insights component. Required.
- Returns:
ApplicationInsightsComponentExportConfiguration or the result of cls(response)
- Return type:
- Raises:
- get(resource_group_name: str, resource_name: str, export_id: str, **kwargs: Any) ApplicationInsightsComponentExportConfiguration [source]
Get the Continuous Export configuration for this export id.
- 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.
export_id (str) – The Continuous Export configuration ID. This is unique within a Application Insights component. Required.
- Returns:
ApplicationInsightsComponentExportConfiguration or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, resource_name: str, **kwargs: Any) List[ApplicationInsightsComponentExportConfiguration] [source]
Gets a list of Continuous Export configuration of an Application Insights component.
- Parameters:
- Returns:
list of ApplicationInsightsComponentExportConfiguration or the result of cls(response)
- Return type:
- Raises:
- update(resource_group_name: str, resource_name: str, export_id: str, export_properties: ApplicationInsightsComponentExportRequest | IO[bytes], **kwargs: Any) ApplicationInsightsComponentExportConfiguration [source]
Update the Continuous Export configuration for this export id.
- 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.
export_id (str) – The Continuous Export configuration ID. This is unique within a Application Insights component. Required.
export_properties (ApplicationInsightsComponentExportRequest or IO[bytes]) – Properties that need to be specified to update the Continuous Export configuration. Is either a ApplicationInsightsComponentExportRequest type or a IO[bytes] type. Required.
- Returns:
ApplicationInsightsComponentExportConfiguration or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.FavoritesOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’sfavorites
attribute.- add(resource_group_name: str, resource_name: str, favorite_id: str, favorite_properties: ApplicationInsightsComponentFavorite | IO[bytes], **kwargs: Any) ApplicationInsightsComponentFavorite [source]
Adds a new favorites to 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.
favorite_id (str) – The Id of a specific favorite defined in the Application Insights component. Required.
favorite_properties (ApplicationInsightsComponentFavorite or IO[bytes]) – Properties that need to be specified to create a new favorite and add it to an Application Insights component. Is either a ApplicationInsightsComponentFavorite type or a IO[bytes] type. Required.
- Returns:
ApplicationInsightsComponentFavorite or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, resource_name: str, favorite_id: str, **kwargs: Any) None [source]
Remove a favorite that is associated to an Application Insights component.
- Parameters:
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- get(resource_group_name: str, resource_name: str, favorite_id: str, **kwargs: Any) ApplicationInsightsComponentFavorite [source]
Get a single favorite by its FavoriteId, defined within an Application Insights component.
- Parameters:
- Returns:
ApplicationInsightsComponentFavorite or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, resource_name: str, favorite_type: str | FavoriteType | None = None, source_type: str | FavoriteSourceType | None = None, can_fetch_content: bool | None = None, tags: List[str] | None = None, **kwargs: Any) List[ApplicationInsightsComponentFavorite] [source]
Gets a list of favorites defined within 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.
favorite_type (str or FavoriteType) – The type of favorite. Value can be either shared or user. Known values are: “shared” and “user”. Default value is None.
source_type (str or FavoriteSourceType) – Source type of favorite to return. When left out, the source type defaults to ‘other’ (not present in this enum). Known values are: “retention”, “notebook”, “sessions”, “events”, “userflows”, “funnel”, “impact”, and “segmentation”. Default value is None.
can_fetch_content (bool) – Flag indicating whether or not to return the full content for each applicable favorite. If false, only return summary content for favorites. Default value is None.
tags (list[str]) – Tags that must be present on each favorite returned. Default value is None.
- Returns:
list of ApplicationInsightsComponentFavorite or the result of cls(response)
- Return type:
- Raises:
- update(resource_group_name: str, resource_name: str, favorite_id: str, favorite_properties: ApplicationInsightsComponentFavorite | IO[bytes], **kwargs: Any) ApplicationInsightsComponentFavorite [source]
Updates a favorite that has already been added to 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.
favorite_id (str) – The Id of a specific favorite defined in the Application Insights component. Required.
favorite_properties (ApplicationInsightsComponentFavorite or IO[bytes]) – Properties that need to be specified to update the existing favorite. Is either a ApplicationInsightsComponentFavorite type or a IO[bytes] type. Required.
- Returns:
ApplicationInsightsComponentFavorite or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.MyWorkbooksOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’smy_workbooks
attribute.- create_or_update(resource_group_name: str, resource_name: str, workbook_properties: MyWorkbook | IO[bytes], **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.
- Returns:
MyWorkbook or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, resource_name: str, **kwargs: Any) None [source]
Delete a private workbook.
- Parameters:
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- get(resource_group_name: str, resource_name: str, **kwargs: Any) MyWorkbook [source]
Get a single private workbook by its resourceName.
- Parameters:
- Returns:
MyWorkbook or the result of cls(response)
- Return type:
- Raises:
- list_by_resource_group(resource_group_name: str, 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 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.
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:
- Raises:
- 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:
- Raises:
- update(resource_group_name: str, resource_name: str, workbook_properties: MyWorkbook | IO[bytes], **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.
- Returns:
MyWorkbook or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.Operations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’soperations
attribute.- list(**kwargs: Any) Iterable[Operation] [source]
Lists all of the available insights REST API operations.
- Returns:
An iterator like instance of either Operation or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.ProactiveDetectionConfigurationsOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’sproactive_detection_configurations
attribute.- get(resource_group_name: str, resource_name: str, configuration_id: str, **kwargs: Any) ApplicationInsightsComponentProactiveDetectionConfiguration [source]
Get the ProactiveDetection configuration for this configuration id.
- 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.
configuration_id (str) – The ProactiveDetection configuration ID. This is unique within a Application Insights component. Required.
- Returns:
ApplicationInsightsComponentProactiveDetectionConfiguration or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, resource_name: str, **kwargs: Any) List[ApplicationInsightsComponentProactiveDetectionConfiguration] [source]
Gets a list of ProactiveDetection configurations of an Application Insights component.
- Parameters:
- Returns:
list of ApplicationInsightsComponentProactiveDetectionConfiguration or the result of cls(response)
- Return type:
list[ApplicationInsightsComponentProactiveDetectionConfiguration]
- Raises:
- update(resource_group_name: str, resource_name: str, configuration_id: str, proactive_detection_properties: ApplicationInsightsComponentProactiveDetectionConfiguration | IO[bytes], **kwargs: Any) ApplicationInsightsComponentProactiveDetectionConfiguration [source]
Update the ProactiveDetection configuration for this configuration id.
- 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.
configuration_id (str) – The ProactiveDetection configuration ID. This is unique within a Application Insights component. Required.
proactive_detection_properties (ApplicationInsightsComponentProactiveDetectionConfiguration or IO[bytes]) – Properties that need to be specified to update the ProactiveDetection configuration. Is either a ApplicationInsightsComponentProactiveDetectionConfiguration type or a IO[bytes] type. Required.
- Returns:
ApplicationInsightsComponentProactiveDetectionConfiguration or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.WebTestLocationsOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’sweb_test_locations
attribute.- list(resource_group_name: str, resource_name: str, **kwargs: Any) Iterable[ApplicationInsightsComponentWebTestLocation] [source]
Gets a list of web test locations available to this Application Insights component.
- Parameters:
- Returns:
An iterator like instance of either ApplicationInsightsComponentWebTestLocation or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.WebTestsOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’sweb_tests
attribute.- create_or_update(resource_group_name: str, web_test_name: str, web_test_definition: WebTest | IO[bytes], **kwargs: Any) WebTest [source]
Creates or updates an Application Insights web test definition.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
web_test_name (str) – The name of the Application Insights webtest resource. Required.
web_test_definition (WebTest or IO[bytes]) – Properties that need to be specified to create or update an Application Insights web test definition. Is either a WebTest type or a IO[bytes] type. Required.
- Returns:
WebTest or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, web_test_name: str, **kwargs: Any) None [source]
Deletes an Application Insights web test.
- Parameters:
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- get(resource_group_name: str, web_test_name: str, **kwargs: Any) WebTest [source]
Get a specific Application Insights web test definition.
- Parameters:
- Returns:
WebTest or the result of cls(response)
- Return type:
- Raises:
- list(**kwargs: Any) Iterable[WebTest] [source]
Get all Application Insights web test alerts definitions within a subscription.
- Returns:
An iterator like instance of either WebTest or the result of cls(response)
- Return type:
- Raises:
- list_by_component(component_name: str, resource_group_name: str, **kwargs: Any) Iterable[WebTest] [source]
Get all Application Insights web tests defined for the specified component.
- Parameters:
- Returns:
An iterator like instance of either WebTest or the result of cls(response)
- Return type:
- Raises:
- list_by_resource_group(resource_group_name: str, **kwargs: Any) Iterable[WebTest] [source]
Get all Application Insights web tests defined within a specified 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 WebTest or the result of cls(response)
- Return type:
- Raises:
- update_tags(resource_group_name: str, web_test_name: str, web_test_tags: TagsResource | IO[bytes], **kwargs: Any) WebTest [source]
Creates or updates an Application Insights web test definition.
- Parameters:
resource_group_name (str) – The name of the resource group. The name is case insensitive. Required.
web_test_name (str) – The name of the Application Insights webtest resource. Required.
web_test_tags (TagsResource or IO[bytes]) – Updated tag information to set into the web test instance. Is either a TagsResource type or a IO[bytes] type. Required.
- Returns:
WebTest or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.WorkItemConfigurationsOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’swork_item_configurations
attribute.- create(resource_group_name: str, resource_name: str, work_item_configuration_properties: WorkItemCreateConfiguration | IO[bytes], **kwargs: Any) WorkItemConfiguration [source]
Create a work item configuration for 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.
work_item_configuration_properties (WorkItemCreateConfiguration or IO[bytes]) – Properties that need to be specified to create a work item configuration of a Application Insights component. Is either a WorkItemCreateConfiguration type or a IO[bytes] type. Required.
- Returns:
WorkItemConfiguration or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, resource_name: str, work_item_config_id: str, **kwargs: Any) None [source]
Delete a work item configuration of 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.
work_item_config_id (str) – The unique work item configuration Id. This can be either friendly name of connector as defined in connector configuration. Required.
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- get_default(resource_group_name: str, resource_name: str, **kwargs: Any) WorkItemConfiguration [source]
Gets default work item configurations that exist for the application.
- Parameters:
- Returns:
WorkItemConfiguration or the result of cls(response)
- Return type:
- Raises:
- get_item(resource_group_name: str, resource_name: str, work_item_config_id: str, **kwargs: Any) WorkItemConfiguration [source]
Gets specified work item configuration for 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.
work_item_config_id (str) – The unique work item configuration Id. This can be either friendly name of connector as defined in connector configuration. Required.
- Returns:
WorkItemConfiguration or the result of cls(response)
- Return type:
- Raises:
- list(resource_group_name: str, resource_name: str, **kwargs: Any) Iterable[WorkItemConfiguration] [source]
Gets the list work item configurations that exist for the application.
- Parameters:
- Returns:
An iterator like instance of either WorkItemConfiguration or the result of cls(response)
- Return type:
- Raises:
- update_item(resource_group_name: str, resource_name: str, work_item_config_id: str, work_item_configuration_properties: WorkItemCreateConfiguration | IO[bytes], **kwargs: Any) WorkItemConfiguration [source]
Update a work item configuration for 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.
work_item_config_id (str) – The unique work item configuration Id. This can be either friendly name of connector as defined in connector configuration. Required.
work_item_configuration_properties (WorkItemCreateConfiguration or IO[bytes]) – Properties that need to be specified to update a work item configuration for this Application Insights component. Is either a WorkItemCreateConfiguration type or a IO[bytes] type. Required.
- Returns:
WorkItemConfiguration or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>
- class azure.mgmt.applicationinsights.v2015_05_01.operations.WorkbooksOperations(*args, **kwargs)[source]
Bases:
object
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
ApplicationInsightsManagementClient
’sworkbooks
attribute.- create_or_update(resource_group_name: str, resource_name: str, workbook_properties: Workbook | IO[bytes], **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 Application Insights component 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.
- Returns:
Workbook or the result of cls(response)
- Return type:
- Raises:
- delete(resource_group_name: str, resource_name: str, **kwargs: Any) None [source]
Delete a workbook.
- Parameters:
- Returns:
None or the result of cls(response)
- Return type:
None
- Raises:
- get(resource_group_name: str, resource_name: str, **kwargs: Any) Workbook [source]
Get a single workbook by its resourceName.
- Parameters:
- Returns:
Workbook or the result of cls(response)
- Return type:
- Raises:
- list_by_resource_group(resource_group_name: str, 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 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.
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:
- Raises:
- update(resource_group_name: str, resource_name: str, workbook_properties: Workbook | IO[bytes], **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 Application Insights component 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.
- Returns:
Workbook or the result of cls(response)
- Return type:
- Raises:
- models = <module 'azure.mgmt.applicationinsights.v2015_05_01.models' from '/mnt/vss/_work/1/s/sdk/applicationinsights/azure-mgmt-applicationinsights/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/applicationinsights/v2015_05_01/models/__init__.py'>