Поделиться через


База данных Microsoft.DocumentDBAccounts/sqlRoleDefinitions 2023-11-15-preview

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

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

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

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

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

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

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

databaseAccounts/sqlRoleDefinitions

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.
string (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: databaseAccounts
properties Свойства для создания и обновления определения роли SQL в Azure Cosmos DB. SqlRoleDefinitionResource

SqlRoleDefinitionResource

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

Разрешение

Имя Описание Значение
dataActions Массив разрешенных действий с данными. string[]
notDataActions Массив действий с данными, которые запрещены. string[]

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание учетной записи SQL Azure Cosmos DB с помощью RBAC плоскости данных

Развертывание в Azure
Этот шаблон создает учетную запись SQL Cosmos DB, встроенное определение роли и встроенное назначение роли для удостоверения Azure Active Directory.

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

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

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

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

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

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

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

databaseAccounts/sqlRoleDefinitions

Имя Описание Значение
тип Тип ресурса Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions
версия_API Версия API ресурсов '2023-11-15-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.
string (обязательно)
properties Свойства для создания и обновления определения роли SQL в Azure Cosmos DB. SqlRoleDefinitionResource

SqlRoleDefinitionResource

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

Разрешение

Имя Описание Значение
dataActions Массив разрешенных действий с данными. string[]
notDataActions Массив действий с данными, которые запрещены. string[]

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Создание учетной записи SQL Azure Cosmos DB с помощью RBAC плоскости данных

Развертывание в Azure
Этот шаблон создает учетную запись SQL Cosmos DB, встроенное определение роли и встроенное назначение роли для удостоверения Azure Active Directory.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2023-11-15-preview"
  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@2023-11-15-preview"
name имя ресурса. string (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: databaseAccounts
properties Свойства для создания и обновления определения роли SQL в Azure Cosmos DB. SqlRoleDefinitionResource

SqlRoleDefinitionResource

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

Разрешение

Имя Описание Значение
dataActions Массив разрешенных действий с данными. string[]
notDataActions Массив действий с данными, которые запрещены. string[]