Microsoft Azure SDK for Python

这是Microsoft Azure Application Insights Management客户端库。此包已在Python 3.7+上进行了测试。要查看Azure库的更完整视图，请参阅azure sdk python发布。

免责声明

Azure SDK Python包对Python 2.7的支持已于2022年1月1日结束。有关更多信息和建议，请参阅https://github.com/Azure/azure-sdk-for-python/issues/20691

入门

先决条件

• 使用此包需要Python 3.7+。
• Azure订阅

安装包

pip install azure-mgmt-applicationinsights
pip install azure-identity

身份验证

默认情况下，Azure Active Directory令牌身份验证依赖于以下环境变量的正确配置。

• AZURE_CLIENT_ID 用于 Azure 客户端 ID。
• AZURE_TENANT_ID 用于 Azure 租户 ID。
• AZURE_CLIENT_SECRET 用于 Azure 客户端密钥。

此外，可以通过环境变量 AZURE_SUBSCRIPTION_ID 配置 Azure 订阅 ID。

以上配置后，客户端可以通过以下代码进行认证

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)

示例

本包的代码示例可在

• docs.microsoft.com 上搜索应用洞察管理
• Azure Python 管理SDK 示例存储库

故障排除

下一步

提供反馈

如果您遇到任何错误或有任何建议，请在项目的 问题 部分提交问题。

发行历史

4.0.0 (2023-04-20)

新增功能

• 模型 WebTestPropertiesValidationRules 有一个新参数 ignore_http_status_code
• 模型 WorkbookErrorDefinition 有一个新参数 innererror

重大更改

• 模型 WebTestPropertiesValidationRules 不再具有参数 ignore_https_status_code
• 模型 WorkbookErrorDefinition 不再具有参数 inner_error

4.0.0b1 (2023-02-14)

新增功能

• 模型 WorkbookErrorDefinition 有一个新参数 innererror

重大更改

• 模型 WorkbookErrorDefinition 不再具有参数 inner_error

3.1.0 (2022-06-02)

功能

• 添加了模型 ErrorResponseComponents
• 添加了模型 ErrorResponseComponentsError
• 添加了模型 WorkbookSharedTypeKind
• 添加了模型 WorkbookUpdateSharedTypeKind

3.0.0 (2022-03-23)

重大更改

• 操作 WorkbooksOperations.get 具有新的签名

2.1.0 (2022-01-25)

功能

• 模型 OperationLive 有一个新参数 is_data_action

2.0.0 (2021-12-12)

功能

• 模型 MyWorkbook 有一个新参数 etag
• 模型 MyWorkbook 有一个新参数 storage_uri
• 模型 MyWorkbook 有一个新参数 identity
• 模型 MyWorkbook 有一个新参数 system_data
• 模型 ErrorResponse 有一个新参数 error
• 模型 WorkbookResource 有一个新参数 etag
• 模型 WorkbookResource 有一个新参数 identity
• 模型 WorkbookResource 有一个新参数 kind
• 模型 ApplicationInsightsComponent 有一个新参数 disable_local_auth
• 模型 ApplicationInsightsComponent 有一个新参数 force_customer_storage_for_profiler
• 模型 MyWorkbookResource 有一个新参数 etag
• 模型 MyWorkbookResource 有一个新参数 identity
• 模型 WorkbookUpdateParameters 有一个新参数 description
• 模型 WorkbookUpdateParameters 有一个新参数 revision
• 模型 Workbook 有一个新参数 storage_uri
• 模型 Workbook 有一个新参数 identity
• 模型 Workbook 有一个新参数 revision
• 模型 Workbook 有一个新参数 system_data
• 模型 Workbook 有一个新参数 etag
• 模型 Workbook 有一个新参数 description
• 模型 WebTest 有一个新参数 validation_rules
• 模型 WebTest 有一个新参数 request
• 模型 WorkbookError 有一个新参数 error
• 模型 WorkbooksListResult 有一个新参数 next_link
• 模型 MyWorkbookError 有一个新参数 error
• 模型 MyWorkbooksListResult 有一个新参数 next_link
• 添加了操作 WorkbooksOperations.revision_get
• 添加了操作 WorkbooksOperations.list_by_subscription
• 添加了操作 WorkbooksOperations.revisions_list

重大更改

