通过

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

Microsoft.DocumentDB databaseAccounts/apis/databases/containers 2015-04-01

  • 项目

Bicep 资源定义

databaseAccounts/apis/databases/containers 资源类型可以使用以下目标操作进行部署：

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-04-01' = {
  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 中为子资源设置名称和类型。		 字符串 (必需)
父级 (parent) 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源之外的子资源。		 类型为“数据库”的资源的符号名称
properties 用于创建和更新 Azure Cosmos DB 容器的属性。 SqlContainerCreateUpdatePropertiesOrSqlContainerProp... 所需的 ()

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

名称 说明 Value
options 要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions (必需的)
resource 容器的标准 JSON 格式 需要 sqlContainerResource ()

CreateUpdateOptions

名称 说明 值
{customized property} 字符串

SqlContainerResource

名称 说明 值
conflictResolutionPolicy 容器的冲突解决策略。 ConflictResolutionPolicy
defaultTtl 默认生存时间 int
id Cosmos DB SQL 容器的名称 字符串 (必需)
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

名称 说明 Value
path 索引行为应用于的路径。 索引路径通常以 root 开头，以通配符 (/path/*) 字符串

IncludedPath

名称 说明 值
索引 此路径的索引列表 Indexes[]
path 索引行为应用于的路径。 索引路径通常以 root 开头，以通配符 (/path/*) 字符串

索引

名称 说明 值
dataType 对其应用索引行为的数据类型。 “LineString”
“MultiPolygon”
“Number”
“Point”
“Polygon”
“String”
kind 指示索引的类型。 “Hash”
“Range”
“空间”
精准率 索引的精度。 -1 是最大精度。 int

ContainerPartitionKey

名称 说明 值
kind 指示用于分区的算法类型 “Hash”
“Range”
路径 使用容器内可分区数据的路径列表 string[]

UniqueKeyPolicy

名称 说明 值
uniqueKeys 对 Azure Cosmos DB 服务集合中的文档强制实施唯一性约束的唯一键列表。 UniqueKey[]

UniqueKey

名称 说明 值
路径 对于 Azure Cosmos DB 服务中的每个文档，路径列表必须是唯一的 string[]

快速入门模板

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

模板 说明
使用 SQL API 和多个容器创建 Azure Cosmos

部署到 Azure		 该模板使用 SQL API 创建 Cosmos 容器，并允许添加多个容器。

ARM 模板资源定义

databaseAccounts/apis/databases/containers 资源类型可以使用以下目标操作进行部署：

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

资源格式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/containers",
  "apiVersion": "2015-04-01",
  "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

名称 说明 Value
type 资源类型 'Microsoft.DocumentDB/databaseAccounts/apis/databases/containers'
apiVersion 资源 API 版本 '2015-04-01'
name 资源名称

了解如何在 JSON ARM 模板中为子资源设置名称和类型。		 字符串 (必需)
properties 用于创建和更新 Azure Cosmos DB 容器的属性。 SqlContainerCreateUpdatePropertiesOrSqlContainerProp... 所需的 ()

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

名称 说明 Value
options 要应用于请求的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions (必需)
resource 容器的标准 JSON 格式 需要 SqlContainerResource ()

CreateUpdateOptions

名称 说明 值
{customized property} 字符串

SqlContainerResource

名称 说明 值
conflictResolutionPolicy 容器的冲突解决策略。 ConflictResolutionPolicy
defaultTtl 默认生存时间 int
id Cosmos DB SQL 容器的名称 字符串 (必需)
indexingPolicy 索引策略的配置。 默认情况下，为容器中的所有文档路径自动编制索引 IndexingPolicy
partitionKey 用于将数据分区到多个分区的分区键的配置 ContainerPartitionKey
uniqueKeyPolicy 用于指定 Azure Cosmos DB 服务集合中文档的唯一性约束的唯一键策略配置。 UniqueKeyPolicy

ConflictResolutionPolicy

名称 说明 值
conflictResolutionPath 在 LastWriterWins 模式下的冲突解决路径。 字符串
conflictResolutionProcedure 在自定义模式下解决冲突的过程。 字符串
mode 指示冲突解决模式。 “Custom”
'LastWriterWins'

IndexingPolicy

名称 说明 值
automatic 指示索引策略是否为自动 bool
excludedPaths 要从索引中排除的路径列表 ExcludedPath[]
includedPaths 要包含在索引中的路径列表 IncludedPath[]
indexingMode 指示索引模式。 '一致'
'Lazy'
“None”

ExcludedPath

名称 说明 Value
path 索引行为适用的路径。 索引路径通常以根开头，以通配符 (/path/*) 字符串

IncludedPath

名称 说明 值
索引 此路径的索引列表 Indexes[]
path 索引行为适用的路径。 索引路径通常以根开头，以通配符 (/path/*) 字符串

索引

名称 说明 值
dataType 对其应用索引行为的数据类型。 'LineString'
“MultiPolygon”
“Number”
“Point”
“Polygon”
“String”
kind 指示索引的类型。 “Hash”
“Range”
“空间”
精准率 索引的精度。 -1 是最大精度。 int

ContainerPartitionKey

名称 说明 值
kind 指示用于分区的算法类型 “Hash”
“Range”
路径 使用容器内可分区数据的路径列表 string[]

UniqueKeyPolicy

名称 说明 值
uniqueKeys 对 Azure Cosmos DB 服务集合中的文档强制实施唯一性约束的唯一键列表。 UniqueKey[]

UniqueKey

名称 说明 值
路径 对于 Azure Cosmos DB 服务中的每个文档，路径列表必须是唯一的 string[]

快速入门模板

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

模板 说明
使用 SQL API 和多个容器创建 Azure Cosmos

部署到 Azure		 该模板使用 SQL API 创建 Cosmos 容器，并允许添加多个容器。

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@2015-04-01"
  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

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/databaseAccounts/apis/databases/containers@2015-04-01”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源 ID。 类型为“数据库”的资源的 ID
properties 用于创建和更新 Azure Cosmos DB 容器的属性。 SqlContainerCreateUpdatePropertiesOrSqlContainerProp... 所需的 ()

SqlContainerCreateUpdatePropertiesOrSqlContainerProp...

名称 说明 Value
options 要为请求应用的选项的键值对。 这对应于随请求一起发送的标头。 CreateUpdateOptions (必需的)
resource 容器的标准 JSON 格式 需要 sqlContainerResource ()

CreateUpdateOptions

名称 说明 值
{customized property} 字符串

SqlContainerResource

名称 说明 值
conflictResolutionPolicy 容器的冲突解决策略。 ConflictResolutionPolicy
defaultTtl 默认生存时间 int
id Cosmos DB SQL 容器的名称 字符串 (必需)
indexingPolicy 索引策略的配置。 默认情况下，为容器中的所有文档路径自动编制索引 IndexingPolicy
partitionKey 用于将数据分区到多个分区的分区键的配置 ContainerPartitionKey
uniqueKeyPolicy 用于指定 Azure Cosmos DB 服务集合中文档的唯一性约束的唯一键策略配置。 UniqueKeyPolicy

ConflictResolutionPolicy

名称 说明 值
conflictResolutionPath 在 LastWriterWins 模式下的冲突解决路径。 字符串
conflictResolutionProcedure 在自定义模式下解决冲突的过程。 字符串
mode 指示冲突解决模式。 “Custom”
“LastWriterWins”

IndexingPolicy

名称 说明 值
automatic 指示索引策略是否为自动 bool
excludedPaths 要从索引中排除的路径列表 ExcludedPath[]
includedPaths 要包含在索引中的路径列表 IncludedPath[]
indexingMode 指示索引模式。 “一致”
“Lazy”
"None"

ExcludedPath

名称 说明 Value
path 索引行为适用的路径。 索引路径通常以根开头，以通配符 (/path/*) 字符串

IncludedPath

名称 说明 值
索引 此路径的索引列表 Indexes[]
path 索引行为适用的路径。 索引路径通常以根开头，以通配符 (/path/*) 字符串

索引

名称 说明 值
dataType 对其应用索引行为的数据类型。 “LineString”
“MultiPolygon”
“Number”
“Point”
“Polygon”
“String”
kind 指示索引的类型。 “Hash”
“Range”
“空间”
精准率 索引的精度。 -1 是最大精度。 int

ContainerPartitionKey

名称 说明 值
kind 指示用于分区的算法类型 “Hash”
“Range”
路径 使用可对容器中的数据进行分区的路径列表 string[]

UniqueKeyPolicy

名称 说明 值
uniqueKeys 上的唯一键列表，用于对 Azure Cosmos DB 服务中的集合中的文档强制实施唯一性约束。 UniqueKey[]

UniqueKey

名称 说明 值
路径 对于 Azure Cosmos DB 服务中的每个文档，路径列表必须是唯一的 string[]