Azure Purview Scanning Python客户端库

Azure Purview Scanning是一个完全托管的云服务，用户可以将数据扫描到自己的数据资产中（也称为您的目录）。扫描是一个过程，其中目录直接连接到用户指定的数据源。

• 将您的数据扫描到您的目录中
• 检查您的数据
• 从您的数据中提取模式

请查阅服务的文档和我们的客户端文档以使用此库

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

免责声明

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

入门

先决条件

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

创建 Purview 资源

按照以下说明创建您的 Purview 资源

安装包

使用pip安装 Python 的 Azure Purview 扫描客户端库

pip install azure-purview-scanning

验证客户端

要使用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.scanning import PurviewScanningClient
from azure.identity import DefaultAzureCredential

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

关键概念

客户端

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

示例

以下部分展示了如何初始化和验证您的客户端，然后列出您所有的数据源。

• 列出所有数据源

列出所有数据源

from azure.purview.scanning import PurviewScanningClient
from azure.identity import DefaultAzureCredential
from azure.core.exceptions import HttpResponseError

credential = DefaultAzureCredential()
client = PurviewScanningClient(endpoint="https://<my-account-name>.scan.purview.azure.com", credential=credential)
try:
    response = client.data_sources.list_all()
    result = [item for item in response]
    print(result)
except HttpResponseError as e:
    print(e)

故障排除

常规

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

日志记录

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

启用客户端的详细 DEBUG 级别日志记录，包括请求/响应正文和未编辑的头信息

import sys
import logging
from azure.identity import DefaultAzureCredential
from azure.purview.scanning import PurviewScanningClient

# 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>.scan.purview.azure.com"
credential = DefaultAzureCredential()

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

类似地，logging_enable 可以在单个 send_request 调用中启用详细日志记录，即使对于客户端未启用

result = client.data_sources.list_all(logging_enable=True)

下一步

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

贡献

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

提交拉取请求时，CLA-bot 将自动确定您是否需要提供 CLA，并相应地修饰 PR（例如，标签、注释）。只需遵循机器人提供的说明即可。您在整个使用我们的 CLA 的所有存储库中只需这样做一次。

此项目采用了Microsoft 开源行为准则。有关更多信息，请参阅行为准则常见问题解答或通过opencode@microsoft.com提出任何附加问题或评论。

版本历史

1.0.0b2 (2021-09-29)

功能

• 向客户端添加便利操作

重大更改

• 移除余层并请求构建者（详细描述见 README.md）
• 发送请求的 HttpRequest 参数已从 http_request 更改为 request
• 端点参数和凭证参数的顺序已更改

1.0.0b1（2021-05-11）

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