Microsoft Azure SDK for Python

这是Microsoft Azure Bot服务客户端库。此包已与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-botservice
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.botservice import AzureBotService
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = AzureBotService(credential=DefaultAzureCredential(), subscription_id=sub_id)

示例

该包的代码示例可以在 docs.microsoft.com 的 Bot Service 上找到，以及 Samples Repo

故障排除

下一步

提供反馈

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

发布历史

2.0.0 (2023-01-12)

新增功能

• 添加了 EmailOperations 操作组
• 添加了 OperationResultsOperations 操作组
• 添加了 PrivateEndpointConnectionsOperations 操作组
• 添加了 PrivateLinkResourcesOperations 操作组
• 添加了 QnAMakerEndpointKeysOperations 操作组
• 模型 AlexaChannel 新增参数 etag
• 模型 AlexaChannel 新增参数 location
• 模型 AlexaChannel 新增参数 provisioning_state
• 模型 Bot 新增参数 zones
• 模型 BotChannel 新增参数 zones
• 模型 BotProperties 新增参数 all_settings
• 模型 BotProperties 新增参数 app_password_hint
• 模型 BotProperties 新增参数 cmek_encryption_status
• 模型 BotProperties 新增参数 disable_local_auth
• 模型 BotProperties 新增参数 is_developer_app_insights_api_key_set
• 模型 BotProperties 新增参数 is_streaming_supported
• 模型 BotProperties 新增参数 manifest_url
• 模型 BotProperties 新增参数 migration_token
• 模型 BotProperties 新增参数 msa_app_msi_resource_id
• 模型 BotProperties 新增参数 msa_app_tenant_id
• 模型 BotProperties 新增参数 msa_app_type
• 模型 BotProperties 新增参数 open_with_hint
• 模型 BotProperties 新增参数 parameters
• 模型 BotProperties 新增参数 private_endpoint_connections
• 模型 BotProperties 新增参数 provisioning_state
• 模型 BotProperties 新增参数 public_network_access
• 模型 BotProperties 新增参数 publishing_credentials
• 模型 BotProperties 新增参数 storage_resource_id
• 模型 BotProperties 新增参数 tenant_id
• 模型 Channel 新增参数 etag
• 模型 Channel 新增参数 location
• 模型 Channel 新增参数 provisioning_state
• 模型 CheckNameAvailabilityResponseBody 新增参数 abs_code
• 模型 ConnectionSetting 新增参数 zones
• 模型 ConnectionSettingProperties 新增参数 provisioning_state
• 模型 DirectLineChannel 新增参数 etag
• 模型 DirectLineChannel 新增参数 location
• 模型 DirectLineChannel 新增参数 provisioning_state
• 模型 DirectLineChannelProperties 新增参数 direct_line_embed_code
• 模型 DirectLineChannelProperties 新增参数 extension_key1
• 模型 DirectLineChannelProperties 新增参数 extension_key2
• 模型 DirectLineSite 新增参数 is_block_user_upload_enabled
• 模型 DirectLineSpeechChannel 新增参数 etag
• 模型 DirectLineSpeechChannel 新增参数 location
• 模型 DirectLineSpeechChannel 新增参数 provisioning_state
• 模型 DirectLineSpeechChannelProperties 新增参数 cognitive_service_region
• 模型 DirectLineSpeechChannelProperties 新增参数 cognitive_service_resource_id
• 模型 DirectLineSpeechChannelProperties 新增参数 cognitive_service_subscription_key
• 模型 EmailChannel 新增参数 etag
• 模型 EmailChannel 新增参数 location
• 模型 EmailChannel 新增参数 provisioning_state
• Model EmailChannelProperties 新增参数 auth_method
• Model EmailChannelProperties 新增参数 magic_code
• Model FacebookChannel 新增参数 etag
• Model FacebookChannel 新增参数 location
• Model FacebookChannel 新增参数 provisioning_state
• Model KikChannel 新增参数 etag
• Model KikChannel 新增参数 location
• Model KikChannel 新增参数 provisioning_state
• Model LineChannel 新增参数 etag
• Model LineChannel 新增参数 location
• Model LineChannel 新增参数 provisioning_state
• Model MsTeamsChannel 新增参数 etag
• Model MsTeamsChannel 新增参数 location
• Model MsTeamsChannel 新增参数 provisioning_state
• Model MsTeamsChannelProperties 新增参数 accepted_terms
• Model MsTeamsChannelProperties 新增参数 calling_webhook
• Model MsTeamsChannelProperties 新增参数 deployment_environment
• Model MsTeamsChannelProperties 新增参数 incoming_call_route
• Model Resource 新增参数 zones
• Model ServiceProviderParameter 新增参数 metadata
• Model SkypeChannel 新增参数 etag
• Model SkypeChannel 新增参数 location
• Model SkypeChannel 新增参数 provisioning_state
• Model SkypeChannelProperties 新增参数 incoming_call_route
• Model SlackChannel 新增参数 etag
• Model SlackChannel 新增参数 location
• Model SlackChannel 新增参数 provisioning_state
• Model SlackChannelProperties 新增参数 scopes
• Model SmsChannel 新增参数 etag
• Model SmsChannel 新增参数 location
• Model SmsChannel 新增参数 provisioning_state
• Model TelegramChannel 新增参数 etag
• Model TelegramChannel 新增参数 location
• Model TelegramChannel 新增参数 provisioning_state
• Model WebChatChannel 新增参数 etag
• Model WebChatChannel 新增参数 location
• Model WebChatChannel 新增参数 provisioning_state

