你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.DocumentDB databaseAccounts/mongodbRoleDefinitions 2023-11-15-preview
- 最新
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023 年 3 月 15 日
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15-preview
Bicep 资源定义
可以使用面向以下操作部署 databaseAccounts/mongodbRoleDefinitions 资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2023-11-15-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
databaseName: 'string'
privileges: [
{
actions: [
'string'
]
resource: {
collection: 'string'
db: 'string'
}
}
]
roleName: 'string'
roles: [
{
db: 'string'
role: 'string'
}
]
type: 'string'
}
}
属性值
databaseAccounts/mongodbRoleDefinitions
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中设置子资源的名称和类型。 |
字符串 (必需) |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型的资源的符号名称： databaseAccounts |
| properties | 用于创建和更新 Azure Cosmos DB Mongo 角色定义的属性。 | MongoRoleDefinitionResource |
MongoRoleDefinitionResource
| 名称 | 说明 | 值 |
|---|---|---|
| databaseName | 要为其授予对此角色定义的访问权限的数据库名称。 | 字符串 |
| 特权 | 角色定义包含的一组特权。 这将允许在整个数据库帐户或任何基础数据库/集合上应用此角色定义。 高于数据库的作用域不可作为特权强制实施。 | Privilege[] |
| roleName | 角色定义的用户友好名称。 对于数据库帐户，必须是唯一的。 | 字符串 |
| 角色 | 此角色定义继承的角色集。 | 角色[] |
| 类型 | 指示角色定义是内置还是用户创建。 | “BuiltInRole” 'CustomRole' |
Privilege
| 名称 | 说明 | 值 |
|---|---|---|
| actions | 允许的操作数组。 | string[] |
| resource | Azure Cosmos DB Mongo DB 资源。 | PrivilegeResource |
PrivilegeResource
| 名称 | 说明 | 值 |
|---|---|---|
| collection | 应用角色的集合名称。 | 字符串 |
| db | 应用角色的数据库名称。 | 字符串 |
角色
| 名称 | 说明 | 值 |
|---|---|---|
| db | 应用角色的数据库名称。 | 字符串 |
| 角色 (role) | 角色名称。 | 字符串 |
ARM 模板资源定义
databaseAccounts/mongodbRoleDefinitions 资源类型可以使用以下目标操作进行部署：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions",
"apiVersion": "2023-11-15-preview",
"name": "string",
"properties": {
"databaseName": "string",
"privileges": [
{
"actions": [ "string" ],
"resource": {
"collection": "string",
"db": "string"
}
}
],
"roleName": "string",
"roles": [
{
"db": "string",
"role": "string"
}
],
"type": "string"
}
}
属性值
databaseAccounts/mongodbRoleDefinitions
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | 'Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions' |
| apiVersion | 资源 API 版本 | “2023-11-15-preview” |
| name | 资源名称 了解如何在 JSON ARM 模板中为子资源设置名称和类型。 |
字符串 (必需) |
| properties | 用于创建和更新 Azure Cosmos DB Mongo 角色定义的属性。 | MongoRoleDefinitionResource |
MongoRoleDefinitionResource
| 名称 | 说明 | 值 |
|---|---|---|
| databaseName | 要为此角色定义授予访问权限的数据库名称。 | 字符串 |
| 特权 | 角色定义包含的一组特权。 这将允许在整个数据库帐户或任何基础数据库/集合上应用此角色定义。 高于数据库的作用域不可作为特权强制实施。 | Privilege[] |
| roleName | 角色定义的用户友好名称。 对于数据库帐户，必须是唯一的。 | 字符串 |
| 角色 | 此角色定义继承的角色集。 | 角色[] |
| 类型 | 指示角色定义是内置还是用户创建。 | “BuiltInRole” “CustomRole” |
Privilege
| 名称 | 说明 | 值 |
|---|---|---|
| actions | 允许的操作数组。 | string[] |
| resource | Azure Cosmos DB Mongo DB 资源。 | PrivilegeResource |
PrivilegeResource
| 名称 | 说明 | 值 |
|---|---|---|
| collection | 应用角色的集合名称。 | 字符串 |
| db | 应用角色的数据库名称。 | 字符串 |
角色
| 名称 | 说明 | 值 |
|---|---|---|
| db | 应用角色的数据库名称。 | 字符串 |
| 角色 (role) | 角色名称。 | 字符串 |
Terraform (AzAPI 提供程序) 资源定义
databaseAccounts/mongodbRoleDefinitions 资源类型可以使用以下目标操作进行部署：
- 资源组
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2023-11-15-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
databaseName = "string"
privileges = [
{
actions = [
"string"
]
resource = {
collection = "string"
db = "string"
}
}
]
roleName = "string"
roles = [
{
db = "string"
role = "string"
}
]
type = "string"
}
})
}
属性值
databaseAccounts/mongodbRoleDefinitions
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2023-11-15-preview” |
| name | 资源名称 | 字符串 (必需) |
| parent_id | 此资源的父资源 ID。 | 类型为：databaseAccounts 的资源的 ID |
| properties | 用于创建和更新 Azure Cosmos DB Mongo 角色定义的属性。 | MongoRoleDefinitionResource |
MongoRoleDefinitionResource
| 名称 | 说明 | 值 |
|---|---|---|
| databaseName | 要为此角色定义授予访问权限的数据库名称。 | 字符串 |
| 特权 | 角色定义包含的一组特权。 这将允许在整个数据库帐户或任何基础数据库/集合上应用此角色定义。 高于数据库的作用域不可作为特权强制实施。 | Privilege[] |
| roleName | 角色定义的用户友好名称。 对于数据库帐户，必须是唯一的。 | 字符串 |
| 角色 | 此角色定义继承的角色集。 | 角色[] |
| 类型 | 指示角色定义是内置还是用户创建。 | “BuiltInRole” “CustomRole” |
Privilege
| 名称 | 说明 | 值 |
|---|---|---|
| actions | 允许的操作数组。 | string[] |
| resource | Azure Cosmos DB Mongo DB 资源。 | PrivilegeResource |
PrivilegeResource
| 名称 | 说明 | 值 |
|---|---|---|
| collection | 应用角色的集合名称。 | 字符串 |
| db | 应用角色的数据库名称。 | 字符串 |
角色
| 名称 | 说明 | 值 |
|---|---|---|
| db | 应用角色的数据库名称。 | 字符串 |
| 角色 (role) | 角色名称。 | 字符串 |