你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2021-05-15

• 最新
• 2024-12-01-preview
• 2024-11-15
• 2024-09-01-preview
• 2024-08-15
• 2024-05-15
• 2024-05-15-preview
• 2024-02-15-preview
• 2023-11-15
• 2023-11-15-preview
• 2023-09-15
• 2023-09-15-preview
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 2022-11-15-preview
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 2022-02-15-preview
• 2021-11-15-preview
• 2021-10-15
• 2021-10-15-preview
• 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
• 2019-08-01

Bicep 资源定义

可以使用目标操作部署 databaseAccounts/sqlDatabases/containers 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-05-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'
  }
}

属性值

AutoscaleSettings

名字	描述	价值
maxThroughput	表示最大吞吐量，资源可以纵向扩展。	int

CompositePath

名字	描述	价值
次序	复合路径的排序顺序。	“ascending” “descending”
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串

ConflictResolutionPolicy

名字	描述	价值
conflictResolutionPath	LastWriterWins 模式下的冲突解决路径。	字符串
conflictResolutionProcedure	解决自定义模式冲突的过程。	字符串
模式	指示冲突解决模式。	“Custom” “LastWriterWins”

ContainerPartitionKey

名字	描述	价值
类	指示用于分区的算法类型。 对于 MultiHash，容器创建支持多个分区键（最多三个最大值）	“Hash” “MultiHash” “Range”
路径	使用容器中的数据可以分区的路径列表	string[]
版本	指示分区键定义的版本	int 约束： 最小值 = 1 最大值 = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

名字	描述	价值
autoscaleSettings	指定自动缩放设置。	AutoscaleSettings
吞吐量	每秒请求单位数。 例如，“throughput”：10000。	int

ExcludedPath

名字	描述	价值
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串

IncludedPath

名字	描述	价值
指标	此路径的索引列表	索引[]
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串

指标

名字	描述	价值
dataType	为其应用索引行为的数据类型。	“LineString” “MultiPolygon” “Number” “Point” “Polygon” “String”
类	指示索引的类型。	“Hash” “Range” “Spatial”
精度	索引的精度。 -1 是最大精度。	int

IndexingPolicy

名字	描述	价值
自动	指示索引策略是否自动	bool
compositeIndexes	复合路径列表列表	CompositePath[][]
excludedPaths	要从索引中排除的路径列表	ExcludedPath[]
includedPaths	要包含在索引中的路径列表	IncludedPath[]
indexingMode	指示索引模式。	“一致” “懒惰” “none”
spatialIndexes	空间细节列表	SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

名字	描述	价值
位置	资源所属的资源组的位置。	字符串
名字	资源名称	string （必需）
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：databaseAccounts/sqlDatabases
性能	用于创建和更新 Azure Cosmos DB 容器的属性。	SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties（必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记

SpatialSpec

名字	描述	价值
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串
类型	路径的空间类型列表	包含任一项的字符串数组： “LineString” “MultiPolygon” “Point” “Polygon”

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

名字	描述	价值
选项	要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。	CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
资源	容器的标准 JSON 格式	SqlContainerResourceOrSqlContainerGetPropertiesResource（必需）

SqlContainerResourceOrSqlContainerGetPropertiesResource

名字	描述	价值
分析StorageTtl	分析 TTL。	int
conflictResolutionPolicy	容器的冲突解决策略。	ConflictResolutionPolicy
defaultTtl	默认生存时间	int
id	Cosmos DB SQL 容器的名称	string （必需）
indexingPolicy	索引策略的配置。 默认情况下，容器中所有文档路径的索引都是自动的	IndexingPolicy
partitionKey	要用于将数据分区到多个分区的分区键的配置	ContainerPartitionKey
uniqueKeyPolicy	用于在 Azure Cosmos DB 服务中的集合中指定文档的唯一性约束的唯一键策略配置。	UniqueKeyPolicy

标签

名字	描述	价值

UniqueKey

名字	描述	价值
路径	路径列表对于 Azure Cosmos DB 服务中的每个文档必须是唯一的	string[]

UniqueKeyPolicy

名字	描述	价值
uniqueKeys	在 Azure Cosmos DB 服务中对集合中的文档强制实施唯一性约束的唯一键列表。	UniqueKey[]

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
使用分析存储 Azure Cosmos DB 帐户 SQL API	此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，其中包含配置了分析存储的数据库和容器。
创建免费层 Azure Cosmos DB 帐户	此模板使用具有共享吞吐量和容器的数据库为 SQL API 创建免费层 Azure Cosmos DB 帐户。
为 Core （SQL） API 创建 Azure Cosmos DB 帐户	此模板创建一个 Azure Cosmos 帐户，用于 Core （SQL） API，其中包含具有多个其他选项的吞吐量的数据库和容器。
使用自动缩放 创建 Azure Cosmos DB 帐户 SQL API	此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，该帐户包含具有多个其他选项的自动缩放吞吐量的数据库和容器。
创建 Azure Cosmos DB Core （SQL） API 存储过程	此模板创建一个用于 Core （SQL） API 的 Azure Cosmos DB 帐户，以及一个包含存储过程、触发器和用户定义的函数的容器。
使用容器应用创建 Dapr 微服务应用	使用容器应用创建 Dapr 微服务应用。
使用容器应用创建 Dapr pub-sub servicebus 应用	使用容器应用创建 Dapr pub-sub servicebus 应用。
使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB	使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB。