重大变更

• Model BotProperties 不再包含参数 is_isolated
• Model DirectLineSpeechChannelProperties 不再包含参数 cognitive_services_subscription_id
• Model MsTeamsChannelProperties 不再包含参数 calling_web_hook
• Model WebChatSite 新增必填参数 is_webchat_preview_enabled
• Model WebChatSite 不再包含参数 enable_preview

2.0.0b4 (2022-11-30)

新增功能

• 添加了 EmailOperations 操作组
• 添加了 QnAMakerEndpointKeysOperations 操作组
• 模型 BotProperties 新增参数 tenant_id
• 模型 DirectLineChannelProperties 新增参数 extension_key1
• 模型 DirectLineChannelProperties 新增参数 extension_key2
• 模型 DirectLineSpeechChannelProperties 新增参数 cognitive_service_resource_id
• Model EmailChannelProperties 新增参数 auth_method
• Model EmailChannelProperties 新增参数 magic_code
• Model MsTeamsChannelProperties 新增参数 calling_webhook

重大变更

• Model MsTeamsChannelProperties 不再包含参数 calling_web_hook

2.0.0b3 (2022-06-27)

错误修复

• 修复 Model Site 的多重继承问题

2.0.0b2 (2022-04-15)

新功能

• Model ListChannelWithKeysResponse 新增参数 changed_time
• Model ListChannelWithKeysResponse 新增参数 entity_tag
• Model ListChannelWithKeysResponse 新增参数 provisioning_state

2.0.0b1 (2022-01-10)

新功能

