Microsoft Azure Search Management Client Library for Python
项目描述
Microsoft Azure SDK for Python
这是Microsoft Azure Search Management Client Library。此软件包已在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-search
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.search import SearchManagementClient
import os
sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = SearchManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)
示例
该软件包的代码示例可以在以下位置找到
故障排除
下一步
提供反馈
如果您遇到任何错误或有建议,请在项目的问题部分提交问题。
发布历史
9.1.0 (2023-10-23)
新增功能
- 添加了操作组SearchManagementClientOperationsMixin
- 添加了操作组UsagesOperations
- 模型SearchService有一个新参数semantic_search
- 模型SearchServiceUpdate有一个新参数semantic_search
9.0.0 (2023-02-15)
新增功能
- 模型PrivateEndpointConnectionProperties有一个新参数group_id
- 模型PrivateEndpointConnectionProperties有一个新参数provisioning_state
- 模型SearchService有一个新参数auth_options
- 模型SearchService有一个新参数disable_local_auth
- 模型SearchService有一个新参数encryption_with_cmk
- 模型SearchServiceUpdate有一个新参数auth_options
- 模型SearchServiceUpdate有一个新参数disable_local_auth
- 模型SearchServiceUpdate有一个新参数encryption_with_cmk
9.0.0b1 (2022-10-28)
新增功能
- 模型Resource有一个新参数identity
- 模型Resource有一个新参数location
- 模型Resource有一个新参数tags
重大更改
- 模型PrivateLinkResourceProperties不再有参数shareable_private_link_resource_types
- 模型SearchService不再有参数shared_private_link_resources
- 删除了操作组SharedPrivateLinkResourcesOperations
8.0.0 (2020-12-22)
- GA发布
8.0.0b1 (2020-10-28)
这是一个预览版本。
该版本使用新一代代码生成器,引入了重要的重大更改,但也引入了重要的新功能(如统一身份验证和异步编程)。
一般重大更改
-
凭证系统已被完全重造
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这样的跟踪库。请参阅此跟踪快速入门以了解概述。
3.0.0 (2019-09-28)
功能
- 模型SearchService有一个新的参数shared_private_link_resources
- 模型SearchService有一个新的参数public_network_access
- 模型SearchService有一个新的参数private_endpoint_connections
- 模型SearchService有一个新的参数network_rule_set
- 添加了操作组PrivateEndpointConnectionsOperations
- 添加了操作组PrivateLinkResourcesOperations
- 添加了操作组SharedPrivateLinkResourcesOperations
重大变更
- 模型SearchService的location参数现在是必需的
- 模型Resource不再有location参数
- 模型Resource不再有identity参数
- 模型Resource不再有tags参数
2.1.0 (2019-05-24)
功能
- 模型SearchService有一个新的参数identity
- 模型Resource有一个新参数identity
2.0.0 (2018-05-21)
一般重大变更
本版本使用下一代代码生成器,可能引入重大变更。
- 模型签名现在仅使用关键字参数语法。所有位置参数必须重写为关键字参数。为了在大多数情况下保持自动完成,现在为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
在轮询完成后调用将不再引发异常,而是立即执行回调。
- 返回类型从
功能
- 添加"operations"操作组
- 添加services.update
- 客户端类可以用作上下文管理器以保持底层HTTP会话打开以提高性能
错误修复
- services.create_or_update现在是正确的长运行操作
- sdist与wheel 0.31.0的兼容性
1.0.0 (2016-06-23)
此wheel软件包现在使用azure wheel扩展构建
0.1.0 (2016-08-09)
- 初始发布