ARM 模板资源定义

可以使用目标操作部署 databaseAccounts/sqlDatabases/containers 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers",
  "apiVersion": "2021-05-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"
  }
}

属性值

AutoscaleSettings

名字	描述	价值
maxThroughput	表示最大吞吐量，资源可以纵向扩展。	int

CompositePath

名字	描述	价值
次序	复合路径的排序顺序。	“ascending” “descending”
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串

ConflictResolutionPolicy

名字	描述	价值
conflictResolutionPath	LastWriterWins 模式下的冲突解决路径。	字符串
conflictResolutionProcedure	解决自定义模式冲突的过程。	字符串
模式	指示冲突解决模式。	“Custom” “LastWriterWins”

ContainerPartitionKey

名字	描述	价值
类	指示用于分区的算法类型。 对于 MultiHash，容器创建支持多个分区键（最多三个最大值）	“Hash” “MultiHash” “Range”
路径	使用容器中的数据可以分区的路径列表	string[]
版本	指示分区键定义的版本	int 约束： 最小值 = 1 最大值 = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

名字	描述	价值
autoscaleSettings	指定自动缩放设置。	AutoscaleSettings
吞吐量	每秒请求单位数。 例如，“throughput”：10000。	int

ExcludedPath

名字	描述	价值
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串

IncludedPath

名字	描述	价值
指标	此路径的索引列表	索引[]
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串

指标

名字	描述	价值
dataType	为其应用索引行为的数据类型。	“LineString” “MultiPolygon” “Number” “Point” “Polygon” “String”
类	指示索引的类型。	“Hash” “Range” “Spatial”
精度	索引的精度。 -1 是最大精度。	int

IndexingPolicy

名字	描述	价值
自动	指示索引策略是否自动	bool
compositeIndexes	复合路径列表列表	CompositePath[][]
excludedPaths	要从索引中排除的路径列表	ExcludedPath[]
includedPaths	要包含在索引中的路径列表	IncludedPath[]
indexingMode	指示索引模式。	“一致” “懒惰” “none”
spatialIndexes	空间细节列表	SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

名字	描述	价值
apiVersion	API 版本	'2021-05-15'
位置	资源所属的资源组的位置。	字符串
名字	资源名称	string （必需）
性能	用于创建和更新 Azure Cosmos DB 容器的属性。	SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties（必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers”

SpatialSpec

名字	描述	价值
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串
类型	路径的空间类型列表	包含任一项的字符串数组： “LineString” “MultiPolygon” “Point” “Polygon”

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

名字	描述	价值
选项	要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。	CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
资源	容器的标准 JSON 格式	SqlContainerResourceOrSqlContainerGetPropertiesResource（必需）

SqlContainerResourceOrSqlContainerGetPropertiesResource

名字	描述	价值
分析StorageTtl	分析 TTL。	int
conflictResolutionPolicy	容器的冲突解决策略。	ConflictResolutionPolicy
defaultTtl	默认生存时间	int
id	Cosmos DB SQL 容器的名称	string （必需）
indexingPolicy	索引策略的配置。 默认情况下，容器中所有文档路径的索引都是自动的	IndexingPolicy
partitionKey	要用于将数据分区到多个分区的分区键的配置	ContainerPartitionKey
uniqueKeyPolicy	用于在 Azure Cosmos DB 服务中的集合中指定文档的唯一性约束的唯一键策略配置。	UniqueKeyPolicy

标签

名字	描述	价值

UniqueKey

名字	描述	价值
路径	路径列表对于 Azure Cosmos DB 服务中的每个文档必须是唯一的	string[]

UniqueKeyPolicy