• 添加了 OperationResultsOperations 操作组
• 添加了 PrivateEndpointConnectionsOperations 操作组
• 添加了 PrivateLinkResourcesOperations 操作组
• 模型 AlexaChannel 新增参数 etag
• 模型 AlexaChannel 新增参数 location
• 模型 AlexaChannel 新增参数 provisioning_state
• 模型 Bot 新增参数 zones
• 模型 BotChannel 新增参数 zones
• 模型 BotProperties 新增参数 all_settings
• 模型 BotProperties 新增参数 app_password_hint
• 模型 BotProperties 新增参数 cmek_encryption_status
• 模型 BotProperties 新增参数 disable_local_auth
• 模型 BotProperties 新增参数 is_developer_app_insights_api_key_set
• 模型 BotProperties 新增参数 is_streaming_supported
• 模型 BotProperties 新增参数 manifest_url
• 模型 BotProperties 新增参数 migration_token
• 模型 BotProperties 新增参数 msa_app_msi_resource_id
• 模型 BotProperties 新增参数 msa_app_tenant_id
• 模型 BotProperties 新增参数 msa_app_type
• 模型 BotProperties 新增参数 open_with_hint
• 模型 BotProperties 新增参数 parameters
• 模型 BotProperties 新增参数 private_endpoint_connections
• 模型 BotProperties 新增参数 provisioning_state
• 模型 BotProperties 新增参数 public_network_access
• 模型 BotProperties 新增参数 publishing_credentials
• 模型 BotProperties 新增参数 storage_resource_id
• 模型 Channel 新增参数 etag
• 模型 Channel 新增参数 location
• 模型 Channel 新增参数 provisioning_state
• 模型 ConnectionSetting 新增参数 zones
• Model ConnectionSettingProperties 新增参数 id
• Model ConnectionSettingProperties 新增参数 name
• 模型 ConnectionSettingProperties 新增参数 provisioning_state
• 模型 DirectLineChannel 新增参数 etag
• 模型 DirectLineChannel 新增参数 location
• 模型 DirectLineChannel 新增参数 provisioning_state
• 模型 DirectLineChannelProperties 新增参数 direct_line_embed_code
• 模型 DirectLineSite 新增参数 is_block_user_upload_enabled
• 模型 DirectLineSpeechChannel 新增参数 etag
• 模型 DirectLineSpeechChannel 新增参数 location
• 模型 DirectLineSpeechChannel 新增参数 provisioning_state
• 模型 EmailChannel 新增参数 etag
• 模型 EmailChannel 新增参数 location
• 模型 EmailChannel 新增参数 provisioning_state
• Model FacebookChannel 新增参数 etag
• Model FacebookChannel 新增参数 location
• Model FacebookChannel 新增参数 provisioning_state
• Model KikChannel 新增参数 etag
• Model KikChannel 新增参数 location
• Model KikChannel 新增参数 provisioning_state
• Model LineChannel 新增参数 etag
• Model LineChannel 新增参数 location
• Model LineChannel 新增参数 provisioning_state
• Model MsTeamsChannel 新增参数 etag
• Model MsTeamsChannel 新增参数 location
• Model MsTeamsChannel 新增参数 provisioning_state
• Model MsTeamsChannelProperties 新增参数 accepted_terms
• Model MsTeamsChannelProperties 新增参数 deployment_environment
• Model MsTeamsChannelProperties 新增参数 incoming_call_route
• Model Resource 新增参数 zones
• Model ServiceProviderParameter 新增参数 metadata
• Model SkypeChannel 新增参数 etag
• Model SkypeChannel 新增参数 location
• Model SkypeChannel 新增参数 provisioning_state
• Model SkypeChannelProperties 新增参数 incoming_call_route
• Model SlackChannel 新增参数 etag
• Model SlackChannel 新增参数 location
• Model SlackChannel 新增参数 provisioning_state
• Model SlackChannelProperties 新增参数 scopes
• Model SmsChannel 新增参数 etag
• Model SmsChannel 新增参数 location
• Model SmsChannel 新增参数 provisioning_state
• Model TelegramChannel 新增参数 etag
• Model TelegramChannel 新增参数 location
• Model TelegramChannel 新增参数 provisioning_state
• Model WebChatChannel 新增参数 etag
• Model WebChatChannel 新增参数 location
• Model WebChatChannel 新增参数 provisioning_state

重大变更

• Model BotProperties 不再包含参数 is_isolated
• Model DirectLineSpeechChannelProperties 新增必填参数 cognitive_service_region
• Model DirectLineSpeechChannelProperties 新增必填参数 cognitive_service_subscription_key
• Model DirectLineSpeechChannelProperties 不再包含参数 cognitive_services_subscription_id
• Model WebChatSite 新增必填参数 is_webchat_preview_enabled
• Model WebChatSite 不再包含参数 enable_preview

1.0.0 (2021-05-20)

新功能

• Model BotProperties 新增参数 schema_transformation_version
• Model BotProperties 新增参数 cmek_key_vault_url
• Model BotProperties 新增参数 is_isolated
• Model BotProperties 新增参数 is_cmek_enabled
• 添加操作组 HostSettingsOperations

1.0.0b1 (2020-11-20)

这是预览版本。

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

通用重大变更

• 凭据系统已全面改版

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

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

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

• 以前返回 msrest.polling.LROPoller 的操作现在返回 azure.core.polling.LROPoller，并以前缀 begin_ 开头。

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

• 大多数操作关键字参数已更改。其中一些最明显的

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

通用新功能

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

0.2.0 (2019-05-21)

新功能

• 模型 DirectLineSite 有一个新参数 is_secure_site_enabled
• 模型 DirectLineSite 有一个新参数 trusted_origins
• 添加了操作组 EnterpriseChannelsOperations

0.1.0 (2018-08-07)

• 初始发布