通过

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

Microsoft.DocumentDB databaseAccounts/sqlRoleAssignments 2023-09-15

  • 项目

Bicep 资源定义

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

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2023-09-15' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    principalId: 'string'
    roleDefinitionId: 'string'
    scope: 'string'
  }
}

属性值

databaseAccounts/sqlRoleAssignments

名称 说明 值
name 资源名称

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

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

SqlRoleAssignmentResource

名称 说明 值
principalId 通过此角色分配向其授予访问权限的 AAD 图中关联 AAD 主体的唯一标识符。 使用与订阅关联的租户推断主体的租户 ID。 字符串
roleDefinitionId 关联角色定义的唯一标识符。 字符串
scope 通过此角色分配向其授予访问权限的数据平面资源路径。 字符串

快速入门模板

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

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

部署到 Azure		 此模板将创建一个 SQL Cosmos 帐户、一个本机维护的角色定义以及一个为 AAD 标识提供的本机维护角色分配。
使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB

部署到 Azure		 使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB。

ARM 模板资源定义

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

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

资源格式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments",
  "apiVersion": "2023-09-15",
  "name": "string",
  "properties": {
    "principalId": "string",
    "roleDefinitionId": "string",
    "scope": "string"
  }
}

属性值

databaseAccounts/sqlRoleAssignments

名称 说明 Value
type 资源类型 'Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments'
apiVersion 资源 API 版本 '2023-09-15'
name 资源名称

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

SqlRoleAssignmentResource

名称 说明 值
principalId 通过此角色分配向其授予访问权限的 AAD 图中关联 AAD 主体的唯一标识符。 使用与订阅关联的租户推断主体的租户 ID。 字符串
roleDefinitionId 关联角色定义的唯一标识符。 字符串
scope 通过此角色分配向其授予访问权限的数据平面资源路径。 字符串

快速入门模板

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

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

部署到 Azure		 此模板将创建一个 SQL Cosmos 帐户、一个本机维护的角色定义以及一个为 AAD 标识提供的本机维护角色分配。
使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB

部署到 Azure		 使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB。

Terraform (AzAPI 提供程序) 资源定义

databaseAccounts/sqlRoleAssignments 资源类型可以使用以下目标操作进行部署：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2023-09-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      principalId = "string"
      roleDefinitionId = "string"
      scope = "string"
    }
  })
}

属性值

databaseAccounts/sqlRoleAssignments

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

SqlRoleAssignmentResource

名称 说明 值
principalId 通过此角色分配向其授予访问权限的 AAD 图中关联 AAD 主体的唯一标识符。 使用与订阅关联的租户推断主体的租户 ID。 字符串
roleDefinitionId 关联角色定义的唯一标识符。 字符串
scope 通过此角色分配向其授予访问权限的数据平面资源路径。 字符串