名字	描述	价值
uniqueKeys	在 Azure Cosmos DB 服务中对集合中的文档强制实施唯一性约束的唯一键列表。	UniqueKey[]

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
使用分析存储 Azure Cosmos DB 帐户 SQL API	此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，其中包含配置了分析存储的数据库和容器。
创建免费层 Azure Cosmos DB 帐户	此模板使用具有共享吞吐量和容器的数据库为 SQL API 创建免费层 Azure Cosmos DB 帐户。
为 Core （SQL） API 创建 Azure Cosmos DB 帐户	此模板创建一个 Azure Cosmos 帐户，用于 Core （SQL） API，其中包含具有多个其他选项的吞吐量的数据库和容器。
使用自动缩放 创建 Azure Cosmos DB 帐户 SQL API	此模板为 Core （SQL） API 创建一个 Azure Cosmos 帐户，该帐户包含具有多个其他选项的自动缩放吞吐量的数据库和容器。
创建 Azure Cosmos DB Core （SQL） API 存储过程	此模板创建一个用于 Core （SQL） API 的 Azure Cosmos DB 帐户，以及一个包含存储过程、触发器和用户定义的函数的容器。
使用容器应用创建 Dapr 微服务应用	使用容器应用创建 Dapr 微服务应用。
使用容器应用创建 Dapr pub-sub servicebus 应用	使用容器应用创建 Dapr pub-sub servicebus 应用。
使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB	使用 Cosmos DB 连接部署 Azure 数据资源管理器 DB。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 databaseAccounts/sqlDatabases/containers 资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-05-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"
              ]
            }
          ]
        }
      }
    }
  })
}

属性值

AutoscaleSettings

名字	描述	价值
maxThroughput	表示最大吞吐量，资源可以纵向扩展。	int

CompositePath

名字	描述	价值
次序	复合路径的排序顺序。	“ascending” “descending”
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串

ConflictResolutionPolicy

名字	描述	价值
conflictResolutionPath	LastWriterWins 模式下的冲突解决路径。	字符串
conflictResolutionProcedure	解决自定义模式冲突的过程。	字符串
模式	指示冲突解决模式。	“Custom” “LastWriterWins”

ContainerPartitionKey

名字	描述	价值
类	指示用于分区的算法类型。 对于 MultiHash，容器创建支持多个分区键（最多三个最大值）	“Hash” “MultiHash” “Range”
路径	使用容器中的数据可以分区的路径列表	string[]
版本	指示分区键定义的版本	int 约束： 最小值 = 1 最大值 = 2

CreateUpdateOptionsOrSqlContainerGetPropertiesOptions

名字	描述	价值
autoscaleSettings	指定自动缩放设置。	AutoscaleSettings
吞吐量	每秒请求单位数。 例如，“throughput”：10000。	int

ExcludedPath

名字	描述	价值
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串

IncludedPath

名字	描述	价值
指标	此路径的索引列表	索引[]
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串

指标

名字	描述	价值
dataType	为其应用索引行为的数据类型。	“LineString” “MultiPolygon” “Number” “Point” “Polygon” “String”
类	指示索引的类型。	“Hash” “Range” “Spatial”
精度	索引的精度。 -1 是最大精度。	int

IndexingPolicy

名字	描述	价值
自动	指示索引策略是否自动	bool
compositeIndexes	复合路径列表列表	CompositePath[][]
excludedPaths	要从索引中排除的路径列表	ExcludedPath[]
includedPaths	要包含在索引中的路径列表	IncludedPath[]
indexingMode	指示索引模式。	“一致” “懒惰” “none”
spatialIndexes	空间细节列表	SpatialSpec[]

Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers

名字	描述	价值
位置	资源所属的资源组的位置。	字符串
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：databaseAccounts/sqlDatabases
性能	用于创建和更新 Azure Cosmos DB 容器的属性。	SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties（必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2021-05-15”

SpatialSpec

名字	描述	价值
路径	索引行为应用于的路径。 索引路径通常以根开头，以通配符结尾（/path/*）	字符串
类型	路径的空间类型列表	包含任一项的字符串数组： “LineString” “MultiPolygon” “Point” “Polygon”

SqlContainerCreateUpdatePropertiesOrSqlContainerGetProperties

名字	描述	价值
选项	要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。	CreateUpdateOptionsOrSqlContainerGetPropertiesOptions
资源	容器的标准 JSON 格式	SqlContainerResourceOrSqlContainerGetPropertiesResource（必需）

SqlContainerResourceOrSqlContainerGetPropertiesResource

名字	描述	价值
分析StorageTtl	分析 TTL。	int
conflictResolutionPolicy	容器的冲突解决策略。	ConflictResolutionPolicy
defaultTtl	默认生存时间	int
id	Cosmos DB SQL 容器的名称	string （必需）
indexingPolicy	索引策略的配置。 默认情况下，容器中所有文档路径的索引都是自动的	IndexingPolicy
partitionKey	要用于将数据分区到多个分区的分区键的配置	ContainerPartitionKey
uniqueKeyPolicy	用于在 Azure Cosmos DB 服务中的集合中指定文档的唯一性约束的唯一键策略配置。	UniqueKeyPolicy

标签

名字	描述	价值

UniqueKey

名字	描述	价值
路径	路径列表对于 Azure Cosmos DB 服务中的每个文档必须是唯一的	string[]

UniqueKeyPolicy

名字	描述	价值
uniqueKeys	在 Azure Cosmos DB 服务中对集合中的文档强制实施唯一性约束的唯一键列表。	UniqueKey[]