你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

适用于 Python 的 Azure Purview 管理客户端库 - 版本 1.0.0b1

项目
04/05/2023

Azure Purview 是一种完全托管的云服务。

请严重依赖服务的文档来使用此库

免责声明

适用于 Python 2.7 的 Azure SDK Python 包支持在 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-administration

验证客户端

若要使用 Azure Active Directory (AAD) 令牌凭据，请提供从 azure 标识库获取的所需凭据类型的实例。

若要使用 AAD 进行身份验证，必须先在 Purview 资源上安装 pip azure-identity 并启用 AAD 身份验证

设置后，可以从 azure.identity 中选择要使用的凭据类型。例如，可以使用 DefaultAzureCredential 对客户端进行身份验证：

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

使用返回的令牌凭据对客户端进行身份验证：

from azure.purview.administration.account import PurviewAccountClient
from azure.purview.administration.metadatapolicies import PurviewMetadataPoliciesClient
from azure.identity import DefaultAzureCredential

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

关键概念

客户端

包包含两种类型的客户端： PurviewAccountClient 和 PurviewMetadataPoliciesClient。可以根据要求将其与一个包一起使用。

示例

以下部分演示如何初始化和验证客户端，然后列出所有密钥。

获取密钥

获取密钥

from azure.purview.administration.account import PurviewAccountClient
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
client = PurviewAccountClient(endpoint="https://<my-account-name>.purview.azure.com", credential=credential)
response = client.accounts.get_access_keys()
print(response)

以下部分演示如何初始化和验证客户端，然后列出所有角色。

List_Roles

List Roles

from azure.purview.administration.metadatapolicies import PurviewMetadataPoliciesClient
from azure.identity import DefaultAzureCredential

credential = DefaultAzureCredential()
client = PurviewMetadataPoliciesClient(endpoint="https://<my-account-name>.purview.azure.com", credential=credential)
response = client.metadata_roles.list()
result = [item for item in response]
print(result)

疑难解答

常规

如果未定义响应的状态代码，Purview 客户端将引发异常。

日志记录

此库使用标准日志记录库进行日志记录。有关 HTTP 会话 (URL、标头等) 的基本信息记录在信息级别。

在客户端上使用 logging_enable 关键字参数可启用详细的调试级别日志记录（包括请求/响应正文和未编辑的标头）：

import sys
import logging
from azure.identity import DefaultAzureCredential
from azure.purview.administration.account import PurviewAccountClient

# 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 = PurviewAccountClient(endpoint=endpoint, credential=credential, logging_enable=True)

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

result = client.accounts.get_access_keys(logging_enable=True)

后续步骤

有关更多泛型示例，请参阅客户端文档。

贡献

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

提交拉取请求时，CLA 机器人将自动确定你是否需要提供 CLA，并相应地修饰 PR（例如标签、注释）。直接按机器人提供的说明操作。只需使用 CLA 对所有存储库执行一次这样的操作。

此项目采用了 Microsoft 开放源代码行为准则。有关详细信息，请参阅行为准则常见问题解答，或如果有任何其他问题或意见，请与联系。

通过