Share via

Microsoft.DocumentDB 資料庫Accounts/sqlRoleDefinitions 2021-10-15

  • 發行項

Bicep 資源定義

databaseAccounts/sqlRoleDefinitions 資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-10-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": "2021-10-15",
  "name": "string",
  "properties": {
    "assignableScopes": [ "string" ],
    "permissions": [
      {
        "dataActions": [ "string" ],
        "notDataActions": [ "string" ]
      }
    ],
    "roleName": "string",
    "type": "string"
  }
}

屬性值

databaseAccounts/sqlRoleDefinitions

名稱 描述 值
類型 資源類型 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'
apiVersion 資源 API 版本 '2021-10-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@2021-10-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      assignableScopes = [
        "string"
      ]
      permissions = [
        {
          dataActions = [
            "string"
          ]
          notDataActions = [
            "string"
          ]
        }
      ]
      roleName = "string"
      type = "string"
    }
  })
}

屬性值

databaseAccounts/sqlRoleDefinitions

名稱 描述 值
類型 資源類型 “Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-10-15”
NAME 資源名稱 字串 (必要)
parent_id 此資源之父系的資源標識碼。 類型資源的標識碼： databaseAccounts
properties 用來建立和更新 Azure Cosmos DB SQL 角色定義的屬性。 SqlRoleDefinitionResource

SqlRoleDefinitionResource

名稱 描述 值
assignableScopes 一組完整的範圍，可使用這個角色定義來建立角色指派。 這可讓整個資料庫帳戶或任何基礎資料庫/集合上套用此角色定義。 必須至少有一個專案。 高於資料庫帳戶的範圍無法強制執行為可指派的範圍。 請注意，可指派範圍中所參考的資源不存在。 string[]
權限 此角色定義所允許的作業集。 Permission[]
roleName 角色定義的用戶易記名稱。 資料庫帳戶必須是唯一的。 字串
type “BuiltInRole”
“CustomRole”：指出角色定義是內建還是使用者建立。

權限

名稱 描述 值
dataActions 允許的數據動作陣列。 string[]
notDataActions 拒絕的數據動作陣列。 string[]