通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions

  • 项目

Bicep 资源定义

可以使用目标操作部署 databaseAccounts/sqlRoleDefinitions 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    assignableScopes: [
      'string'
    ]
    permissions: [
      {
        dataActions: [
          'string'
        ]
        notDataActions: [
          'string'
        ]
      }
    ]
    roleName: 'string'
    type: 'string'
  }
}

属性值

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

名字 描述 价值
名字 资源名称 string （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：databaseAccounts
性能 用于创建和更新 Azure Cosmos DB SQL 角色定义的属性。 SqlRoleDefinitionResource

许可

名字 描述 价值
dataActions 允许的数据操作数组。 string[]
notDataActions 拒绝的数据操作数组。 string[]

SqlRoleDefinitionResource

名字 描述 价值
assignableScopes 可以使用此角色定义在此角色定义中创建角色分配的一组完全限定的范围。 这将允许对整个数据库帐户或任何基础数据库/集合应用此角色定义。 必须至少有一个元素。 高于数据库帐户的范围不能作为可分配作用域强制实施。 请注意，可分配作用域中引用的资源不存在。 string[]
权限 通过此角色定义允许的操作集。 权限[]
roleName 角色定义的用户友好名称。 数据库帐户必须是唯一的。 字符串
类型 指示角色定义是内置还是已创建用户。 “BuiltInRole”
“CustomRole”

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
使用数据平面 RBAC 创建 Azure Cosmos DB SQL 帐户 此模板将创建 SQL Cosmos 帐户、本机维护的角色定义，以及 AAD 标识的本机维护角色分配。

ARM 模板资源定义

可以使用目标操作部署 databaseAccounts/sqlRoleDefinitions 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "properties": {
    "assignableScopes": [ "string" ],
    "permissions": [
      {
        "dataActions": [ "string" ],
        "notDataActions": [ "string" ]
      }
    ],
    "roleName": "string",
    "type": "string"
  }
}

属性值

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

名字 描述 价值
apiVersion API 版本 '2024-12-01-preview'
名字 资源名称 string （必需）
性能 用于创建和更新 Azure Cosmos DB SQL 角色定义的属性。 SqlRoleDefinitionResource
类型 资源类型 “Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions”

许可

名字 描述 价值
dataActions 允许的数据操作数组。 string[]
notDataActions 拒绝的数据操作数组。 string[]

SqlRoleDefinitionResource

名字 描述 价值
assignableScopes 可以使用此角色定义在此角色定义中创建角色分配的一组完全限定的范围。 这将允许对整个数据库帐户或任何基础数据库/集合应用此角色定义。 必须至少有一个元素。 高于数据库帐户的范围不能作为可分配作用域强制实施。 请注意，可分配作用域中引用的资源不存在。 string[]
权限 通过此角色定义允许的操作集。 权限[]
roleName 角色定义的用户友好名称。 数据库帐户必须是唯一的。 字符串
类型 指示角色定义是内置还是已创建用户。 “BuiltInRole”
“CustomRole”

快速入门模板

以下快速入门模板部署此资源类型。

模板 描述
使用数据平面 RBAC 创建 Azure Cosmos DB SQL 帐户

部署到 Azure 		此模板将创建 SQL Cosmos 帐户、本机维护的角色定义，以及 AAD 标识的本机维护角色分配。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 databaseAccounts/sqlRoleDefinitions 资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-12-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      assignableScopes = [
        "string"
      ]
      permissions = [
        {
          dataActions = [
            "string"
          ]
          notDataActions = [
            "string"
          ]
        }
      ]
      roleName = "string"
      type = "string"
    }
  })
}

属性值

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

名字 描述 价值
名字 资源名称 string （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：databaseAccounts
性能 用于创建和更新 Azure Cosmos DB SQL 角色定义的属性。 SqlRoleDefinitionResource
类型 资源类型 “Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-12-01-preview”

许可

名字 描述 价值
dataActions 允许的数据操作数组。 string[]
notDataActions 拒绝的数据操作数组。 string[]

SqlRoleDefinitionResource

名字 描述 价值
assignableScopes 可以使用此角色定义在此角色定义中创建角色分配的一组完全限定的范围。 这将允许对整个数据库帐户或任何基础数据库/集合应用此角色定义。 必须至少有一个元素。 高于数据库帐户的范围不能作为可分配作用域强制实施。 请注意，可分配作用域中引用的资源不存在。 string[]
权限 通过此角色定义允许的操作集。 权限[]
roleName 角色定义的用户友好名称。 数据库帐户必须是唯一的。 字符串
类型 指示角色定义是内置还是已创建用户。 “BuiltInRole”
“CustomRole”