Microsoft.DocumentDB databaseAccounts/mongodbRoleDefinitions 2024-02-15-preview

• Актуальная
• 2024-05-15
• 15.05.2024 г.
• 15.02.2024 г.
• 2023-11-15
• 15.11.2023 г.
• 2023-09-15
• 15.09.2023 г.
• 2023-04-15
• 2023-03-15
• 15.03.2023 г.
• 2023-03-01-preview
• 2022-11-15
• 15.11.2022 г.
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15-preview
• 15.02.2022 г.
• 15.11.2021-preview
• 15.10.2021 г.

Определение ресурса Bicep

Тип ресурса databaseAccounts/mongodbRoleDefinitions можно развернуть с помощью следующих операций:

• Группы ресурсов — см. команды развертывания группы ресурсов.

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2024-02-15-preview' = {
  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.	строка (обязательно)
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа databaseAccounts
properties	Свойства для создания и обновления определения роли Mongo в Azure Cosmos DB.	MongoRoleDefinitionResource

MongoRoleDefinitionResource

Имя	Описание	Значение
databaseName	Имя базы данных, для которой предоставляется доступ для этого определения роли.	строка
Привилегии	Набор привилегий, содержащихся в определении роли. Это позволит применять это определение роли ко всей учетной записи базы данных или любой базовой базе данных или коллекции. Области, превышающие значение Database, не применяются в качестве привилегий.	Privilege[]
roleName	Понятное имя для определения роли. Должен быть уникальным для учетной записи базы данных.	строка
Роли	Набор ролей, наследуемых этим определением роли.	Role[]
тип	Указывает, было ли определение роли встроено или создано пользователем.	BuiltInRole CustomRole

Privilege

Имя	Описание	Значение
actions	Массив разрешенных действий.	string[]
ресурс	Ресурс Mongo DB Azure Cosmos DB.	PrivilegeResource

PrivilegeResource

Имя	Описание	Значение
коллекция	Имя коллекции, к ней применяется роль.	строка
db	Имя базы данных, к ней применяется роль.	строка

Роль

Имя	Описание	Значение
db	Имя базы данных, к ней применяется роль.	строка
роль	Имя роли.	строка

Определение ресурса шаблона ARM

Тип ресурса databaseAccounts/mongodbRoleDefinitions можно развернуть с помощью операций, предназначенных для:

• Группы ресурсов — см. команды развертывания групп ресурсов.

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions, добавьте следующий код JSON в шаблон.

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

Значения свойств

databaseAccounts/mongodbRoleDefinitions

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions
версия_API	Версия API ресурсов	'2024-02-15-preview'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	string (обязательно)
properties	Свойства для создания и обновления определения роли Mongo в Azure Cosmos DB.	MongoRoleDefinitionResource

MongoRoleDefinitionResource

Имя	Описание	Значение
databaseName	Имя базы данных, для которой предоставляется доступ для этого определения роли.	строка
Привилегии	Набор привилегий, содержащихся в определении роли. Это позволит применять это определение роли ко всей учетной записи базы данных или любой базовой базе данных или коллекции. Области, превышающие уровень Базы данных, не применяются в качестве привилегий.	Privilege[]
roleName	Понятное имя для определения роли. Должен быть уникальным для учетной записи базы данных.	строка
Роли	Набор ролей, наследуемых этим определением роли.	Role[]
тип	Указывает, было ли встроено определение роли или создано пользователем.	"BuiltInRole" CustomRole

Privilege

Имя	Описание	Значение
actions	Массив разрешенных действий.	string[]
ресурс	Ресурс Mongo DB Для Azure Cosmos DB.	PrivilegeResource

PrivilegeResource

Имя	Описание	Значение
коллекция	Имя коллекции, к роли применяется.	строка
db	Имя базы данных, к роли применяется.	строка

Роль

Имя	Описание	Значение
db	Имя базы данных, к роли применяется.	строка
роль	Имя роли.	строка

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса databaseAccounts/mongodbRoleDefinitions можно развернуть с помощью операций, предназначенных для:

• Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions, добавьте следующую terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2024-02-15-preview"
  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

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2024-02-15-preview"
name	имя ресурса.	string (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: databaseAccounts
properties	Свойства для создания и обновления определения роли Mongo в Azure Cosmos DB.	MongoRoleDefinitionResource

MongoRoleDefinitionResource

Имя	Описание	Значение
databaseName	Имя базы данных, для которой предоставляется доступ для этого определения роли.	строка
Привилегии	Набор привилегий, содержащихся в определении роли. Это позволит применять это определение роли ко всей учетной записи базы данных или любой базовой базе данных или коллекции. Области, превышающие значение Database, не применяются в качестве привилегий.	Privilege[]
roleName	Понятное имя для определения роли. Должен быть уникальным для учетной записи базы данных.	строка
Роли	Набор ролей, наследуемых этим определением роли.	Role[]
тип	Указывает, было ли определение роли встроено или создано пользователем.	"BuiltInRole" CustomRole

Privilege

Имя	Описание	Значение
actions	Массив разрешенных действий.	string[]
ресурс	Ресурс Mongo DB Azure Cosmos DB.	PrivilegeResource

PrivilegeResource

Имя	Описание	Значение
коллекция	Имя коллекции, к ней применяется роль.	строка
db	Имя базы данных, к ней применяется роль.	строка

Роль

Имя	Описание	Значение
db	Имя базы данных, к ней применяется роль.	строка
роль	Имя роли.	строка