Azure DocumentDB 支持具有专用读写和只读角色的辅助本机 DocumentDB 用户,从而支持对数据访问进行安全委派。 在群集预配期间创建的内置管理帐户具有完全权限,包括用户管理。 辅助用户会自动复制到群集副本,但必须在主群集上执行用户管理。
Prerequisites
- 一份 Azure 订阅。 如果没有 Azure 订阅,可以创建一个免费帐户。
现有的 Azure DocumentDB 群集
- 如果没有群集,请 创建新群集
DocumentDB 的Visual Studio扩展。 有关详细信息,请参阅安装适用于 Visual Studio Code 的 DocumentDB 扩展
允许客户端连接到群集的防火墙规则。 有关详细信息,请参阅 配置防火墙。
本地用户和角色
Azure DocumentDB 群集包括群集预配期间创建的内置管理帐户。 此帐户具有管理本机用户和角色所需的权限。
对于应用程序和委派访问权限,请创建单独的原生用户,而不是共享内置管理帐户。 原生用户通过其分配的角色获得访问权限,并复制到群集副本节点。 必须在主群集上执行用户和角色管理。
Azure DocumentDB RBAC 使用以下组件:
- 本地用户是可以向群集进行身份验证的标识。
- 角色是一组可分配给原生用户的命名权限。
- 资源标识应用访问权限的数据库或集合。
- 操作标识可对指定范围内的资源执行的操作。
- 权限将资源与一个或多个允许的操作组合在一起。
- 角色分配将角色与本地用户相关联。
以下示例演示了一个权限,其范围限定为 sales 数据库中的 orders 集合,并具有允许的特权:
{
resource: { db: "sales", collection: "orders" },
actions: ["find", "insert", "update", "delete"]
}
选择访问范围
根据用户或应用程序所需的最低访问权限选择角色和范围。
| 访问要求 | 建议的方法 | Scope |
|---|---|---|
| 跨数据库读取数据 |
分配readAnyDatabase内置角色。 |
Cluster |
| 跨数据库读取和写入数据 |
分配 readWriteAnyDatabase 内置角色。 |
Cluster |
| 执行支持的群集管理 |
分配内置clusterAdmin角色。 |
Cluster |
| 在一个数据库中执行支持的数据操作 | 创建和分配数据库范围的自定义角色。 | 数据库 |
| 对特定集合执行支持的数据操作 | 创建和分配集合范围的自定义角色。 | Collection |
原生角色
Azure DocumentDB 为具有以下角色的辅助用户支持原生基于角色的访问控制:
| Description | |
|---|---|
readWriteAnyDatabase |
完全读写权限,包括数据库管理 |
clusterAdmin |
完全读写权限,包括数据库管理 |
readAnyDatabase |
只读权限 |
使用交互式 Mongo Shell 管理用户和角色(mongosh)。 ARM REST API、基于 ARM 的Azure CLI命令、Bicep和 Terraform 不支持辅助用户角色分配。 有关 Microsoft Entra ID 次要用户,请参阅管理次要 Microsoft Entra ID 标识。
Important
对于分配角色 readWriteAnyDatabase 的用户,当前需要执行额外的步骤才能将角色特权应用到所有现有集合。 在每个适用的数据库上运行以下命令:
const targetDb = db.getSiblingDB("<database-name>");
targetDb.getCollectionInfos({ type: "collection" }).forEach(({ name }) => {
printjson(targetDb.runCommand({ validate: name, repair: true }));
});
自定义角色
自定义角色允许您定义受支持的操作,并将其与数据库或集合资源相关联。 当内置群集范围角色授予比所需更广泛的访问权限时,使用自定义角色实现最小权限访问。
数据库范围角色
当用户或应用程序在整个一个数据库中需要相同的支持的数据权限,但不需要对群集中的其他数据库具有等效的访问权限时,请使用数据库范围的自定义角色。
数据库范围的特权标识目标数据库,并使用空集合值来表示数据库级范围:
resource: { db: "<database-name>", collection: "" }
集合范围的角色
当访问必须仅限于特定集合时,或者当同一数据库中的集合之间的权限不同时,请使用集合范围的自定义角色。
集合范围的权限标识目标数据库和集合:
resource: { db: "<database-name>", collection: "<collection-name>" }
支持的自定义角色权限
自定义角色支持以下文档中记录的数据操作:
| Action | Description |
|---|---|
find |
从范围资源读取文档。 |
insert |
将文档插入到作用域资源中。 |
update |
更新范围资源中的文档。 |
delete |
从范围资源中删除文档。 |
自定义角色当前不提供索引管理、数据库生命周期操作或集合生命周期操作的单独权限。
角色继承
自定义角色可以从受支持的内置角色继承权限。 继承的权限与直接在自定义角色中定义的权限相结合。
Important
当前预览版不支持自定义角色之间的继承,也不支持从自定义角色和内置角色组合进行的继承。
角色分配和有效访问
原生用户的有效访问权限由分配给该用户的角色决定。 用户可以通过直接分配的内置角色或自定义角色接收访问权限。
查看或更改访问权限时,请考虑配置两部分:
- 查看用户的角色分配,确认是否分配了预期的角色。
- 查看每个自定义角色,确认其资源范围和允许的操作是否正确。
- 通过作为原生用户进行连接并测试允许的操作和预期的授权失败来验证访问权限。
撤销一个角色不一定删除用户对操作的有效访问权限。 用户可能继续通过另一个分配的角色接收等效的访问权限。
用户和角色生命周期
本机用户和角色具有单独的生命周期:
- 创建原生用户可确立其身份并分配其初始角色。
- 授予角色可向现有用户添加分配。
- 撤消角色会删除特定分配,同时保留用户和角色定义。
- 删除用户会删除本机用户帐户。
- 删除自定义角色会删除自定义角色定义。
删除用户与撤销角色不同。 同样,删除自定义角色与从特定用户中删除该角色分配不同。
有关命令和完整过程,请参阅 “配置基于角色的访问控制”。
预览限制
当前预览版具有以下限制:
- 不支持
updateRole。 使用grantPrivilegesToRole和revokePrivilegesFromRole更改现有自定义角色的权限。 仅在需要更改用户分配时,使用grantRolesToUser和revokeRolesFromUser。 - 自定义角色只能通过受支持的内置角色组合来继承其他角色。
- 角色分配受发布支持的角色计数限制的约束。
-
对于自定义角色,
rolesInfo不会返回inheritedRoles或inheritedPrivileges。 - 自定义角色仅支持文档中列出的数据权限。
- 自定义角色受版本支持的权限文档数量限制的约束。