База данных Microsoft.DocumentDBAccounts/sqlDatabases/containers 2024-05-15

• Актуальная
• 2024-05-15
• 15.05.2024
• 2024-02-15-preview
• 2023-11-15
• 15.11.2023
• 2023-09-15
• 15.09.2023
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 15.11.2022
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 15.02.2022
• 15.11.2021
• 2021-10-15
• 15.10.2021
• 2021-07-01-preview
• 2021-06-15
• 2021-05-15
• 2021-04-15
• 2021-04-01-preview
• 2021-03-15
• 2021-03-01-preview
• 2021-01-15
• 2020-09-01
• 2020-06-01-preview
• 2020-04-01
• 2020-03-01
• 2019-12-12
• 01.08.2019

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

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

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      clientEncryptionPolicy: {
        includedPaths: [
          {
            clientEncryptionKeyId: 'string'
            encryptionAlgorithm: 'string'
            encryptionType: 'string'
            path: 'string'
          }
        ]
        policyFormatVersion: int
      }
      computedProperties: [
        {
          name: 'string'
          query: 'string'
        }
      ]
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      createMode: 'string'
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          {
            order: 'string'
            path: 'string'
          }
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

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

databaseAccounts/sqlDatabases/containers

Имя	Описание	Значение
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.	string (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, по умолчанию для типа шаблона задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают Table, Graph, DocumentDB и MongoDB.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа: sqlDatabases
properties	Свойства для создания и обновления контейнера Azure Cosmos DB.	SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (обязательно)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Имя	Описание	Значение
options	Пара параметров "ключ-значение", применяемая к запросу. Это соответствует заголовкам, отправленным с запросом.	CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
ресурс	Стандартный формат JSON контейнера	SqlContainerResourceOrSqlContainerGetPropertiesResou... (обязательно)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Имя	Описание	Значение
autoscaleSettings	Задает параметры автомасштабирования. Примечание. Требуется либо пропускная способность, либо автомасштабированиеПараметры, но не оба.	АвтомасштабированиеПараметры
throughput	Количество запросов в секунду. Например, "пропускная способность": 10000.	INT

АвтомасштабированиеПараметры

Имя	Описание	Значение
maxThroughput	Представляет максимальную пропускную способность. Ресурс может масштабироваться до .	INT

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Имя	Описание	Значение
analyticStorageTtl	Аналитический срок жизни.	INT
clientEncryptionPolicy	Политика шифрования клиента для контейнера.	ClientEncryptionPolicy
computedProperties	Список вычисляемых свойств	ComputedProperty[]
conflictResolutionPolicy	Политика разрешения конфликтов для контейнера.	ConflictResolutionPolicy
createMode	Перечисление для указания режима создания ресурса.	'Default' "Восстановить"
defaultTtl	Время жизни по умолчанию	INT
идентификатор	Имя контейнера SQL Cosmos DB	string (обязательно)
indexingPolicy	Конфигурация политики индексирования. По умолчанию индексирование выполняется автоматически для всех путей к документам в контейнере.	IndexingPolicy
partitionKey	Конфигурация ключа секции, используемого для секционирования данных на несколько секций.	ContainerPartitionKey
restoreParameters	Параметры для указания сведений о восстановлении	ResourceRestoreParameters
uniqueKeyPolicy	Конфигурация политики уникального ключа для указания ограничений уникальности для документов в коллекции в службе Azure Cosmos DB.	UniqueKeyPolicy

ClientEncryptionPolicy

Имя	Описание	Значение
includedPaths	Пути к элементу, которому требуется шифрование, а также параметры для конкретного пути.	ClientEncryptionIncludedPath[] (обязательно)
policyFormatVersion	Версия определения политики шифрования клиента. Поддерживаемые версии: 1 и 2. Версия 2 поддерживает шифрование идентификаторов и путей к ключу секции.	int (обязательно) Ограничения: Минимальное значение = 1 Максимальное значение = 2

ClientEncryptionIncludedPath

Имя	Описание	Значение
clientEncryptionKeyId	Идентификатор ключа шифрования клиента, используемого для шифрования пути.	string (обязательно)
encryptionAlgorithm	Используемый алгоритм шифрования. Например, AEAD_AES_256_CBC_HMAC_SHA256.	string (обязательно)
encryptionType	Тип выполняемого шифрования. Например, детерминированные, случайные.	string (обязательно)
path	Путь, который необходимо зашифровать.	string (обязательно)

ComputedProperty

Имя	Описание	Значение
name	Имя вычисляемого свойства, например "cp_lowerName".	строка
query	Запрос, который вычисляет значение для вычисляемого свойства, например " SELECT VALUE LOWER(c.name) FROM c"	строка

ConflictResolutionPolicy

Имя	Описание	Значение
conflictResolutionPath	Путь разрешения конфликтов в режиме LastWriterWins.	строка
conflictResolutionProcedure	Процедура для разрешения конфликтов в случае пользовательского режима.	строка
mode	Указывает режим разрешения конфликтов.	"Пользовательский" 'LastWriterWins'

IndexingPolicy

Имя	Описание	Значение
automatic	Указывает, является ли политика индексирования автоматической.	bool
compositeIndexes	Список составных путей	CompositePath[]
excludedPaths	Список путей для исключения из индексирования	ExcludedPath[]
includedPaths	Список путей для включения в индексирование	IncludedPath[]
indexingMode	Указывает режим индексирования.	"согласованный" "ленивый" "none"
spatialIndexes	Список пространственных особенностей	SpatialSpec[]

CompositePath

Имя	Описание	Значение
порядок	Порядок сортировки для составных путей.	"по возрастанию" 'убывание'
path	Путь, к которому применяется поведение индексирования. Путь к индексу обычно начинается с корневого каталога и заканчивается подстановочным знаком (/path/*)	строка

ExcludedPath

Имя	Описание	Значение
path	Путь, к которому применяется поведение индексирования. Путь к индексу обычно начинается с корневого каталога и заканчивается подстановочным знаком (/path/*)	строка

IncludedPath

Имя	Описание	Значение
индексы	Список индексов для этого пути	Indexes[]
path	Путь, к которому применяется поведение индексирования. Путь к индексу обычно начинается с корневого каталога и заканчивается подстановочным знаком (/path/*)	строка

Индексы

Имя	Описание	Значение
dataType	Тип данных, к которому применяется поведение индексирования.	LineString 'MultiPolygon' "Число" 'Точка' 'Многоугольник' "Строка"
kind	Указывает тип индекса.	"Хэш" 'Range' "Пространственный"
точность	Точность индекса. -1 — максимальная точность.	INT

SpatialSpec

Имя	Описание	Значение
path	Путь, к которому применяется поведение индексирования. Путь к индексу обычно начинается с корневого каталога и заканчивается подстановочным знаком (/path/*)	строка
types	Список пространственного типа пути	Массив строк, содержащий любой из: LineString 'MultiPolygon' 'Точка' 'Многоугольник'

ContainerPartitionKey

Имя	Описание	Значение
kind	Указывает тип алгоритма, используемого для секционирования. Для MultiHash для создания контейнера поддерживается несколько ключей секций (максимум три).	"Хэш" 'MultiHash' 'Range'
пути	Список путей, по которым можно секционировать данные в контейнере	string[]
version	Указывает версию определения ключа секции.	INT Ограничения: Минимальное значение = 1 Максимальное значение = 2

ResourceRestoreParameters

Имя	Описание	Значение
restoreSource	Идентификатор восстанавливаемой учетной записи базы данных, из которой должно быть инициировано восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}	строка
restoreTimestampInUtc	Время восстановления учетной записи (формат ISO-8601).	строка

UniqueKeyPolicy

Имя	Описание	Значение
uniqueKeys	Список уникальных ключей в службе Azure Cosmos DB, которые применяют ограничение уникальности к документам в коллекции.	UniqueKey[]

UniqueKey

Имя	Описание	Значение
пути	Список путей должен быть уникальным для каждого документа в службе Azure Cosmos DB.	string[]

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

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

Шаблон	Описание
Создание учетной записи Azure Cosmos DB бесплатного уровня	Этот шаблон создает учетную запись Azure Cosmos DB бесплатного уровня для API SQL с базой данных с общей пропускной способностью и контейнером.
Создание учетной записи Azure Cosmos DB для API Core (SQL)	Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью с несколькими другими вариантами.
API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем	Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером, настроенными с аналитическим хранилищем.
Создание API SQL учетной записи Azure Cosmos DB с автомасштабированием	Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с автомасштабируемой пропускной способностью с несколькими другими вариантами.
Создание хранимых процедур API Azure Cosmos DB Core (SQL)	Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) и контейнер с хранимой процедурой, триггером и определяемой пользователем функцией.
Развертывание Azure Data Explorer DB с подключением к Cosmos DB	Развертывание Azure Data Explorer DB с подключением к Cosmos DB.

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

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

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

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

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2024-05-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "clientEncryptionPolicy": {
        "includedPaths": [
          {
            "clientEncryptionKeyId": "string",
            "encryptionAlgorithm": "string",
            "encryptionType": "string",
            "path": "string"
          }
        ],
        "policyFormatVersion": "int"
      },
      "computedProperties": [
        {
          "name": "string",
          "query": "string"
        }
      ],
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "createMode": "string",
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          {
            "order": "string",
            "path": "string"
          }
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ]
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

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

databaseAccounts/sqlDatabases/containers

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers
версия_API	Версия API ресурсов	'2024-05-15'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	string (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, по умолчанию для типа шаблона задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают Table, Graph, DocumentDB и MongoDB.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties	Свойства для создания и обновления контейнера Azure Cosmos DB.	SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (обязательно)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Имя	Описание	Значение
options	Пара параметров "ключ-значение", применяемая к запросу. Это соответствует заголовкам, отправленным вместе с запросом.	CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
ресурс	Стандартный формат JSON контейнера	SqlContainerResourceOrSqlContainerGetPropertiesResou... (обязательно)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Имя	Описание	Значение
autoscaleSettings	Задает параметры автомасштабирования. Примечание. Требуется пропускная способность или autoscaleSettings, но не оба этих параметра.	АвтомасштабированиеПараметры
throughput	Количество запросов в секунду. Например, "пропускная способность": 10000.	INT

АвтомасштабированиеПараметры

Имя	Описание	Значение
maxThroughput	Представляет максимальную пропускную способность, до которую можно масштабировать ресурс.	INT

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Имя	Описание	Значение
analyticStorageTtl	Аналитический срок жизни.	INT
clientEncryptionPolicy	Политика шифрования клиента для контейнера.	ClientEncryptionPolicy
computedProperties	Список вычисляемых свойств	ComputedProperty[]
conflictResolutionPolicy	Политика разрешения конфликтов для контейнера.	ConflictResolutionPolicy
createMode	Перечисление для указания режима создания ресурса.	'Default' Восстановление
defaultTtl	Время жизни по умолчанию	INT
идентификатор	Имя контейнера SQL Cosmos DB	строка (обязательно)
indexingPolicy	Конфигурация политики индексирования. По умолчанию индексирование выполняется автоматически для всех путей к документам в контейнере.	IndexingPolicy
partitionKey	Конфигурация ключа секции, используемого для секционирования данных на несколько секций	ContainerPartitionKey
restoreParameters	Параметры для указания сведений о восстановлении	ResourceRestoreParameters
uniqueKeyPolicy	Конфигурация политики уникальных ключей для указания ограничений уникальности документов в коллекции в службе Azure Cosmos DB.	UniqueKeyPolicy

ClientEncryptionPolicy

Имя	Описание	Значение
включенные пути	Пути к элементу, которому требуется шифрование, а также параметры для конкретных путей.	ClientEncryptionIncludedPath[] (обязательно)
policyFormatVersion	Версия определения политики шифрования клиента. Поддерживаются версии 1 и 2. Версия 2 поддерживает шифрование пути к идентификатору и ключу секции.	int (обязательно) Ограничения: Минимальное значение = 1 Максимальное значение = 2

ClientEncryptionIncludedPath

Имя	Описание	Значение
clientEncryptionKeyId	Идентификатор ключа шифрования клиента, используемого для шифрования пути.	строка (обязательно)
encryptionAlgorithm	Используемый алгоритм шифрования. Например, AEAD_AES_256_CBC_HMAC_SHA256.	строка (обязательно)
encryptionType	Тип выполняемого шифрования. Например, детерминированное, случайное.	строка (обязательно)
path	Путь, который необходимо зашифровать.	строка (обязательно)

ComputedProperty

Имя	Описание	Значение
name	Имя вычисляемого свойства, например "cp_lowerName".	строка
query	Запрос, который вычисляет значение для вычисляемого свойства, например " SELECT VALUE LOWER(c.name) FROM c"	строка

ConflictResolutionPolicy

Имя	Описание	Значение
conflictResolutionPath	Путь разрешения конфликтов в режиме LastWriterWins.	строка
conflictResolutionProcedure	Процедура для разрешения конфликтов в случае пользовательского режима.	строка
mode	Указывает режим разрешения конфликтов.	"Пользовательский" 'LastWriterWins'

IndexingPolicy

Имя	Описание	Значение
automatic	Указывает, является ли политика индексирования автоматической.	bool
compositeIndexes	Список составных путей	CompositePath[]
excludedPaths	Список путей для исключения из индексирования	ExcludedPath[]
includedPaths	Список путей для включения в индексирование	IncludedPath[]
indexingMode	Указывает режим индексирования.	"согласованный" "ленивый" "none"
spatialIndexes	Список пространственных особенностей	SpatialSpec[]

CompositePath

Имя	Описание	Значение
порядок	Порядок сортировки для составных путей.	"по возрастанию" 'убывание'
path	Путь, к которому применяется поведение индексирования. Путь к индексу обычно начинается с корневого каталога и заканчивается подстановочным знаком (/path/*)	строка

ExcludedPath

Имя	Описание	Значение
path	Путь, к которому применяется поведение индексирования. Путь к индексу обычно начинается с корневого каталога и заканчивается подстановочным знаком (/path/*)	строка

IncludedPath

Имя	Описание	Значение
индексы	Список индексов для этого пути	Indexes[]
path	Путь, к которому применяется поведение индексирования. Путь к индексу обычно начинается с корневого каталога и заканчивается подстановочным знаком (/path/*)	строка

Индексы

Имя	Описание	Значение
dataType	Тип данных, к которому применяется поведение индексирования.	LineString 'MultiPolygon' "Число" 'Точка' 'Многоугольник' "Строка"
kind	Указывает тип индекса.	"Хэш" 'Range' "Пространственный"
точность	Точность индекса. -1 — максимальная точность.	INT

SpatialSpec

Имя	Описание	Значение
path	Путь, к которому применяется поведение индексирования. Путь к индексу обычно начинается с корневого каталога и заканчивается подстановочным знаком (/path/*)	строка
types	Список пространственного типа пути	Массив строк, содержащий любой из: LineString 'MultiPolygon' 'Точка' 'Многоугольник'

ContainerPartitionKey

Имя	Описание	Значение
kind	Указывает тип алгоритма, используемого для секционирования. Для MultiHash для создания контейнера поддерживается несколько ключей секций (максимум три).	"Хэш" 'MultiHash' 'Range'
пути	Список путей, по которым можно секционировать данные в контейнере	string[]
version	Указывает версию определения ключа секции.	INT Ограничения: Минимальное значение = 1 Максимальное значение = 2

ResourceRestoreParameters

Имя	Описание	Значение
restoreSource	Идентификатор восстанавливаемой учетной записи базы данных, из которой должно быть инициировано восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccounts}	строка
restoreTimestampInUtc	Время восстановления учетной записи (формат ISO-8601).	строка

UniqueKeyPolicy

Имя	Описание	Значение
uniqueKeys	Список уникальных ключей в службе Azure Cosmos DB, которые применяют ограничение уникальности к документам в коллекции.	UniqueKey[]

UniqueKey

Имя	Описание	Значение
пути	Список путей должен быть уникальным для каждого документа в службе Azure Cosmos DB.	string[]

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

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

Шаблон	Описание
Создание учетной записи Azure Cosmos DB бесплатного уровня	Этот шаблон создает учетную запись Azure Cosmos DB бесплатного уровня для API SQL с базой данных с общей пропускной способностью и контейнером.
Создание учетной записи Azure Cosmos DB для API Core (SQL)	Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью с несколькими другими вариантами.
API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем	Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером, настроенными с аналитическим хранилищем.
Создание API SQL учетной записи Azure Cosmos DB с автомасштабированием	Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с автомасштабируемой пропускной способностью с несколькими другими вариантами.
Создание хранимых процедур API Azure Cosmos DB Core (SQL)	Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) и контейнер с хранимой процедурой, триггером и определяемой пользователем функцией.
Развертывание Azure Data Explorer DB с подключением к Cosmos DB	Развертывание Azure Data Explorer DB с подключением к Cosmos DB.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        clientEncryptionPolicy = {
          includedPaths = [
            {
              clientEncryptionKeyId = "string"
              encryptionAlgorithm = "string"
              encryptionType = "string"
              path = "string"
            }
          ]
          policyFormatVersion = int
        }
        computedProperties = [
          {
            name = "string"
            query = "string"
          }
        ]
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        createMode = "string"
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            {
              order = "string"
              path = "string"
            }
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

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

databaseAccounts/sqlDatabases/containers

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-05-15"
name	имя ресурса.	string (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: sqlDatabases
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB".	Словарь имен и значений тегов.
properties	Свойства для создания и обновления контейнера Azure Cosmos DB.	SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... (обязательно)

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

Имя	Описание	Значение
options	Пара параметров "ключ-значение", применяемая к запросу. Это соответствует заголовкам, отправленным вместе с запросом.	CreateUpdateOptionsOrSqlContainerGetPropertiesOption...
ресурс	Стандартный формат JSON контейнера	SqlContainerResourceOrSqlContainerGetPropertiesResou... (обязательно)

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

Имя	Описание	Значение
autoscaleSettings	Задает параметры автомасштабирования. Примечание. Требуется пропускная способность или autoscaleSettings, но не оба этих параметра.	АвтомасштабированиеПараметры
throughput	Количество запросов в секунду. Например, "пропускная способность": 10000.	INT

АвтомасштабированиеПараметры

Имя	Описание	Значение
maxThroughput	Представляет максимальную пропускную способность, до которую можно масштабировать ресурс.	INT

SqlContainerResourceOrSqlContainerGetPropertiesResou...

Имя	Описание	Значение
analyticStorageTtl	Аналитический срок жизни.	INT
clientEncryptionPolicy	Политика шифрования клиента для контейнера.	ClientEncryptionPolicy
computedProperties	Список вычисляемых свойств	ComputedProperty[]
conflictResolutionPolicy	Политика разрешения конфликтов для контейнера.	ConflictResolutionPolicy
createMode	Перечисление для указания режима создания ресурса.	"По умолчанию" "Восстановление"
defaultTtl	Время жизни по умолчанию	INT
идентификатор	Имя контейнера SQL Cosmos DB	строка (обязательно)
indexingPolicy	Конфигурация политики индексирования. По умолчанию индексирование выполняется автоматически для всех путей к документам в контейнере.	IndexingPolicy
partitionKey	Конфигурация ключа секции, используемого для секционирования данных на несколько секций	ContainerPartitionKey
restoreParameters	Параметры для указания сведений о восстановлении	ResourceRestoreParameters
uniqueKeyPolicy	Конфигурация политики уникальных ключей для указания ограничений уникальности документов в коллекции в службе Azure Cosmos DB.	UniqueKeyPolicy

ClientEncryptionPolicy

Имя	Описание	Значение
включенные пути	Пути к элементу, которому требуется шифрование, а также параметры для конкретных путей.	ClientEncryptionIncludedPath[] (обязательно)
policyFormatVersion	Версия определения политики шифрования клиента. Поддерживаются версии 1 и 2. Версия 2 поддерживает шифрование пути к идентификатору и ключу секции.	int (обязательно) Ограничения: Минимальное значение = 1 Максимальное значение = 2

ClientEncryptionIncludedPath

Имя	Описание	Значение
clientEncryptionKeyId	Идентификатор ключа шифрования клиента, используемого для шифрования пути.	string (обязательно)
encryptionAlgorithm	Используемый алгоритм шифрования. Например, AEAD_AES_256_CBC_HMAC_SHA256.	string (обязательно)
encryptionType	Тип выполняемого шифрования. Например, детерминированные, случайные.	string (обязательно)
path	Путь, который необходимо зашифровать.	string (обязательно)

ComputedProperty

Имя	Описание	Значение
name	Имя вычисляемого свойства, например "cp_lowerName".	строка
query	Запрос, который вычисляет значение для вычисляемого свойства, например " SELECT VALUE LOWER(c.name) FROM c"	строка

ConflictResolutionPolicy

Имя	Описание	Значение
conflictResolutionPath	Путь разрешения конфликтов в режиме LastWriterWins.	строка
conflictResolutionProcedure	Процедура для разрешения конфликтов в случае пользовательского режима.	строка
mode	Указывает режим разрешения конфликтов.	"Custom" "LastWriterWins"

IndexingPolicy

Имя	Описание	Значение
automatic	Указывает, является ли политика индексирования автоматической.	bool
compositeIndexes	Список составных путей	CompositePath[]
excludedPaths	Список путей для исключения из индексирования	ExcludedPath[]
includedPaths	Список путей для включения в индексирование	IncludedPath[]
indexingMode	Указывает режим индексирования.	"согласованный" "ленивый" "нет"
spatialIndexes	Список пространственных особенностей	SpatialSpec[]

CompositePath

Имя	Описание	Значение
порядок	Порядок сортировки для составных путей.	"по возрастанию" "по убыванию"
path	Путь, к которому применяется поведение индексирования. Путь к индексу обычно начинается с корневого каталога и заканчивается подстановочным знаком (/path/*)	строка

ExcludedPath

Имя	Описание	Значение
path	Путь, к которому применяется поведение индексирования. Путь к индексу обычно начинается с корневого каталога и заканчивается подстановочным знаком (/path/*)	строка

IncludedPath

Имя	Описание	Значение
индексы	Список индексов для этого пути	Indexes[]
path	Путь, к которому применяется поведение индексирования. Путь к индексу обычно начинается с корневого каталога и заканчивается подстановочным знаком (/path/*)	строка

Индексы

Имя	Описание	Значение
dataType	Тип данных, к которому применяется поведение индексирования.	"LineString" "MultiPolygon" "Число" "Точка" "Многоугольник" "String"
kind	Указывает тип индекса.	"Хэш" "Диапазон" "Пространственный"
точность	Точность индекса. -1 — это максимальная точность.	INT

SpatialSpec

Имя	Описание	Значение
path	Путь, к которому применяется поведение индексирования. Пути индекса обычно начинаются с корневого каталога и заканчиваются подстановочным знаком (/path/*).	строка
types	Список пространственного типа пути	Массив строк, содержащий любой из: "LineString" "MultiPolygon" "Точка" "Многоугольник"

ContainerPartitionKey

Имя	Описание	Значение
kind	Указывает тип алгоритма, используемого для секционирования. Для MultiHash для создания контейнера поддерживается несколько ключей секций (не более трех).	"Хэш" "MultiHash" "Диапазон"
пути	Список путей, по которым можно секционировать данные в контейнере	string[]
version	Указывает версию определения ключа секции.	INT Ограничения: Минимальное значение = 1 Максимальное значение = 2

ResourceRestoreParameters

Имя	Описание	Значение
restoreSource	Идентификатор восстанавливаемой учетной записи базы данных, из которой должно быть инициировано восстановление. Например: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	строка
restoreTimestampInUtc	Время восстановления учетной записи (формат ISO-8601).	строка

UniqueKeyPolicy

Имя	Описание	Значение
uniqueKeys	Список уникальных ключей в , которые применяют ограничение уникальности к документам в коллекции в службе Azure Cosmos DB.	UniqueKey[]

UniqueKey

Имя	Описание	Значение
пути	Список путей должен быть уникальным для каждого документа в службе Azure Cosmos DB	string[]