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

База данных Microsoft.DocumentDBAccounts/apis/databases/containers 2016-03-19

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-19' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: 'string'
      }
      defaultTtl: int
      id: 'string'
      indexingPolicy: {
        automatic: bool
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

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

databaseAccounts/apis/databases/containers

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

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

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа базы данных
properties Свойства для создания и обновления контейнера Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (обязательно)

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

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

CreateUpdateOptions

Имя Описание Значение
{настраиваемое свойство} строка

SqlContainerResource

Имя Описание Значение
conflictResolutionPolicy Политика разрешения конфликтов для контейнера. ConflictResolutionPolicy
defaultTtl Время жизни по умолчанию INT
идентификатор Имя контейнера SQL Cosmos DB string (обязательно)
indexingPolicy Конфигурация политики индексирования. По умолчанию индексирование выполняется автоматически для всех путей к документам в контейнере. IndexingPolicy
partitionKey Конфигурация ключа секции, используемого для секционирования данных на несколько секций. ContainerPartitionKey
uniqueKeyPolicy Конфигурация политики уникального ключа для указания ограничений уникальности для документов в коллекции в службе Azure Cosmos DB. UniqueKeyPolicy

ConflictResolutionPolicy

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

IndexingPolicy

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

ExcludedPath

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

IncludedPath

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

Индексы

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

ContainerPartitionKey

Имя Описание Значение
kind Указывает тип алгоритма, используемого для секционирования. "Хэш"
'Range'
пути Список путей, по которым можно секционировать данные в контейнере string[]

UniqueKeyPolicy

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

UniqueKey

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

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

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

Шаблон Описание
Создание Azure Cosmos с ПОМОЩЬЮ API SQL и нескольких контейнеров

Развертывание в Azure		 Шаблон создает контейнер Cosmos с API SQL и позволяет добавлять многообразные контейнеры.

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

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

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

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
  "apiVersion": "2016-03-19",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "string"
      },
      "defaultTtl": "int",
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ]
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

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

databaseAccounts/apis/databases/containers

Имя Описание Значение
тип Тип ресурса Microsoft.DocumentDB/databaseAccounts/apis/databases/containers
версия_API Версия API ресурсов '2016-03-19'
name имя ресурса.

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

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

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

CreateUpdateOptions

Имя Описание Значение
{настраиваемое свойство} строка

SqlContainerResource

Имя Описание Значение
conflictResolutionPolicy Политика разрешения конфликтов для контейнера. ConflictResolutionPolicy
defaultTtl Время жизни по умолчанию INT
идентификатор Имя контейнера SQL Cosmos DB string (обязательно)
indexingPolicy Конфигурация политики индексирования. По умолчанию индексирование выполняется автоматически для всех путей к документам в контейнере. IndexingPolicy
partitionKey Конфигурация ключа секции, используемого для секционирования данных на несколько секций. ContainerPartitionKey
uniqueKeyPolicy Конфигурация политики уникального ключа для указания ограничений уникальности для документов в коллекции в службе Azure Cosmos DB. UniqueKeyPolicy

ConflictResolutionPolicy

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

IndexingPolicy

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

ExcludedPath

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

IncludedPath

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

Индексы

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

ContainerPartitionKey

Имя Описание Значение
kind Указывает тип алгоритма, используемого для секционирования. "Хэш"
'Range'
пути Список путей, по которым можно секционировать данные в контейнере string[]

UniqueKeyPolicy

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

UniqueKey

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

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

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

Шаблон Описание
Создание Azure Cosmos с ПОМОЩЬЮ API SQL и нескольких контейнеров

Развертывание в Azure		 Шаблон создает контейнер Cosmos с API SQL и позволяет добавлять многообразные контейнеры.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-19"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "string"
        }
        defaultTtl = int
        id = "string"
        indexingPolicy = {
          automatic = bool
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

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

databaseAccounts/apis/databases/containers

Имя Описание Значение
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-19"
name имя ресурса. string (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: databases
properties Свойства для создания и обновления контейнера Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerProp... (обязательно)

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

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

CreateUpdateOptions

Имя Описание Значение
{настраиваемое свойство} строка

SqlContainerResource

Имя Описание Значение
conflictResolutionPolicy Политика разрешения конфликтов для контейнера. ConflictResolutionPolicy
defaultTtl Время жизни по умолчанию INT
идентификатор Имя контейнера SQL Cosmos DB string (обязательно)
indexingPolicy Конфигурация политики индексирования. По умолчанию индексирование выполняется автоматически для всех путей к документам в контейнере. IndexingPolicy
partitionKey Конфигурация ключа секции, используемого для секционирования данных на несколько секций. ContainerPartitionKey
uniqueKeyPolicy Конфигурация политики уникального ключа для указания ограничений уникальности для документов в коллекции в службе Azure Cosmos DB. UniqueKeyPolicy

ConflictResolutionPolicy

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

IndexingPolicy

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

ExcludedPath

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

IncludedPath

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

Индексы

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

ContainerPartitionKey

Имя Описание Значение
kind Указывает тип алгоритма, используемого для секционирования. "Хэш"
"Диапазон"
пути Список путей, по которым можно секционировать данные в контейнере string[]

UniqueKeyPolicy

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

UniqueKey

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