Azure Purview Catalog Python客户端库

Azure Purview Catalog是一种全托管的云服务，用户可以查找所需的数据源并了解找到的数据源。同时，数据目录帮助组织从现有投资中获得更多价值。

• 使用技术或业务术语搜索数据
• 浏览相关技术、业务、语义和操作元数据
• 识别数据的敏感级别。

请依赖服务的文档和我们的客户端文档来使用此库

源代码 | 包（PyPI） | API参考文档 | 产品文档

免责声明

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

入门

先决条件

• 使用此包需要Python 3.6或更高版本。
• 您必须有一个Azure订阅和一个Purview才能使用此包。

创建Purview资源

按照这些说明创建您的Purview资源

安装包

使用pip安装Azure Purview Catalog客户端库

pip install azure-purview-catalog

认证客户端

要使用Azure Active Directory (AAD)令牌凭证，请提供从azure-identity库中获得的所需凭证类型的实例。

要使用AAD进行认证，您必须首先使用pip安装azure-identity并在您的Purview资源上启用AAD认证

设置后，您可以选择从azure.identity中使用哪种类型的凭证。例如，可以使用DefaultAzureCredential来认证客户端

将AAD应用程序的客户端ID、租户ID和客户端密钥的值设置为环境变量：AZURE_CLIENT_ID、AZURE_TENANT_ID、AZURE_CLIENT_SECRET

使用返回的令牌凭证来认证客户端

from azure.purview.catalog import PurviewCatalogClient
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
client = PurviewCatalogClient(endpoint="https://<my-account-name>.purview.azure.com", credential=credential)

关键概念

客户端

此包提供请求构建器，您可以构建HTTP请求，然后使用send_request方法将这些请求发送到服务。有关如何使用请求构建器和我们的客户端的更多信息，请参阅此处。

示例

以下部分将向您展示如何初始化和认证您的客户端，然后获取所有类型定义。

• 获取所有类型定义

获取所有类型定义

from azure.purview.catalog import PurviewCatalogClient
from azure.identity import DefaultAzureCredential
from azure.core.exceptions import HttpResponseError

credential = DefaultAzureCredential()
client = PurviewCatalogClient(endpoint="https://<my-account-name>.purview.azure.com", credential=credential)
try:
    response = client.types.get_all_type_definitions()
    # print out all of your entity definitions
    print(response['entityDefs'])

except HttpResponseError as e:
    print(e)

故障排除

一般

如果您的响应上调用.raise_for_status()，Purview Catalog客户端将引发在Azure Core中定义的异常。

日志记录

此库使用标准的logging库进行日志记录。HTTP会话（URL、标题等）的基本信息在INFO级别记录。

启用详细DEBUG级别日志记录，包括请求/响应体和未删除的标题，可以使用客户端的logging_enable关键字参数

import sys
import logging
from azure.identity import DefaultAzureCredential
from azure.purview.catalog import PurviewCatalogClient

# Create a logger for the 'azure' SDK
logger = logging.getLogger('azure')
logger.setLevel(logging.DEBUG)

# Configure a console output
handler = logging.StreamHandler(stream=sys.stdout)
logger.addHandler(handler)

endpoint = "https://<my-account-name>.purview.azure.com"
credential = DefaultAzureCredential()

# This client will log detailed information about its HTTP sessions, at DEBUG level
client = PurviewCatalogClient(endpoint=endpoint, credential=credential, logging_enable=True)

同样，logging_enable可以启用单个send_request调用的详细日志记录，即使它没有为客户端启用

result = client.types.get_all_type_definitions(logging_enable=True)

下一步

有关更通用的示例，请参阅我们的客户端文档。

贡献

本项目欢迎贡献和建议。大多数贡献都需要您同意贡献者许可协议（CLA），声明您有权并且确实授予我们使用您的贡献的权利。有关详细信息，请访问 cla.microsoft.com。

当您提交拉取请求时，CLA机器人将自动确定您是否需要提供CLA，并适当装饰PR（例如，标签，评论）。只需遵循机器人提供的说明。您只需在整个使用我们的CLA的存储库中进行一次。

本项目已采用 Microsoft 开源行为准则。有关更多信息，请参阅 行为准则常见问题解答 或通过 opencode@microsoft.com 联系我们，提出任何其他问题或意见。

发布历史

1.0.0b4 (2022-06-13)

功能

• 支持 Atlas 2.2 API

已修复的 Bug

• 为更新术语 API 添加缺失的查询参数 includeTermHierarchy
• 为获取术语 API 添加缺失的查询参数 excludeRelationshipTypes

1.0.0b3 (2022-03-15)

已修复的 Bug

• 修复 delete_by_guids 以消除错误 #22487 的无效请求错误

1.0.0b2 (2021-09-29)

功能

• 向客户端添加便利操作

破坏性变更

• 删除 rest 层和请求构建器（详细信息请参阅 README.md）
• 将 send_request 的 HttpRequest 参数从 http_request 更改为 request
• 端点和凭据参数的顺序已更改

1.0.0b1 (2021-05-11)

• 这是 Azure Purview 目录库的初始版本。