База данных Microsoft.DocumentDBAccounts/sqlDatabases/container

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

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

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2026-04-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  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'
      dataMaskingPolicy: {
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            length: int
            path: 'string'
            startPosition: int
            strategy: 'string'
          }
        ]
        isPolicyEnabled: bool
      }
      defaultTtl: int
      fullTextPolicy: {
        defaultLanguage: 'string'
        fullTextPaths: [
          {
            language: 'string'
            path: 'string'
          }
        ]
      }
      id: 'string'
      indexingPolicy: {
        automatic: bool
        compositeIndexes: [
          [
            {
              order: 'string'
              path: 'string'
            }
          ]
        ]
        excludedPaths: [
          {
            path: 'string'
          }
        ]
        fullTextIndexes: [
          {
            path: 'string'
          }
        ]
        includedPaths: [
          {
            indexes: [
              {
                dataType: 'string'
                kind: 'string'
                precision: int
              }
            ]
            path: 'string'
          }
        ]
        indexingMode: 'string'
        spatialIndexes: [
          {
            path: 'string'
            types: [
              'string'
            ]
          }
        ]
        vectorIndexes: [
          {
            indexingSearchListSize: int
            path: 'string'
            quantizationByteSize: int
            type: 'string'
            vectorIndexShardKey: [
              'string'
            ]
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
        throughputBucketForBuild: int
      }
      materializedViews: [
        {
          id: 'string'
          _rid: 'string'
        }
      ]
      materializedViewsProperties: {
        throughputBucketForBuild: int
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
      vectorEmbeddingPolicy: {
        vectorEmbeddings: [
          {
            dataType: 'string'
            dimensions: int
            distanceFunction: 'string'
            path: 'string'
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/container

ARMResourcePropertiesTags

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

ClientEncryptionIncludedPath

ClientEncryptionPolicy

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

ComputedProperty (ВычислительноеСвойство)

Политика разрешения конфликтов

ContainerPartitionKey (Ключ контейнераPartition)

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Политика маскировки данных

DataMaskingPolicyExcludedPathsItem

DataMaskingPolicyIncludedPathsItem

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

FullTextIndexPath (Полный текстИндексPath)

FullTextPath (Полный текстPath)

FullTextPolicy

Включенныйpath

Индексы

Политика Индексации

Управляемая служебная идентичность

ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

MaterializedViewDefinition (МатериализованноеViewDefinition)

МатериализованныйВидДетали

MaterializedViewsProperties (МатериализованныеViewsProperties)

ResourceRestoreParameters (Параметры восстановления)

ПространственнаяСпецификация

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

SqlContainerResourceOrSqlContainerGetPropertiesResource

Уникальный ключ

Политика UniqueKeyPolicy

ВекторВстраивание

Политика VectorEmbeddingPolicy

Векторный индекс

Примеры использования

Примеры Bicep

Простой пример развертывания контейнера SQL в учетной записи Cosmos DB.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: []
    consistencyPolicy: {
      defaultConsistencyLevel: 'BoundedStaleness'
      maxIntervalInSeconds: 10
      maxStalenessPrefix: 200
    }
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'FirstPartyIdentity'
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    ipRules: []
    isVirtualNetworkFilterEnabled: false
    locations: [
      {
        failoverPriority: 0
        isZoneRedundant: false
        locationName: 'West Europe'
      }
    ]
    networkAclBypass: 'None'
    networkAclBypassResourceIds: []
    publicNetworkAccess: 'Enabled'
    virtualNetworkRules: []
  }
}

resource sqlDatabase 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15' = {
  name: resourceName
  parent: databaseAccount
  properties: {
    options: {
      throughput: 400
    }
    resource: {
      id: resourceName
    }
  }
}

resource container 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-15' = {
  name: resourceName
  parent: sqlDatabase
  properties: {
    options: {}
    resource: {
      id: 'test-containerWest Europe'
      partitionKey: {
        kind: 'Hash'
        paths: [
          '/definition'
        ]
      }
    }
  }
}

Примеры быстрого запуска Azure

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

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

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

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

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

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2026-04-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "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",
      "dataMaskingPolicy": {
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "length": "int",
            "path": "string",
            "startPosition": "int",
            "strategy": "string"
          }
        ],
        "isPolicyEnabled": "bool"
      },
      "defaultTtl": "int",
      "fullTextPolicy": {
        "defaultLanguage": "string",
        "fullTextPaths": [
          {
            "language": "string",
            "path": "string"
          }
        ]
      },
      "id": "string",
      "indexingPolicy": {
        "automatic": "bool",
        "compositeIndexes": [
          [
            {
              "order": "string",
              "path": "string"
            }
          ]
        ],
        "excludedPaths": [
          {
            "path": "string"
          }
        ],
        "fullTextIndexes": [
          {
            "path": "string"
          }
        ],
        "includedPaths": [
          {
            "indexes": [
              {
                "dataType": "string",
                "kind": "string",
                "precision": "int"
              }
            ],
            "path": "string"
          }
        ],
        "indexingMode": "string",
        "spatialIndexes": [
          {
            "path": "string",
            "types": [ "string" ]
          }
        ],
        "vectorIndexes": [
          {
            "indexingSearchListSize": "int",
            "path": "string",
            "quantizationByteSize": "int",
            "type": "string",
            "vectorIndexShardKey": [ "string" ]
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string",
        "throughputBucketForBuild": "int"
      },
      "materializedViews": [
        {
          "id": "string",
          "_rid": "string"
        }
      ],
      "materializedViewsProperties": {
        "throughputBucketForBuild": "int"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      },
      "vectorEmbeddingPolicy": {
        "vectorEmbeddings": [
          {
            "dataType": "string",
            "dimensions": "int",
            "distanceFunction": "string",
            "path": "string"
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/container

ARMResourcePropertiesTags

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

ClientEncryptionIncludedPath

ClientEncryptionPolicy

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

ComputedProperty (ВычислительноеСвойство)

Политика разрешения конфликтов

ContainerPartitionKey (Ключ контейнераPartition)

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Политика маскировки данных

DataMaskingPolicyExcludedPathsItem

DataMaskingPolicyIncludedPathsItem

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

FullTextIndexPath (Полный текстИндексPath)

FullTextPath (Полный текстPath)

FullTextPolicy

Включенныйpath

Индексы

Политика Индексации

Управляемая служебная идентичность

ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

MaterializedViewDefinition (МатериализованноеViewDefinition)

МатериализованныйВидДетали

MaterializedViewsProperties (МатериализованныеViewsProperties)

ResourceRestoreParameters (Параметры восстановления)

ПространственнаяСпецификация

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

SqlContainerResourceOrSqlContainerGetPropertiesResource

Уникальный ключ

Политика UniqueKeyPolicy

ВекторВстраивание

Политика VectorEmbeddingPolicy

Векторный индекс

Примеры использования

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

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

Шаблон	Описание
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.

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2026-04-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
        dataMaskingPolicy = {
          excludedPaths = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              length = int
              path = "string"
              startPosition = int
              strategy = "string"
            }
          ]
          isPolicyEnabled = bool
        }
        defaultTtl = int
        fullTextPolicy = {
          defaultLanguage = "string"
          fullTextPaths = [
            {
              language = "string"
              path = "string"
            }
          ]
        }
        id = "string"
        indexingPolicy = {
          automatic = bool
          compositeIndexes = [
            [
              {
                order = "string"
                path = "string"
              }
            ]
          ]
          excludedPaths = [
            {
              path = "string"
            }
          ]
          fullTextIndexes = [
            {
              path = "string"
            }
          ]
          includedPaths = [
            {
              indexes = [
                {
                  dataType = "string"
                  kind = "string"
                  precision = int
                }
              ]
              path = "string"
            }
          ]
          indexingMode = "string"
          spatialIndexes = [
            {
              path = "string"
              types = [
                "string"
              ]
            }
          ]
          vectorIndexes = [
            {
              indexingSearchListSize = int
              path = "string"
              quantizationByteSize = int
              type = "string"
              vectorIndexShardKey = [
                "string"
              ]
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
          throughputBucketForBuild = int
        }
        materializedViews = [
          {
            id = "string"
            _rid = "string"
          }
        ]
        materializedViewsProperties = {
          throughputBucketForBuild = int
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
        vectorEmbeddingPolicy = {
          vectorEmbeddings = [
            {
              dataType = "string"
              dimensions = int
              distanceFunction = "string"
              path = "string"
            }
          ]
        }
      }
    }
  }
}

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

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/container

ARMResourcePropertiesTags

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

ClientEncryptionIncludedPath

ClientEncryptionPolicy

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

ComputedProperty (ВычислительноеСвойство)

Политика разрешения конфликтов

ContainerPartitionKey (Ключ контейнераPartition)

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

Политика маскировки данных

DataMaskingPolicyExcludedPathsItem

DataMaskingPolicyIncludedPathsItem

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

FullTextIndexPath (Полный текстИндексPath)

FullTextPath (Полный текстPath)

FullTextPolicy

Включенныйpath

Индексы

Политика Индексации

Управляемая служебная идентичность

ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

MaterializedViewDefinition (МатериализованноеViewDefinition)

МатериализованныйВидДетали

MaterializedViewsProperties (МатериализованныеViewsProperties)

ResourceRestoreParameters (Параметры восстановления)

ПространственнаяСпецификация

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

SqlContainerResourceOrSqlContainerGetPropertiesResource

Уникальный ключ

Политика UniqueKeyPolicy

ВекторВстраивание

Политика VectorEmbeddingPolicy

Векторный индекс

Примеры использования

Примеры Terraform

Простой пример развертывания контейнера SQL в учетной записи Cosmos DB.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "BoundedStaleness"
        maxIntervalInSeconds    = 10
        maxStalenessPrefix      = 200
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "sqlDatabase" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
        throughput = 400
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "container" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2023-04-15"
  parent_id = azapi_resource.sqlDatabase.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = "test-containerWest Europe"
        partitionKey = {
          kind = "Hash"
          paths = [
            "/definition",
          ]
        }
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}