次の方法で共有

Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2023-09-15

  • [アーティクル]

Bicep リソース定義

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

  • リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2023-09-15' = {
  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 このロール定義を使用してロールの割り当てを作成できる完全修飾スコープのセット。 これにより、データベース アカウント全体または基になるデータベース/コレクションに対してこのロール定義を適用できます。 少なくとも 1 つの要素が必要です。 データベース アカウントより高いスコープは、割り当て可能なスコープとして適用できません。 割り当て可能なスコープで参照されるリソースは存在する必要はありません。 string[]
権限 このロール定義で許可される操作のセット。 アクセス許可[]
roleName ロール定義のわかりやすい名前。 データベース アカウントに対して一意である必要があります。 糸
種類 ロール定義が組み込まれているか、ユーザーが作成されたかを示します。 'BuiltInRole'
'CustomRole'

クイック スタートのサンプル

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

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

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

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

  • リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

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

プロパティ値

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

名前 形容 価値
apiVersion API のバージョン '2023-09-15'
名前 リソース名 string (必須)
プロパティ Azure Cosmos DB SQL ロール定義を作成および更新するためのプロパティ。 SqlRoleDefinitionResource
種類 リソースの種類 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'

許可

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

SqlRoleDefinitionResource

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

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

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

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

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

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

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

  • リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2023-09-15"
  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@2023-09-15"

許可

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

SqlRoleDefinitionResource

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