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


База данных Microsoft.DocumentDBAccounts/sqlDatabases/container 2021-10-15

Определение ресурсов Bicep

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-10-15' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      conflictResolutionPolicy: {
        conflictResolutionPath: 'string'
        conflictResolutionProcedure: 'string'
        mode: '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
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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

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

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

Составной Путь

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

ConflictResolutionPolicy

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

ContainerPartitionKey

Имя Описание Ценность
добрый Указывает тип алгоритма, используемого для секционирования. Для MultiHash для создания контейнера поддерживаются несколько ключей секций (не более трех). Хэш
MultiHash
"Диапазон"
Пути Список путей, с помощью которых можно секционировать данные в контейнере string[]
Версия Указывает версию определения ключа секции int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. AutoscaleSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

ИсключенныйPath

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

Включенныйpath

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

Индексы

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

IndexingPolicy

Имя Описание Ценность
Автоматически Указывает, является ли политика индексирования автоматической bool
составныеIndexes Список составных путей CompositePath[][]
excludedPaths Список путей для исключения из индексирования ИсключенныйPath[]
включенныеPaths Список путей для включения в индексирование IncludedPath[]
indexingMode Указывает режим индексирования. "согласованный"
"ленивый"
"нет"
spatialIndexes Список пространственных особенностей SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/container

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

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: databaseAccounts/sqlDatabases
свойства Свойства для создания и обновления контейнера Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

SpatialSpec

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

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

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

Теги

Имя Описание Ценность

UniqueKey

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

UniqueKeyPolicy

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

Примеры краткого руководства

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

Bicep-файл Описание
API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером, настроенным с помощью аналитического хранилища.
Создание учетной записи 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 Azure Cosmos DB Core (SQL) Этот шаблон создает учетную запись Azure Cosmos DB для API Core (SQL) и контейнер с хранимой процедурой, триггером и определяемой пользователем функцией.
создает приложение микрослужб Dapr с помощью приложений контейнеров Создайте приложение микрослужб Dapr с помощью контейнерных приложений.
Создает приложение dapr pub-sub servicebus с помощью приложений контейнеров Создайте приложение dapr pub-sub servicebus с помощью контейнерных приложений.
Развертывание базы данных Azure Data Explorer с помощью подключения Cosmos DB Разверните базу данных Azure Data Explorer с подключением Cosmos DB.

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

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

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

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2021-10-15",
  "name": "string",
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "conflictResolutionPolicy": {
        "conflictResolutionPath": "string",
        "conflictResolutionProcedure": "string",
        "mode": "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"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

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

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

Составной Путь

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

ConflictResolutionPolicy

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

ContainerPartitionKey

Имя Описание Ценность
добрый Указывает тип алгоритма, используемого для секционирования. Для MultiHash для создания контейнера поддерживаются несколько ключей секций (не более трех). Хэш
MultiHash
"Диапазон"
Пути Список путей, с помощью которых можно секционировать данные в контейнере string[]
Версия Указывает версию определения ключа секции int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. AutoscaleSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

ИсключенныйPath

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

Включенныйpath

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

Индексы

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

IndexingPolicy

Имя Описание Ценность
Автоматически Указывает, является ли политика индексирования автоматической bool
составныеIndexes Список составных путей CompositePath[][]
excludedPaths Список путей для исключения из индексирования ИсключенныйPath[]
включенныеPaths Список путей для включения в индексирование IncludedPath[]
indexingMode Указывает режим индексирования. "согласованный"
"ленивый"
"нет"
spatialIndexes Список пространственных особенностей SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/container

Имя Описание Ценность
apiVersion Версия API '2021-10-15'
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
свойства Свойства для создания и обновления контейнера Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/container"

SpatialSpec

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

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

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

Теги

Имя Описание Ценность

UniqueKey

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

UniqueKeyPolicy

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

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

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

Шаблон Описание
API SQL учетной записи Azure Cosmos DB с аналитическим хранилищем

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

развертывание в Azure
Этот шаблон создает бесплатную учетную запись Azure Cosmos DB для API SQL с базой данных с общей пропускной способностью и контейнером.
создание учетной записи Azure Cosmos DB для API Core (SQL)

развертывание в Azure
Этот шаблон создает учетную запись Azure Cosmos для API Core (SQL) с базой данных и контейнером с пропускной способностью с несколькими другими параметрами.
создание API SQL учетной записи Azure Cosmos DB с автомасштабированием

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

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

развертывание в Azure
Создайте приложение микрослужб Dapr с помощью контейнерных приложений.
Создает приложение dapr pub-sub servicebus с помощью приложений контейнеров

развертывание в Azure
Создайте приложение dapr pub-sub servicebus с помощью контейнерных приложений.
Развертывание базы данных Azure Data Explorer с помощью подключения Cosmos DB

развертывание в Azure
Разверните базу данных Azure Data Explorer с подключением Cosmos DB.

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

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

  • групп ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-10-15"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        conflictResolutionPolicy = {
          conflictResolutionPath = "string"
          conflictResolutionProcedure = "string"
          mode = "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
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

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

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

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

Составной Путь

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

ConflictResolutionPolicy

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

ContainerPartitionKey

Имя Описание Ценность
добрый Указывает тип алгоритма, используемого для секционирования. Для MultiHash для создания контейнера поддерживаются несколько ключей секций (не более трех). Хэш
MultiHash
"Диапазон"
Пути Список путей, с помощью которых можно секционировать данные в контейнере string[]
Версия Указывает версию определения ключа секции int

Ограничения целостности:
Минимальное значение = 1
Максимальное значение = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. AutoscaleSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. int

ИсключенныйPath

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

Включенныйpath

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

Индексы

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

IndexingPolicy

Имя Описание Ценность
Автоматически Указывает, является ли политика индексирования автоматической bool
составныеIndexes Список составных путей CompositePath[][]
excludedPaths Список путей для исключения из индексирования ИсключенныйPath[]
включенныеPaths Список путей для включения в индексирование IncludedPath[]
indexingMode Указывает режим индексирования. "согласованный"
"ленивый"
"нет"
spatialIndexes Список пространственных особенностей SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/container

Имя Описание Ценность
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: databaseAccounts/sqlDatabases
свойства Свойства для создания и обновления контейнера Azure Cosmos DB. SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-10-15"

SpatialSpec

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

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

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

SqlContainerResourceOrSqlContainerGetPropertiesResource

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

Теги

Имя Описание Ценность

UniqueKey

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

UniqueKeyPolicy

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