重要
以前Azure Purview) (Microsoft Purview 统一目录和经典 Microsoft Purview 数据治理功能即将停用。 Microsoft 正在 Microsoft Fabric 中整合其数据治理功能。 无法再创建新帐户,现有功能将保持维护模式直至 2027 年 11 月 12 日。 有关停用时间表、过渡指南和建议的后续步骤,请参阅 Microsoft Purview 数据治理停用公告。
在本教程中,你将了解如何在 Microsoft Purview 数据映射中创建用户能够在 Microsoft Purview 统一目录中搜索和浏览的资产。
注意
如果使用 免费版本的 Microsoft Purview,则只有 数据管理者角色组 中的用户才能访问这些资产。
如果已有服务主体和身份验证令牌,可以直接跳到 使用 REST API 创建资产的步骤。 否则,请按照本指南调用 REST API。
先决条件
- 如果没有 Azure 订阅,请在开始之前创建一个免费帐户。
- 必须具有现有的 Microsoft Purview 帐户。 如果没有,请检查你的组织是否有权访问 Microsoft Purview 的免费版本,或使用此快速入门创建 Microsoft Purview 帐户。
创建服务主体 (应用程序)
若要使 REST API 客户端访问 Microsoft Purview 以创建实体,客户端必须具有服务主体 (应用程序) ,以及 Microsoft Purview 识别并配置为信任的标识。
使用现有服务主体 (应用程序 ID 的客户) 失败率很高。 因此,我们建议创建一个新的服务主体来调用 API。
要创建新的服务主体,请执行以下操作:
登录 Azure 门户。
在门户中,搜索并选择 Microsoft Entra ID。
从 Microsoft Entra ID 页中,从左窗格中选择 “应用注册”。
选择“新注册”。
在 “注册应用程序” 页上:
- 输入应用程序的 名称 (服务主体名称) 。
- 选择 “仅使用此组织目录中的帐户” (<仅使用租户的名称> - 单租户) 。
- 对于“ 重定向 URI (可选) ”,选择“ Web ”,然后输入值。 此值不需要是有效的终结点。
https://exampleURI.com会做。 - 选择“注册”。
在“新服务主体”页上,复制“ 显示名称 ”和 “应用程序 (客户端) ID ”的值以保存以供以后使用。
应用程序 ID 是
client_id示例代码中的值。
若要使用服务主体 (应用程序) ,需要知道服务主体的密码:
- 在应用注册列表中选择服务主体 (应用程序 ) 。
- 从左窗格中选择“ 证书 & 机密 ”。
- 选择“新建客户端密码”。
- 在 “添加客户端密码 ”页上,输入 “说明”,在“ 到期”下选择到期时间,然后选择 “添加”。
- 在 “客户端密码 ”页上,新密钥的 “值” 列中的字符串是密码。 保存此值。
使用服务主体设置身份验证
创建新的服务主体后,需要分配权限,以便服务主体可以访问 Microsoft Purview 帐户。 需要分配的权限取决于是使用 经典 Microsoft Purview 体验 还是 新的 Microsoft Purview 门户。
选择所使用的体验的选项卡。
在左侧菜单中选择“数据图”。
选择“集合”。
在集合菜单中选择根集合。 这是列表中最上方的集合,与 Microsoft Purview 帐户具有相同的名称。
注意
还可以将服务主体权限分配给任何子集合,而不是根集合。 但是,所有 API 的范围都将局限于该集合 (和继承权限) 的子集合,尝试为另一个集合调用 API 的用户将收到错误。
选择 “角色分配 ”选项卡。
将数据管理者角色分配给之前创建的服务主体。 有关详细步骤,请参阅使用 Microsoft Purview 治理门户分配 Azure 角色。
分配权限后,需要收集身份验证令牌。
向以下 URL 发送 POST 请求以获取访问令牌:
https://login.microsoftonline.com/{your-tenant-id}/oauth2/token可以通过在 Azure 门户中搜索租户属性来查找租户 ID。 该 ID 在租户属性页上可用。
需要将以下参数传递到上述 URL:
- client_id:在 Microsoft Entra ID 中注册并分配给 Microsoft Purview 帐户的数据平面角色的应用程序的客户端 ID。
- client_secret:为上述应用程序创建的客户端密码。
- grant_type:这应该是“client_credentials”。
- resource: 这应该是 'https://purview.azure.net'
下面是 PowerShell 中的示例 POST 请求:
$tenantID = "12a345bc-67d1-ef89-abcd-efg12345abcde" $url = "https://login.microsoftonline.com/$tenantID/oauth2/token" $params = @{ client_id = "00001111-aaaa-2222-bbbb-3333cccc4444"; client_secret = "abcd~a1234bcd56789012abcdabcd1234abcd"; grant_type = "client_credentials"; resource = ‘https://purview.azure.net’ } Invoke-WebRequest $url -Method Post -Body $params -UseBasicParsing | ConvertFrom-Json示例响应令牌:
{ "token_type": "Bearer", "expires_in": "86399", "ext_expires_in": "86399", "expires_on": "1621038348", "not_before": "1620951648", "resource": "https://purview.azure.net", "access_token": "<<access token>>" }提示
如果收到错误消息,显示: 仅“单页应用程序”客户端类型允许跨源令牌兑换。
- 检查请求标头并确认请求 不 包含“origin”标头。
- 确认服务主体中的重定向 URI 设置为 Web 。
- 确保用于发送 POST 请求的应用程序的软件是最新的。
使用上面的访问令牌调用数据平面 API。
使用 REST API 创建资产
现在您有了令牌并可以进行身份验证,可以创建资产了。
重要
请求 URL 终结点取决于你使用的 Microsoft Purview 体验: 经典 Microsoft Purview 体验 或 新的 Microsoft Purview 门户
创建 Azure 资产
下面是可用于为 Azure 资源创建实体的示例。 此示例涵盖 Azure 存储帐户,但可以将其用于任何其他 Azure 源。
重要
若要将此示例用于 Azure 资源,请替换有效负载中的以下值:
- typeName
- 所有者
- qualifiedName
- name
- 专家 ID
- 专家信息
- 所有者 ID
- 所有者信息
- CreatedBy
- UpdatedBy
请求 URL: https://{accountName}.purview.azure.com/catalog/api/atlas/v2/entity
方法:POST
身份验证:使用上一步中的令牌作为持有者令牌。
有效负载示例:
{
"referredEntities": {},
"entity": {
"typeName": "azure_storage_account",
"attributes": {
"owner": "ExampleOwner",
"modifiedTime": 0,
"createTime": 0,
"qualifiedName": "https://exampleaccount.core.windows.net",
"name": "ExampleStorageAccount",
"description": null,
"publicAccessLevel": null
},
"contacts": {
"Expert": [
{
"id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2d2",
"info": "Example Expert Info"
}
],
"Owner": [
{
"id": " 30435ff9-9b96-44af-a5a9-e05c8b1ae2d2",
"info": "Example Owner Info"
}
]
},
"status": "ACTIVE",
"createdBy": "ExampleCreator",
"updatedBy": "ExampleUpdator",
"version": 0
}
}
创建多云资产
下面是可用于创建多云资源实体的示例。 此示例创建 Snowflake 资源,但您可以将其用于任何其他源
重要
若要将此示例用于 Azure 资源,请替换有效负载中的以下值:
- typeName
- 所有者
- qualifiedName
- name
- type
- 专家 ID
- 专家信息
- 所有者 ID
- 所有者信息
- CreatedBy
- UpdatedBy
请求 URL: https://{accountName}.purview.azure.com/catalog/api/atlas/v2/entity
方法:POST
身份验证:使用上一步中的令牌作为持有者令牌。
有效负载示例:
{
"referredEntities": {},
"entity": {
"typeName": "snowflake_table",
"attributes": {
"owner": "ExampleOwner",
"modifiedTime": 0,
"createTime": 0,
"qualifiedName": "snowflake://microsoft_partner.east-us-2.azure.snowflakecomputing.com/databases/AZUREPURVIEW_TESTDB/schemas/COMPANY/tables/PROJECT_INFO",
"name": "PROJECT_INFO",
"description": null,
"type": "TABLE"
},
"contacts": {
"Expert": [
{
"id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2d2",
"info": "Example Expert Info"
}
],
"Owner": [
{
"id": "4b27e65f-6a15-4925-a4ef-2e640445079b",
"info": "Example Owner Info"
}
]
},
"status": "ACTIVE",
"createdBy": "ExampleCreator",
"updatedBy": "ExampleUpdator",
"version": 0
}
}