快速入门:使用 Python 创建 Microsoft Purview(以前称为 Azure Purview)帐户

重要

对于每个租户,只能创建一个 Microsoft Purview 帐户。 如果你的组织已有 Microsoft Purview 帐户,则你将无法创建新的 Microsoft Purview 帐户,除非你的组织已有多个帐户,并且仍有预先存在的配额。 有关详细信息,请参阅常见问题解答

在本快速入门中,你将使用 Python 以编程方式创建 Microsoft Purview(以前称为 Azure Purview)帐户。 可使用 Microsoft Purview 的 Python 参考,但本文将介绍使用 Python 创建帐户所需的所有步骤。

Microsoft Purview 治理门户展示了 Microsoft Purview 数据映射和 Microsoft Purview 数据目录等工具,这些工具可帮助管理和治理数据环境。 通过跨本地源、多云源和服务型软件 (SaaS) 源连接到数据,Microsoft Purview 数据映射可创建信息的最新映射。 它对敏感数据进行标识和分类,并提供端到端的沿袭。 数据使用者能够发现整个组织的数据,而数据管理员能够审核数据、保护数据和确保对你的数据的正确使用。

有关 Microsoft Purview 的经典治理功能的详细信息,请参阅治理解决方案概述页

先决条件

  • 如果没有 Azure 订阅,请在开始前创建一个试用版订阅

  • 与订阅关联的 Microsoft Entra 租户

  • 用于登录到 Azure 的用户帐户必须属于“参与者”或“所有者”角色,或者是 Azure 订阅的管理员。 要查看你在订阅中的权限,请执行以下步骤:

    1. 转到 Azure 门户
    2. 请在右上角选择用户名。
    3. 选择省略号按钮 (...),以获取更多选项。
    4. 然后选择“我的权限”。
    5. 如果可以访问多个订阅,请选择相应的订阅。

登录 Azure

使用 Azure 帐户登录到 Azure 门户

安装 Python 包

  1. 使用管理员特权打开一个终端或命令提示符。

  2. 首先,安装 Azure 管理资源的 Python 包:

    pip install azure-mgmt-resource
    
  3. 若要为 Microsoft Purview 安装 Python 包,请运行以下命令:

    pip install azure-mgmt-purview
    

    适用于 Microsoft Purview 的 Python SDK 支持 Python 2.7、3.3、3.4、3.5、3.6 和 3.7。

  4. 要为 Azure 标识身份验证安装 Python 包,请运行以下命令:

    pip install azure-identity
    

    注意

    在某些常见依赖关系上,“azure-identity”包可能与“azure-cli”冲突。 如果遇到任何身份验证问题,请删除“azure-cli”及其依赖关系,或使用未安装“azure-cli”包的初始状态计算机。

创建 Purview 客户端

  1. 创建 purview.py 文件。 添加以下语句来添加对命名空间的引用。

    from azure.identity import ClientSecretCredential 
     from azure.mgmt.resource import ResourceManagementClient
     from azure.mgmt.purview import PurviewManagementClient
     from azure.mgmt.purview.models import *
     from datetime import datetime, timedelta
     import time
    
  2. 将以下代码添加到“Main”方法,此方法可创建 PurviewManagementClient 类的实例。 使用此对象创建 Purview 帐户、删除 Purview 帐户、检查名称可用性,以及执行其他资源提供程序操作。

    def main():
    
    # Azure subscription ID
    subscription_id = '<subscription ID>'
    
     # This program creates this resource group. If it's an existing resource group, comment out the code that creates the resource group
    rg_name = '<resource group>'
    
    # The purview name. It must be globally unique.
    purview_name = '<purview account name>'
    
    # Location name, where Microsoft Purview account must be created.
    location = '<location name>'    
    
    # Specify your Active Directory client ID, client secret, and tenant ID
    credentials = ClientSecretCredential(client_id='<service principal ID>', client_secret='<service principal key>', tenant_id='<tenant ID>') 
    # resource_client = ResourceManagementClient(credentials, subscription_id)
    purview_client = PurviewManagementClient(credentials, subscription_id)
    

