重要
仅停用 Microsoft Purview 数据治理功能
Microsoft Purview 统一目录和经典 Microsoft Purview 数据治理功能 (以前称为 Azure Purview) 即将停用。 Microsoft Purview 整体未停用。 Microsoft Purview 数据安全性和合规性功能不受此公告的影响,Microsoft 将继续对其进行投资。
Microsoft 正在 Microsoft Fabric 中整合其 数据治理 功能。 无法再创建新的 Microsoft Purview 数据治理帐户,现有数据治理功能将在 2027 年 11 月 12 日前保持维护模式。
有关停用时间表、过渡指南和建议的后续步骤,请参阅 Microsoft Purview 数据治理停用公告。
在本教程中,你将了解如何对 Microsoft Purview 数据平面 API 进行身份验证。 任何想要将数据提交到 Microsoft Purview、将 Microsoft Purview 作为自动化过程的一部分或在 Microsoft Purview 上构建自己的用户体验的人员都可以使用 API 来执行此操作。
先决条件
- 若要开始使用,必须具有现有的 Microsoft Purview 帐户。 如果没有目录,请参阅有关 创建 Microsoft Purview 帐户的快速入门。
创建服务主体 (应用程序)
若要使 API 客户端访问 Microsoft Purview 数据平面 API,客户端必须具有服务主体 (应用程序) ,以及 Purview 识别并配置为信任Microsoft标识。 当你进行 API 调用时,将使用该服务主体的标识进行授权。
使用现有服务主体 (应用程序 ID 的客户) 失败率很高。 因此,我们建议创建一个新的服务主体来调用 API。
要创建新的服务主体,请执行以下操作:
登录 Azure 门户。
在门户中,搜索并选择 Microsoft Entra ID。
从 Microsoft Entra ID 页中,从左窗格中选择应用 注册 。
选择“新注册”。
在 “注册应用程序” 页上:
- 输入应用程序的 名称 (服务主体名称) 。
- 对于“ 谁可以使用此应用程序或访问此 API?”,选择希望使用此 API 的用户帐户类型。
提示
如果希望只有当前 Microsoft Entra ID 租户中的用户才能使用 REST API,请选择“ 此组织目录中的帐户”仅 (<租户的名称> - 单租户) 。 否则,请考虑其他选项。
- 对于“ 重定向 URI (可选) ”,选择“ Web ”,然后输入值。 此值不需要是有效的终结点。
https://exampleURI.com会做。 - 选择“注册”。
在“新服务主体”页上,复制“ 显示名称 ”和 “应用程序 (客户端) ID ”的值以保存以供以后使用。
应用程序 ID 是
client_id示例代码中的值。
若要使用服务主体 (应用程序) ,需要知道可以通过以下方式找到的服务主体密码:
在 Azure 门户中,搜索并选择 Microsoft Entra ID,然后从左窗格中选择应用 注册 。
从列表中选择服务主体 (应用程序) 。
从左窗格中选择“ 证书 & 机密 ”。
选择“新建客户端密码”。
在 “添加客户端密码 ”页上,输入 “说明”,在“ 到期”下选择到期时间,然后选择 “添加”。
在 “客户端密码 ”页上,新密钥的 “值” 列中的字符串是密码。 保存此值。
使用服务主体设置身份验证
创建新的服务主体后,需要将 Purview 帐户的数据平面角色分配给上面创建的服务主体。 按照以下步骤分配正确角色,以在服务主体和 Purview 帐户之间建立信任:
在左侧菜单中选择“数据图”。
选择“集合”。
在集合菜单中选择根集合。 这将是列表中最上方的集合,并且与 Microsoft Purview 帐户具有相同的名称。
注意
还可以将服务主体权限分配给任何子集合,而不是根集合。 但是,所有 API 的范围都将局限于该集合 (和继承权限) 的子集合,尝试为另一个集合调用 API 的用户将收到错误。
选择 “角色分配 ”选项卡。
将以下角色分配给之前创建的服务主体,以访问 Microsoft Purview 中的各种数据平面。 有关详细步骤,请参阅 使用 Microsoft Purview 治理门户分配 Azure 角色。
数据策展人角色来访问目录数据平面。
数据源管理员角色来访问扫描 数据平面。
用于访问帐户数据平面和元数据策略数据平面的集合管理员角色。
策略创作者角色来访问 DevOps 策略 API
注意
只有集合管理员角色的成员才能在 Microsoft Purview 中分配数据平面角色。 有关 Microsoft Purview 角色的详细信息,请参阅 Microsoft Purview 中的访问控制。
获取令牌
可以向以下 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。