• 模型 WorkbookResource 的参数位置现在为必需
• 操作 WorkbooksOperations.list_by_resource_group 具有新的签名
• 操作 WorkbooksOperations.create_or_update 具有新的签名
• 操作 MyWorkbooksOperations.create_or_update 具有新的签名
• 操作 MyWorkbooksOperations.list_by_resource_group 具有新的签名
• 操作 MyWorkbooksOperations.update 具有新的签名
• 操作 WorkbooksOperations.create_or_update 具有新的签名
• 操作 WorkbooksOperations.list_by_resource_group 具有新的签名
• 模型 ErrorResponse 不再具有参数 message
• 模型 ErrorResponse 不再具有参数 code
• 模型 WorkbookError 不再具有参数 message
• 模型 WorkbookError 不再具有参数 details
• 模型 WorkbookError 不再具有参数 code
• 模型 MyWorkbookError 不再具有参数 message
• 模型 MyWorkbookError 不再具有参数 details
• 模型 MyWorkbookError 不再具有参数 code

1.0.0 (2021-02-04)

功能

• 模型 ApplicationInsightsComponent 有一个新参数 etag
• 模型 ApplicationInsightsComponent 有一个新参数 name_properties_name

重大更改

• 模型 OperationDisplay 不再具有参数 description
• 模型 Operation 不再具有参数 is_data_action
• 模型操作不再具有参数来源
• 模型ErrorDetail具有新的签名
• 已移除操作组QueryPacksOperations
• 已移除操作组QueriesOperations

1.0.0b1 (2020-12-08)

这是测试预览版本。

本版本使用下一代代码生成器，引入了重要的破坏性更改，但也引入了重要的新功能（如统一身份验证和异步编程）。

一般破坏性更改

• 凭证系统已被完全重写

  • azure.common.credentials 或 msrestazure.azure_active_directory 实例不再受支持，请使用 azure-identity 类： https://pypi.ac.cn/project/azure-identity/
  • credentials 参数已重命名为 credential

• 客户端上的 config 属性不再存在，配置应作为 kwarg 传递。示例：MyClient(credential, subscription_id, enable_logging=True)。有关支持的所有选项的完整集合，请参阅 azure-core 初始化文档中的参数接受

• 不能再导入 version 模块，请使用 __version__ 代替

• 之前返回 msrest.polling.LROPoller 的操作现在返回 azure.core.polling.LROPoller，并带有 begin_ 前缀。

• 异常树已被简化，大多数异常现在为 azure.core.exceptions.HttpResponseError（《CloudError》已被删除）。

• 大多数操作 kwarg 已更改。其中一些最显著的是

  • raw 已删除。等效功能可以通过使用 cls，一个将提供对内部 HTTP 响应的访问的回调来找到，这对于高级用户很有用
  • 有关支持的所有选项的完整集合，请参阅 azure-core 请求文档中的参数接受

一般新功能

• 支持使用 typing 的类型注解。SDKs 已准备好 mypy。
• 该客户端现在提供稳定和官方的异步支持。检查您包的 aio 命名空间以找到异步客户端。
• 该客户端现在原生支持 OpenCensus 或 OpenTelemetry 等跟踪库。请参阅此 跟踪快速入门 以获取概述。

0.3.1 (2020-04-20)

** 修复 **

• 删除了未引用的客户端定义。

0.3.0 (2020-04-08)

功能

• 模型ApplicationInsightsComponentProactiveDetectionConfiguration具有新的参数类型
• 模型ApplicationInsightsComponentProactiveDetectionConfiguration具有新的参数位置
• 模型ApplicationInsightsComponentProactiveDetectionConfiguration具有新的参数id
• 模型ApplicationInsightsComponentProactiveDetectionConfiguration具有新的参数name1
• 模型ApplicationInsightsComponent具有新的参数connection_string
• 模型ApplicationInsightsComponent具有新的参数immediate_purge_data_on30_days
• 模型ApplicationInsightsComponent具有新的参数retention_in_days
• 模型ApplicationInsightsComponent具有新的参数disable_ip_masking
• 模型ApplicationInsightsComponent具有新的参数public_network_access_for_query
• 模型ApplicationInsightsComponent具有新的参数private_link_scoped_resources
• 模型ApplicationInsightsComponent具有新的参数public_network_access_for_ingestion
• 添加了操作组ComponentCurrentPricingPlanOperations
• 添加了操作组ComponentLinkedStorageAccountsOperations
• 添加了操作组EASubscriptionListMigrationDateOperations
• 添加了操作组EASubscriptionMigrateToNewPricingModelOperations
• 添加了操作组EASubscriptionRollbackToLegacyPricingModelOperations
• 添加了操作组QueryPacksOperations
• 添加了操作组WorkbookTemplatesOperations
• 添加了操作组QueriesOperations