创建 Purview 帐户

  1. 将以下代码添加到“Main”方法,此方法可创建 purview 帐户。 如果资源组已存在,请注释掉第一个 create_or_update 语句。

     # create the resource group
     # comment out if the resource group already exits
     resource_client.resource_groups.create_or_update(rg_name, rg_params)
    
     #Create a purview
     identity = Identity(type= "SystemAssigned")
     sku = AccountSku(name= 'Standard', capacity= 4)
     purview_resource = Account(identity=identity,sku=sku,location =location )
    
     try:
         pa = (purview_client.accounts.begin_create_or_update(rg_name, purview_name, purview_resource)).result()
         print("location:", pa.location, " Microsoft Purview Account Name: ", pa.name, " Id: " , pa.id ," tags: " , pa.tags)  
     except:
         print("Error")
         print_item(pa)
    
     while (getattr(pa,'provisioning_state')) != "Succeeded" :
         pa = (purview_client.accounts.get(rg_name, purview_name))  
         print(getattr(pa,'provisioning_state'))
         if getattr(pa,'provisioning_state') == "Failed" :
             print("Error in creating Microsoft Purview account")
             break
         time.sleep(30)      
    
  2. 现在添加以下语句,以便在运行程序时调用 main 方法:

    # Start the main method
    main()
    

完整脚本

下面是完整的 Python 代码:

	
from azure.identity import ClientSecretCredential 
from azure.mgmt.resource import ResourceManagementClient
from azure.mgmt.purview import PurviewManagementClient
from azure.mgmt.purview.models import *
from datetime import datetime, timedelta
import time

def main():

    # Azure subscription ID
    subscription_id = '<subscription ID>'
	
    # This program creates this resource group. If it's an existing resource group, comment out the code that creates the resource group
    rg_name = '<resource group>'

    # The purview name. It must be globally unique.
    purview_name = '<purview account name>'

    # Location for your resource group and your Microsoft Purview account.
    location ="<location>" 

    # Specify your Active Directory client ID, client secret, and tenant ID
    credentials = ClientSecretCredential(client_id='<service principal ID>', client_secret='<service principal key>', tenant_id='<tenant ID>') 
    resource_client = ResourceManagementClient(credentials, subscription_id)
    purview_client = PurviewManagementClient(credentials, subscription_id)
	
    # create the resource group
    # comment out if the resource group already exits
    resource_client.resource_groups.create_or_update(rg_name, {"location": location})

    #Create a purview
    identity = Identity(type= "SystemAssigned")
    sku = AccountSku(name= 'Standard', capacity= 4)
    purview_resource = Account(identity=identity,sku=sku,location =location)
       
    try:
        pa = (purview_client.accounts.begin_create_or_update(rg_name, purview_name, purview_resource)).result()
        print("location:", pa.location, " Microsoft Purview Account Name: ", purview_name, " Id: " , pa.id ," tags: " , pa.tags) 
    except:
        print("Error in submitting job to create account")
        print_item(pa)
 
    while (getattr(pa,'provisioning_state')) != "Succeeded" :
        pa = (purview_client.accounts.get(rg_name, purview_name))  
        print(getattr(pa,'provisioning_state'))
        if getattr(pa,'provisioning_state') == "Failed" :
            print("Error in creating Microsoft Purview account")
            break
        time.sleep(30)    

# Start the main method
main()

运行代码

生成并启动应用程序。 控制台打印 Microsoft Purview 帐户创建的进度。 等待它完成。 下面是示例输出:

location: chinanorth3  Microsoft Purview Account Name:  purviewpython7  Id:  /subscriptions/8c2c7b23-848d-40fe-b817-690d79ad9dfd/resourceGroups/Demo_Catalog/providers/Microsoft.Purview/accounts/purviewpython7  tags:  None
Creating
Creating
Succeeded

验证输出

转到 Azure 门户的“Microsoft Purview 帐户”页,并验证使用上述代码创建的帐户。

删除 Microsoft Purview 帐户

若要删除 Purview 帐户,请向程序添加以下代码,然后运行:

pa = purview_client.accounts.begin_delete(rg_name, purview_name).result()

后续步骤

本快速入门介绍了如何创建 Microsoft Purview(以前称为 Azure Purview)帐户、删除帐户以及检查名称可用性。 你现可下载 Python SDK,并了解你可以对 Microsoft Purview 帐户执行的其他资源提供程序操作。

请按照接下来的这些文章学习如何导航 Microsoft Purview 治理门户、创建集合以及授予对 Microsoft Purview 治理门户的访问权限。