通过

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

Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2024-05-15

  • 项目

Bicep 资源定义

可以使用面向以下操作部署 databaseAccounts/sqlRoleDefinitions 资源类型：

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

资源格式

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

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

属性值

databaseAccounts/sqlRoleDefinitions

名称 说明 值
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。		 字符串 (必需)
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

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

SqlRoleDefinitionResource

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

权限

名称 说明 值
dataActions 允许的数据操作数组。 string[]
notDataActions 拒绝的数据操作数组。 string[]

快速入门模板

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

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

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

ARM 模板资源定义

可以使用面向以下操作部署 databaseAccounts/sqlRoleDefinitions 资源类型：

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

资源格式

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

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

属性值

databaseAccounts/sqlRoleDefinitions

名称 说明 Value
type 资源类型 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'
apiVersion 资源 API 版本 '2024-05-15'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 字符串 (必需)
properties 用于创建和更新 Azure Cosmos DB SQL 角色定义的属性。 SqlRoleDefinitionResource

SqlRoleDefinitionResource

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

权限

名称 说明 值
dataActions 允许的数据操作数组。 string[]
notDataActions 拒绝的数据操作的数组。 string[]

快速入门模板

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

模板 说明
使用数据平面 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-05-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      assignableScopes = [
        "string"
      ]
      permissions = [
        {
          dataActions = [
            "string"
          ]
          notDataActions = [
            "string"
          ]
        }
      ]
      roleName = "string"
      type = "string"
    }
  })
}

属性值

databaseAccounts/sqlRoleDefinitions

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-05-15”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源 ID。 类型为：databaseAccounts 的资源的 ID
properties 用于创建和更新 Azure Cosmos DB SQL 角色定义的属性。 SqlRoleDefinitionResource

SqlRoleDefinitionResource

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

权限

名称 说明 值
dataActions 允许的数据操作数组。 string[]
notDataActions 拒绝的数据操作的数组。 string[]