# Microsoft Azure SDK for Python
This is the Microsoft Azure Application Insights Management Client Library.
This package has been tested with Python 3.7+.
For a more complete view of Azure libraries, see the [azure sdk python release](https://aka.ms/azsdk/python/all).
## _Disclaimer_
_Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691_
## Getting started
### Prerequisites
- Python 3.7+ is required to use this package.
- [Azure subscription](https://azure.microsoft.com/free/)
### Install the package
```bash
pip install azure-mgmt-applicationinsights
pip install azure-identity
```
### Authentication
By default, [Azure Active Directory](https://aka.ms/awps/aad) token authentication depends on correct configure of following environment variables.
- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` for Azure client secret.
In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
With above configuration, client can be authenticated by following code:
```python
from azure.identity import DefaultAzureCredential
from azure.mgmt.applicationinsights import ApplicationInsightsManagementClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = ApplicationInsightsManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
```
## Examples
Code samples for this package can be found at:
- [Search Application Insights Management](https://docs.microsoft.com/samples/browse/?languages=python&term=Getting%20started%20-%20Managing&terms=Getting%20started%20-%20Managing) on docs.microsoft.com
- [Azure Python Mgmt SDK Samples Repo](https://aka.ms/azsdk/python/mgmt/samples)
## Troubleshooting
## Next steps
## Provide Feedback
If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project.
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fazure-mgmt-applicationinsights%2FREADME.png)
# Release History
## 4.0.0 (2023-04-20)
### Features Added
- Model WebTestPropertiesValidationRules has a new parameter ignore_http_status_code
- Model WorkbookErrorDefinition has a new parameter innererror
### Breaking Changes
- Model WebTestPropertiesValidationRules no longer has parameter ignore_https_status_code
- Model WorkbookErrorDefinition no longer has parameter inner_error
## 4.0.0b1 (2023-02-14)
### Features Added
- Model WorkbookErrorDefinition has a new parameter innererror
### Breaking Changes
- Model WorkbookErrorDefinition no longer has parameter inner_error
## 3.1.0 (2022-06-02)
**Features**
- Added model ErrorResponseComponents
- Added model ErrorResponseComponentsError
- Added model WorkbookSharedTypeKind
- Added model WorkbookUpdateSharedTypeKind
## 3.0.0 (2022-03-23)
**Breaking changes**
- Operation WorkbooksOperations.get has a new signature
## 2.1.0 (2022-01-25)
**Features**
- Model OperationLive has a new parameter is_data_action
## 2.0.0 (2021-12-12)
**Features**
- Model MyWorkbook has a new parameter etag
- Model MyWorkbook has a new parameter storage_uri
- Model MyWorkbook has a new parameter identity
- Model MyWorkbook has a new parameter system_data
- Model ErrorResponse has a new parameter error
- Model WorkbookResource has a new parameter etag
- Model WorkbookResource has a new parameter identity
- Model WorkbookResource has a new parameter kind
- Model ApplicationInsightsComponent has a new parameter disable_local_auth
- Model ApplicationInsightsComponent has a new parameter force_customer_storage_for_profiler
- Model MyWorkbookResource has a new parameter etag
- Model MyWorkbookResource has a new parameter identity
- Model WorkbookUpdateParameters has a new parameter description
- Model WorkbookUpdateParameters has a new parameter revision
- Model Workbook has a new parameter storage_uri
- Model Workbook has a new parameter identity
- Model Workbook has a new parameter revision
- Model Workbook has a new parameter system_data
- Model Workbook has a new parameter etag
- Model Workbook has a new parameter description
- Model WebTest has a new parameter validation_rules
- Model WebTest has a new parameter request
- Model WorkbookError has a new parameter error
- Model WorkbooksListResult has a new parameter next_link
- Model MyWorkbookError has a new parameter error
- Model MyWorkbooksListResult has a new parameter next_link
- Added operation WorkbooksOperations.revision_get
- Added operation WorkbooksOperations.list_by_subscription
- Added operation WorkbooksOperations.revisions_list
**Breaking changes**
- Parameter location of model WorkbookResource is now required
- Operation WorkbooksOperations.list_by_resource_group has a new signature
- Operation WorkbooksOperations.create_or_update has a new signature
- Operation MyWorkbooksOperations.create_or_update has a new signature
- Operation MyWorkbooksOperations.list_by_resource_group has a new signature
- Operation MyWorkbooksOperations.update has a new signature
- Operation WorkbooksOperations.create_or_update has a new signature
- Operation WorkbooksOperations.list_by_resource_group has a new signature
- Model ErrorResponse no longer has parameter message
- Model ErrorResponse no longer has parameter code
- Model WorkbookError no longer has parameter message
- Model WorkbookError no longer has parameter details
- Model WorkbookError no longer has parameter code
- Model MyWorkbookError no longer has parameter message
- Model MyWorkbookError no longer has parameter details
- Model MyWorkbookError no longer has parameter code
## 1.0.0 (2021-02-04)
**Features**
- Model ApplicationInsightsComponent has a new parameter etag
- Model ApplicationInsightsComponent has a new parameter name_properties_name
**Breaking changes**
- Model OperationDisplay no longer has parameter description
- Model Operation no longer has parameter is_data_action
- Model Operation no longer has parameter origin
- Model ErrorDetail has a new signature
- Removed operation group QueryPacksOperations
- Removed operation group QueriesOperations
## 1.0.0b1 (2020-12-08)
This is beta preview version.
This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).
**General breaking changes**
- Credential system has been completly revamped:
- `azure.common.credentials` or `msrestazure.azure_active_directory` instances are no longer supported, use the `azure-identity` classes instead: https://pypi.org/project/azure-identity/
- `credentials` parameter has been renamed `credential`
- The `config` attribute no longer exists on a client, configuration should be passed as kwarg. Example: `MyClient(credential, subscription_id, enable_logging=True)`. For a complete set of
supported options, see the [parameters accept in init documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
- You can't import a `version` module anymore, use `__version__` instead
- Operations that used to return a `msrest.polling.LROPoller` now returns a `azure.core.polling.LROPoller` and are prefixed with `begin_`.
- Exceptions tree have been simplified and most exceptions are now `azure.core.exceptions.HttpResponseError` (`CloudError` has been removed).
- Most of the operation kwarg have changed. Some of the most noticeable:
- `raw` has been removed. Equivalent feature can be found using `cls`, a callback that will give access to internal HTTP response for advanced user
- For a complete set of
supported options, see the [parameters accept in Request documentation of azure-core](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/CLIENT_LIBRARY_DEVELOPER.md#available-policies)
**General new features**
- Type annotations support using `typing`. SDKs are mypy ready.
- This client has now stable and official support for async. Check the `aio` namespace of your package to find the async client.
- This client now support natively tracing library like OpenCensus or OpenTelemetry. See this [tracing quickstart](https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/core/azure-core-tracing-opentelemetry) for an overview.
## 0.3.1 (2020-04-20)
** Fixes **
- Removed an unreferenced client definition.
## 0.3.0 (2020-04-08)
**Features**
- Model ApplicationInsightsComponentProactiveDetectionConfiguration has a new parameter type
- Model ApplicationInsightsComponentProactiveDetectionConfiguration has a new parameter location
- Model ApplicationInsightsComponentProactiveDetectionConfiguration has a new parameter id
- Model ApplicationInsightsComponentProactiveDetectionConfiguration has a new parameter name1
- Model ApplicationInsightsComponent has a new parameter connection_string
- Model ApplicationInsightsComponent has a new parameter immediate_purge_data_on30_days
- Model ApplicationInsightsComponent has a new parameter retention_in_days
- Model ApplicationInsightsComponent has a new parameter disable_ip_masking
- Model ApplicationInsightsComponent has a new parameter public_network_access_for_query
- Model ApplicationInsightsComponent has a new parameter private_link_scoped_resources
- Model ApplicationInsightsComponent has a new parameter public_network_access_for_ingestion
- Added operation group ComponentCurrentPricingPlanOperations
- Added operation group ComponentLinkedStorageAccountsOperations
- Added operation group EASubscriptionListMigrationDateOperations
- Added operation group EASubscriptionMigrateToNewPricingModelOperations
- Added operation group EASubscriptionRollbackToLegacyPricingModelOperations
- Added operation group QueryPacksOperations
- Added operation group WorkbookTemplatesOperations
- Added operation group QueriesOperations
**Breaking changes**
- Parameter location of model Workbook is now required
- Operation WorkbooksOperations.create_or_update has a new signature
- Operation WorkbooksOperations.list_by_resource_group has a new signature
- Operation WorkbooksOperations.update has a new signature
- Model Workbook no longer has parameter workbook_name
- Model Workbook no longer has parameter source_resource_id
- Model Workbook no longer has parameter shared_type_kind
- Model Workbook no longer has parameter workbook_id
- Model Workbook has a new required parameter display_name
- Model ApplicationInsightsComponent has a new required parameter workspace_resource_id
**General Breaking Changes**
This version uses a next-generation code generator that *might*
introduce breaking changes. In summary, some modules were incorrectly
visible/importable and have been renamed. This fixed several issues
caused by usage of classes that were not supposed to be used in the
first place.
- ApplicationInsightsManagementClient cannot be imported from
`azure.mgmt.applicationinsights.application_insights_management_client` anymore (import from
`azure.mgmt.applicationinsights` works like before)
- ApplicationInsightsManagementClientConfiguration import has been moved from
`azure.mgmt.applicationinsights.application_insights_management_client`
to `azure.mgmt.applicationinsights`
- A model `MyClass` from a "models" sub-module cannot be imported
anymore using `azure.mgmt.applicationinsights.models.my_class` (import from
`azure.mgmt.applicationinsights.models` works like before)
- An operation class `MyClassOperations` from an `operations`
sub-module cannot be imported anymore using
`azure.mgmt.applicationinsights.operations.my_class_operations` (import from
`azure.mgmt.applicationinsights.operations` works like before)
Last but not least, HTTP connection pooling is now enabled by default.
You should always use a client as a context manager, or call close(), or
use no more than one client per process.
## 0.2.0 (2019-04-10)
**Features**
- Added operation WebTestsOperations.list_by_component
- Added operation ComponentsOperations.get_purge_status
- Added operation ComponentsOperations.purge
- Added operation group FavoritesOperations
- Added operation group ComponentFeatureCapabilitiesOperations
- Added operation group WebTestLocationsOperations
- Added operation group ComponentAvailableFeaturesOperations
- Added operation group ProactiveDetectionConfigurationsOperations
- Added operation group AnnotationsOperations
- Added operation group WorkItemConfigurationsOperations
- Added operation group WorkbooksOperations
- Added operation group AnalyticsItemsOperations
**General Breaking changes**
This version uses a next-generation code generator that *might*
introduce breaking changes.
- Model signatures now use only keyword-argument syntax. All
positional arguments must be re-written as keyword-arguments. To
keep auto-completion in most cases, models are now generated for
Python 2 and Python 3. Python 3 uses the "*" syntax for
keyword-only arguments.
- Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
improve the behavior when unrecognized enum values are encountered.
While this is not a breaking change, the distinctions are important,
and are documented here:
<https://docs.python.org/3/library/enum.html#others> At a glance:
- "is" should not be used at all.
- "format" will return the string value, where "%s" string
formatting will return `NameOfEnum.stringvalue`. Format syntax
should be prefered.
- New Long Running Operation:
- Return type changes from
`msrestazure.azure_operation.AzureOperationPoller` to
`msrest.polling.LROPoller`. External API is the same.
- Return type is now **always** a `msrest.polling.LROPoller`,
regardless of the optional parameters used.
- The behavior has changed when using `raw=True`. Instead of
returning the initial call result as `ClientRawResponse`,
without polling, now this returns an LROPoller. After polling,
the final resource will be returned as a `ClientRawResponse`.
- New `polling` parameter. The default behavior is
`Polling=True` which will poll using ARM algorithm. When
`Polling=False`, the response of the initial call will be
returned without polling.
- `polling` parameter accepts instances of subclasses of
`msrest.polling.PollingMethod`.
- `add_done_callback` will no longer raise if called after
polling is finished, but will instead execute the callback right
away.
## 0.1.1 (2018-02-12)
- Add proactive_detection_configurations
## 0.1.0 (2018-01-17)
- Initial Release