次の方法で共有


Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2022-11-15

Bicep リソース定義

databaseAccounts/sqlRoleDefinitions リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions リソースを作成するには、次の Bicep をテンプレートに追加します。

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

プロパティ値

databaseAccounts/sqlRoleDefinitions

名前 説明
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。
string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。
種類のリソースのシンボル名: databaseAccounts
properties Azure Cosmos DB SQL ロール定義を作成および更新するためのプロパティ。 SqlRoleDefinitionResource

SqlRoleDefinitionResource

名前 説明
assignableScopes このロール定義を使用して作成できるロールの割り当て以下の完全修飾スコープのセット。 これにより、データベース アカウント全体または基になるデータベース/コレクションに対してこのロール定義を適用できます。 少なくとも 1 つの要素が必要です。 データベース アカウントより大きいスコープは、割り当て可能なスコープとして強制できません。 割り当て可能なスコープで参照されるリソースは存在する必要はありません。 string[]
権限 このロール定義で許可される操作のセット。 Permission[]
roleName ロール定義のわかりやすい名前。 データベース アカウントに対して一意である必要があります。 string
type ロール定義が組み込みであるか、ユーザーが作成されたかを示します。 'BuiltInRole'
'CustomRole'

アクセス許可

名前 説明
dataActions 許可されるデータ アクションの配列。 string[]
notDataActions 拒否されるデータ アクションの配列。 string[]

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
データ プレーン RBAC を使用して Azure Cosmos DB SQL アカウントを作成する

Azure にデプロイする
このテンプレートは、AAD ID 用の SQL Cosmos アカウント、ネイティブに管理されるロールの定義、およびネイティブに管理されるロールの割り当てを作成します。

ARM テンプレート リソース定義

databaseAccounts/sqlRoleDefinitions リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions リソースを作成するには、次の JSON をテンプレートに追加します。

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

プロパティ値

databaseAccounts/sqlRoleDefinitions

名前 説明
type リソースの種類 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'
apiVersion リソース API のバージョン '2022-11-15'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
string (必須)
properties Azure Cosmos DB SQL ロール定義を作成および更新するためのプロパティ。 SqlRoleDefinitionResource

SqlRoleDefinitionResource

名前 説明
assignableScopes このロール定義を使用して作成できるロールの割り当て以下の完全修飾スコープのセット。 これにより、データベース アカウント全体または基になるデータベース/コレクションに対してこのロール定義を適用できます。 少なくとも 1 つの要素が必要です。 データベース アカウントより大きいスコープは、割り当て可能なスコープとして強制できません。 割り当て可能なスコープで参照されるリソースは存在する必要はありません。 string[]
権限 このロール定義で許可される操作のセット。 Permission[]
roleName ロール定義のわかりやすい名前。 データベース アカウントに対して一意である必要があります。 string
type ロール定義が組み込みであるか、ユーザーが作成されたかを示します。 'BuiltInRole'
'CustomRole'

アクセス許可

名前 説明
dataActions 許可されるデータ アクションの配列。 string[]
notDataActions 拒否されるデータ アクションの配列。 string[]

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
データ プレーン RBAC を使用して Azure Cosmos DB SQL アカウントを作成する

Azure にデプロイする
このテンプレートは、AAD ID 用の SQL Cosmos アカウント、ネイティブに管理されるロールの定義、およびネイティブに管理されるロールの割り当てを作成します。

Terraform (AzAPI プロバイダー) リソース定義

databaseAccounts/sqlRoleDefinitions リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2022-11-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      assignableScopes = [
        "string"
      ]
      permissions = [
        {
          dataActions = [
            "string"
          ]
          notDataActions = [
            "string"
          ]
        }
      ]
      roleName = "string"
      type = "string"
    }
  })
}

プロパティ値

databaseAccounts/sqlRoleDefinitions

名前 説明
type リソースの種類 "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2022-11-15"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: databaseAccounts
properties Azure Cosmos DB SQL ロール定義を作成および更新するためのプロパティ。 SqlRoleDefinitionResource

SqlRoleDefinitionResource

名前 説明
assignableScopes このロール定義を使用して作成できるロールの割り当て以下の完全修飾スコープのセット。 これにより、データベース アカウント全体または基になるデータベース/コレクションに対してこのロール定義を適用できます。 少なくとも 1 つの要素が必要です。 データベース アカウントより大きいスコープは、割り当て可能なスコープとして強制できません。 割り当て可能なスコープで参照されるリソースは存在する必要はありません。 string[]
権限 このロール定義で許可される操作のセット。 Permission[]
roleName ロール定義のわかりやすい名前。 データベース アカウントに対して一意である必要があります。 string
type ロール定義が組み込みであるか、ユーザーが作成されたかを示します。 "BuiltInRole"
"CustomRole"

アクセス許可

名前 説明
dataActions 許可されるデータ アクションの配列。 string[]
notDataActions 拒否されるデータ アクションの配列。 string[]