Microsoft.DocumentDB databaseAccounts/mongodbRoleDefinitions

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2024-05-15' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    databaseName: 'string'
    privileges: [
      {
        actions: [
          'string'
        ]
        resource: {
          collection: 'string'
          db: 'string'
        }
      }
    ]
    roleName: 'string'
    roles: [
      {
        db: 'string'
        role: 'string'
      }
    ]
    type: 'string'
  }
}

プロパティ値

databaseAccounts/mongodbRoleDefinitions

名前 説明
name リソース名

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

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

MongoRoleDefinitionResource

名前 説明
databaseName このロール定義に対してアクセス権が付与されているデータベース名。 string
特権 ロール定義に含まれる一連の特権。 これにより、データベース アカウント全体または基になるデータベース/コレクションに対してこのロール定義を適用できます。 Database より大きいスコープは、特権として強制できません。 Privilege[]
roleName ロール定義のわかりやすい名前。 データベース アカウントに対して一意である必要があります。 string
roles このロール定義によって継承されるロールのセット。 Role[]
ロール定義が組み込みであるか、ユーザーが作成されたかを示します。 'BuiltInRole'
'CustomRole'

特権

名前 説明
actions 許可されるアクションの配列。 string[]
resource Azure Cosmos DB Mongo DB リソース。 PrivilegeResource

PrivilegeResource

名前 説明
collection ロールが適用されるコレクション名。 string
db ロールが適用されるデータベース名。 string

ロール

名前 説明
db ロールが適用されるデータベース名。 string
role ロール名。 string

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

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

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

リソース形式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions",
  "apiVersion": "2024-05-15",
  "name": "string",
  "properties": {
    "databaseName": "string",
    "privileges": [
      {
        "actions": [ "string" ],
        "resource": {
          "collection": "string",
          "db": "string"
        }
      }
    ],
    "roleName": "string",
    "roles": [
      {
        "db": "string",
        "role": "string"
      }
    ],
    "type": "string"
  }
}

プロパティ値

databaseAccounts/mongodbRoleDefinitions

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

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

MongoRoleDefinitionResource

名前 説明
databaseName このロール定義に対してアクセス権が付与されているデータベース名。 string
特権 ロール定義に含まれる一連の特権。 これにより、データベース アカウント全体または基になるデータベース/コレクションに対してこのロール定義を適用できます。 Database より大きいスコープは、特権として強制できません。 Privilege[]
roleName ロール定義のわかりやすい名前。 データベース アカウントに対して一意である必要があります。 string
roles このロール定義によって継承されるロールのセット。 Role[]
ロール定義が組み込みであるか、ユーザーが作成されたかを示します。 'BuiltInRole'
'CustomRole'

特権

名前 説明
actions 許可されるアクションの配列。 string[]
resource Azure Cosmos DB Mongo DB リソース。 PrivilegeResource

PrivilegeResource

名前 説明
collection ロールが適用されるコレクション名。 string
db ロールが適用されるデータベース名。 string

ロール

名前 説明
db ロールが適用されるデータベース名。 string
role ロール名。 string

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2024-05-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      databaseName = "string"
      privileges = [
        {
          actions = [
            "string"
          ]
          resource = {
            collection = "string"
            db = "string"
          }
        }
      ]
      roleName = "string"
      roles = [
        {
          db = "string"
          role = "string"
        }
      ]
      type = "string"
    }
  })
}

プロパティ値

databaseAccounts/mongodbRoleDefinitions

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

MongoRoleDefinitionResource

名前 説明
databaseName このロール定義に対してアクセス権が付与されているデータベース名。 string
特権 ロール定義に含まれる一連の特権。 これにより、データベース アカウント全体または基になるデータベース/コレクションに対してこのロール定義を適用できます。 Database より大きいスコープは、特権として強制できません。 Privilege[]
roleName ロール定義のわかりやすい名前。 データベース アカウントに対して一意である必要があります。 string
roles このロール定義によって継承されるロールのセット。 Role[]
ロール定義が組み込みであるか、ユーザーが作成されたかを示します。 "BuiltInRole"
"CustomRole"

特権

名前 説明
actions 許可されるアクションの配列。 string[]
resource Azure Cosmos DB Mongo DB リソース。 PrivilegeResource

PrivilegeResource

名前 説明
collection ロールが適用されるコレクション名。 string
db ロールが適用されるデータベース名。 string

ロール

名前 説明
db ロールが適用されるデータベース名。 string
role ロール名。 string