重大更改

• 模型Workbook的位置参数现在是必需的
• 操作 WorkbooksOperations.create_or_update 具有新的签名
• 操作 WorkbooksOperations.list_by_resource_group 具有新的签名
• 操作WorkbooksOperations.update具有新的签名
• 模型Workbook不再具有参数workbook_name
• 模型Workbook不再具有参数source_resource_id
• 模型Workbook不再具有参数shared_type_kind
• 模型工作簿不再有参数 workbook_id
• 模型工作簿有一个新的必需参数 display_name
• Model ApplicationInsightsComponent 有一个新必需参数 workspace_resource_id

一般性重大更改

本版本使用下一代代码生成器，可能会引入重大更改。概括来说，一些模块的可见性/导入不正确，并已被重命名。这修复了由于使用最初不应该使用的类而引起的一些问题。

• 无法从 azure.mgmt.applicationinsights.application_insights_management_client 导入 ApplicationInsightsManagementClient（从 azure.mgmt.applicationinsights 导入与之前一样工作）
• ApplicationInsightsManagementClientConfiguration 的导入已从 azure.mgmt.applicationinsights.application_insights_management_client 移至 azure.mgmt.applicationinsights
• 无法使用 azure.mgmt.applicationinsights.models.my_class 从 "models" 子模块导入模型 MyClass（从 azure.mgmt.applicationinsights.models 导入与之前一样工作）
• 无法使用 azure.mgmt.applicationinsights.operations.my_class_operations 从 operations 子模块导入操作类 MyClassOperations（从 azure.mgmt.applicationinsights.operations 导入与之前一样工作）

最后但同样重要的是，HTTP 连接池现在默认启用。您应始终使用客户端作为上下文管理器，或调用 close()，或每个进程使用不超过一个客户端。

0.2.0 (2019-04-10)

功能

• 添加了操作 WebTestsOperations.list_by_component
• 添加了操作 ComponentsOperations.get_purge_status
• 添加了操作 ComponentsOperations.purge
• 添加了操作组 FavoritesOperations
• 添加了操作组 ComponentFeatureCapabilitiesOperations
• 添加了操作组 WebTestLocationsOperations
• 添加了操作组 ComponentAvailableFeaturesOperations
• 添加了操作组 ProactiveDetectionConfigurationsOperations
• 添加了操作组 AnnotationsOperations
• 添加了操作组 WorkItemConfigurationsOperations
• 添加了操作组 WorkbooksOperations
• 添加了操作组 AnalyticsItemsOperations

一般性重大更改

本版本使用下一代代码生成器，可能会引入重大更改。

• 模型签名现在仅使用关键字参数语法。所有位置参数必须重写为关键字参数。为了在大多数情况下保持自动完成，现在为 Python 2 和 Python 3 生成模型。Python 3 使用 "*" 语法进行关键字仅参数。
• 枚举类型现在使用 "str" 混合（类 AzureEnum(str, Enum)）以改善遇到未识别枚举值时的行为。虽然这不是重大更改，但区别很重要，并在此处记录：https://docs.pythonlang.cn/3/library/enum.html#others 初步了解
  • "is" 完全不应该使用。
  • "format" 将返回字符串值，其中 "%s" 字符串格式化将返回 NameOfEnum.stringvalue。应首选格式化语法。
• 新的长运行操作
  • 返回类型从 msrestazure.azure_operation.AzureOperationPoller 更改为 msrest.polling.LROPoller。外部 API 保持不变。
  • 返回类型现在始终是 msrest.polling.LROPoller，无论使用的是可选参数。
  • 使用 raw=True 时的行为已更改。现在不再返回初始调用结果作为 ClientRawResponse，而不进行轮询，现在这返回一个 LROPoller。轮询后，最终资源将作为 ClientRawResponse 返回。
  • 新 polling 参数。默认行为是 Polling=True，这将使用 ARM 算法进行轮询。当 Polling=False 时，将返回初始调用的响应，而不进行轮询。
  • polling 参数接受 msrest.polling.PollingMethod 子类的实例。
  • add_done_callback 在轮询完成后不再引发，而是立即执行回调。

0.1.1 (2018-02-12)

• 添加 proactive_detection_configurations

0.1.0 (2018-01-17)

• 初始发布