База данных Microsoft.DocumentDBAccounts/apis/database/container 2016-03-31
- последние
- 2016-03-31
- 2016-03-19
- 2015-11-06
- 2015-04-08
- 2015-04-01
Определение ресурсов Bicep
Тип ресурса databaseAccounts/apis/database/container можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/apis/database/container, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31' = {
parent: resourceSymbolicName
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'
]
}
]
}
}
}
}
Значения свойств
ConflictResolutionPolicy
Имя | Описание | Ценность |
---|---|---|
conflictResolutionPath | Путь разрешения конфликтов в режиме LastWriterWins. | струна |
conflictResolutionProcedure | Процедура разрешения конфликтов в случае пользовательского режима. | струна |
режим | Указывает режим разрешения конфликтов. | "Custom" "LastWriterWins" |
ContainerPartitionKey
Имя | Описание | Ценность |
---|---|---|
добрый | Указывает тип алгоритма, используемого для секционирования | Хэш "Диапазон" |
Пути | Список путей, с помощью которых можно секционировать данные в контейнере | string[] |
CreateUpdateOptions
Имя | Описание | Ценность |
---|
ИсключенныйPath
Имя | Описание | Ценность |
---|---|---|
путь | Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*) | струна |
Включенныйpath
Индексы
Имя | Описание | Ценность |
---|---|---|
dataType | Тип данных, к которому применяется индексирование. | LineString 'MultiPolygon' "Число" "Точка" "Многоугольник" "String" |
добрый | Указывает тип индекса. | Хэш "Диапазон" "Пространственный" |
точность | Точность индекса. -1 — максимальная точность. | int |
IndexingPolicy
Имя | Описание | Ценность |
---|---|---|
Автоматически | Указывает, является ли политика индексирования автоматической | bool |
excludedPaths | Список путей для исключения из индексирования | ИсключенныйPath[] |
включенныеPaths | Список путей для включения в индексирование | IncludedPath[] |
indexingMode | Указывает режим индексирования. | "Согласованный" "Ленивый" "Нет" |
Microsoft.DocumentDB/databaseAccounts/apis/databases/container
Имя | Описание | Ценность |
---|---|---|
имя | Имя ресурса | строка (обязательно) |
родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: databaseAccounts/apis/database |
свойства | Свойства для создания и обновления контейнера Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (обязательно) |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
Имя | Описание | Ценность |
---|---|---|
Параметры | Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. | CreateUpdateOptions (обязательно) |
ресурс | Стандартный формат JSON контейнера | SqlContainerResource (обязательно) |
SqlContainerResource
Имя | Описание | Ценность |
---|---|---|
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[] |
Определение ресурса шаблона ARM
Тип ресурса databaseAccounts/apis/database/container можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/apis/database/container, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
"apiVersion": "2016-03-31",
"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" ]
}
]
}
}
}
}
Значения свойств
ConflictResolutionPolicy
Имя | Описание | Ценность |
---|---|---|
conflictResolutionPath | Путь разрешения конфликтов в режиме LastWriterWins. | струна |
conflictResolutionProcedure | Процедура разрешения конфликтов в случае пользовательского режима. | струна |
режим | Указывает режим разрешения конфликтов. | "Custom" "LastWriterWins" |
ContainerPartitionKey
Имя | Описание | Ценность |
---|---|---|
добрый | Указывает тип алгоритма, используемого для секционирования | Хэш "Диапазон" |
Пути | Список путей, с помощью которых можно секционировать данные в контейнере | string[] |
CreateUpdateOptions
Имя | Описание | Ценность |
---|
ИсключенныйPath
Имя | Описание | Ценность |
---|---|---|
путь | Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*) | струна |
Включенныйpath
Индексы
Имя | Описание | Ценность |
---|---|---|
dataType | Тип данных, к которому применяется индексирование. | LineString 'MultiPolygon' "Число" "Точка" "Многоугольник" "String" |
добрый | Указывает тип индекса. | Хэш "Диапазон" "Пространственный" |
точность | Точность индекса. -1 — максимальная точность. | int |
IndexingPolicy
Имя | Описание | Ценность |
---|---|---|
Автоматически | Указывает, является ли политика индексирования автоматической | bool |
excludedPaths | Список путей для исключения из индексирования | ИсключенныйPath[] |
включенныеPaths | Список путей для включения в индексирование | IncludedPath[] |
indexingMode | Указывает режим индексирования. | "Согласованный" "Ленивый" "Нет" |
Microsoft.DocumentDB/databaseAccounts/apis/databases/container
Имя | Описание | Ценность |
---|---|---|
apiVersion | Версия API | '2016-03-31' |
имя | Имя ресурса | строка (обязательно) |
свойства | Свойства для создания и обновления контейнера Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (обязательно) |
тип | Тип ресурса | "Microsoft.DocumentDB/databaseAccounts/apis/database/container" |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
Имя | Описание | Ценность |
---|---|---|
Параметры | Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. | CreateUpdateOptions (обязательно) |
ресурс | Стандартный формат JSON контейнера | SqlContainerResource (обязательно) |
SqlContainerResource
Имя | Описание | Ценность |
---|---|---|
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[] |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
Шаблон | Описание |
---|---|
Создание Azure Cosmos с помощью API SQL и нескольких контейнеров развертывание |
Шаблон создает контейнер Cosmos с API SQL и позволяет добавлять контейнеры многолитных элементов. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса databaseAccounts/apis/database/container можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/apis/database/container, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2016-03-31"
name = "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"
]
}
]
}
}
}
})
}
Значения свойств
ConflictResolutionPolicy
Имя | Описание | Ценность |
---|---|---|
conflictResolutionPath | Путь разрешения конфликтов в режиме LastWriterWins. | струна |
conflictResolutionProcedure | Процедура разрешения конфликтов в случае пользовательского режима. | струна |
режим | Указывает режим разрешения конфликтов. | "Custom" "LastWriterWins" |
ContainerPartitionKey
Имя | Описание | Ценность |
---|---|---|
добрый | Указывает тип алгоритма, используемого для секционирования | Хэш "Диапазон" |
Пути | Список путей, с помощью которых можно секционировать данные в контейнере | string[] |
CreateUpdateOptions
Имя | Описание | Ценность |
---|
ИсключенныйPath
Имя | Описание | Ценность |
---|---|---|
путь | Путь, к которому применяется индексирование. Пути индекса обычно начинаются с корневого и заканчиваются подстановочным знаком (/path/*) | струна |
Включенныйpath
Индексы
Имя | Описание | Ценность |
---|---|---|
dataType | Тип данных, к которому применяется индексирование. | LineString 'MultiPolygon' "Число" "Точка" "Многоугольник" "String" |
добрый | Указывает тип индекса. | Хэш "Диапазон" "Пространственный" |
точность | Точность индекса. -1 — максимальная точность. | int |
IndexingPolicy
Имя | Описание | Ценность |
---|---|---|
Автоматически | Указывает, является ли политика индексирования автоматической | bool |
excludedPaths | Список путей для исключения из индексирования | ИсключенныйPath[] |
включенныеPaths | Список путей для включения в индексирование | IncludedPath[] |
indexingMode | Указывает режим индексирования. | "Согласованный" "Ленивый" "Нет" |
Microsoft.DocumentDB/databaseAccounts/apis/databases/container
Имя | Описание | Ценность |
---|---|---|
имя | Имя ресурса | строка (обязательно) |
parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: databaseAccounts/apis/database |
свойства | Свойства для создания и обновления контейнера Azure Cosmos DB. | SqlContainerCreateUpdatePropertiesOrSqlContainerProperties (обязательно) |
тип | Тип ресурса | "Microsoft.DocumentDB/databaseAccounts/apis/database/containers@2016-03-31" |
SqlContainerCreateUpdatePropertiesOrSqlContainerProperties
Имя | Описание | Ценность |
---|---|---|
Параметры | Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. | CreateUpdateOptions (обязательно) |
ресурс | Стандартный формат JSON контейнера | SqlContainerResource (обязательно) |
SqlContainerResource
Имя | Описание | Ценность |
---|---|---|
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[] |