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

Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2024-02-15-preview

• 最新
• 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 年 3 月 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@2024-02-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  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'
      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'
            ]
          }
        ]
      }
      materializedViewDefinition: {
        definition: 'string'
        sourceCollectionId: 'string'
      }
      partitionKey: {
        kind: 'string'
        paths: [
          'string'
        ]
        version: int
      }
      restoreParameters: {
        restoreSource: 'string'
        restoreTimestampInUtc: 'string'
        restoreWithTtlDisabled: bool
      }
      uniqueKeyPolicy: {
        uniqueKeys: [
          {
            paths: [
              'string'
            ]
          }
        ]
      }
    }
  }
}

属性值

databaseAccounts/sqlDatabases/containers

名称	说明	值
name	资源名称 了解如何在 Bicep 中为子资源设置名称和类型。	字符串 (必需)
location	资源所属的资源组的位置。	字符串
标记	标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为一个资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。	标记名称和值的字典。 请参阅 模板中的标记
父级 (parent)	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。	类型为的资源的符号名称： sqlDatabases
标识	资源的标识。	ManagedServiceIdentity
properties	用于创建和更新 Azure Cosmos DB 容器的属性。	SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... 所需的 ()

ManagedServiceIdentity

名称	说明	Value
type	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	与资源关联的用户标识列表。 用户标识字典密钥引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名称	说明	值
{customized property}		Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

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

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

名称	说明	值
autoscaleSettings	指定自动缩放设置。 注意：需要吞吐量或 autoscaleSettings，但不能同时满足这两项要求。	AutoscaleSettings
throughput	每秒请求单位数。 例如，“throughput”：10000。	int

AutoscaleSettings

名称	说明	值
maxThroughput	表示资源可以纵向扩展到的最大吞吐量。	int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

名称	说明	值
analysisStorageTtl	分析 TTL。	int
clientEncryptionPolicy	容器的客户端加密策略。	ClientEncryptionPolicy
computedProperties	计算属性列表	ComputedProperty[]
conflictResolutionPolicy	容器的冲突解决策略。	ConflictResolutionPolicy
createMode	用于指示资源创建模式的枚举。	'Default' “PointInTimeRestore” “还原”
defaultTtl	默认生存时间	int
id	Cosmos DB SQL 容器的名称	字符串 (必需)
indexingPolicy	索引策略的配置。 默认情况下，为容器中的所有文档路径自动编制索引	IndexingPolicy
materializedViewDefinition	用于定义具体化视图的配置。 必须仅指定用于创建具体化视图容器。	MaterializedViewDefinition
partitionKey	用于将数据分区到多个分区的分区键的配置	ContainerPartitionKey
restoreParameters	用于指示有关还原的信息的参数	ResourceRestoreParameters
uniqueKeyPolicy	用于指定 Azure Cosmos DB 服务集合中文档的唯一性约束的唯一键策略配置。	UniqueKeyPolicy

ClientEncryptionPolicy

名称	说明	值
includedPaths	需要加密以及路径特定设置的项的路径。	ClientEncryptionIncludedPath[] (必需的)
policyFormatVersion	客户端加密策略定义的版本。 支持的版本为 1 和 2。 版本 2 支持 ID 和分区键路径加密。	int (必需) 约束： 最小值 = 1 最大值 = 2

ClientEncryptionIncludedPath

名称	说明	值
clientEncryptionKeyId	用于加密路径的客户端加密密钥的标识符。	字符串 (必需)
encryptionAlgorithm	将使用的加密算法。 例如 - AEAD_AES_256_CBC_HMAC_SHA256。	字符串 (必需)
encryptionType	要执行的加密类型。 例如 - 确定性、随机化。	字符串 (必需)
path	需要加密的路径。	字符串 (必需)

ComputedProperty

名称	说明	值
name	计算属性的名称，例如 “cp_lowerName”	字符串
query	计算属性的值的查询，例如 -“SELECT VALUE LOWER (c.name) FROM c”	字符串

ConflictResolutionPolicy

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

IndexingPolicy

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

CompositePath

名称	说明	值
顺序	复合路径的排序顺序。	“ascending” “降序”
path	索引行为应用于的路径。 索引路径通常以 root 开头，以通配符 (/path/*)	字符串

ExcludedPath

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

IncludedPath

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

索引

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

SpatialSpec

名称	说明	Value
path	索引行为应用于的路径。 索引路径通常以 root 开头，以通配符 (/path/*)	字符串
types	路径的空间类型列表	包含任意项的字符串数组： “LineString” “MultiPolygon” “Point” “Polygon”

MaterializedViewDefinition

名称	说明	值
定义	定义应该是一个 SQL 查询，用于从源容器中提取数据，以填充到 Materialized View 容器中。	字符串 (必需)
sourceCollectionId	将创建具体化视图的源容器的名称。	字符串 (必需)

ContainerPartitionKey

名称	说明	值
kind	指示用于分区的算法类型。 对于 MultiHash，容器创建支持多个分区键 (最多三个)	“Hash” “MultiHash” “Range”
路径	使用容器内可分区数据的路径列表	string[]
版本	指示分区键定义的版本	int 约束： 最小值 = 1 最大值 = 2

ResourceRestoreParameters

名称	说明	值
restoreSource	必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	字符串
restoreTimestampInUtc	帐户必须还原到的时间 (ISO-8601 格式) 。	字符串
restoreWithTtlDisabled	指定还原成功后，还原的帐户是否禁用生存时间。	bool

UniqueKeyPolicy

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

UniqueKey

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

快速入门模板

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

模板	说明
创建免费层 Azure Cosmos DB 帐户	此模板为 SQL API 创建一个免费层 Azure Cosmos DB 帐户，其中包含具有共享吞吐量和容器的数据库。
为 Core (SQL) API 创建 Azure Cosmos DB 帐户	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含数据库和具有多个其他选项的吞吐量容器。
具有分析存储的 Azure Cosmos DB 帐户 SQL API	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含配置了分析存储的数据库和容器。
使用自动缩放创建 Azure Cosmos DB 帐户 SQL API	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含具有自动缩放吞吐量的数据库和容器以及多个其他选项。
创建 Azure Cosmos DB Core (SQL) API 存储过程	此模板为 Core (SQL) API 创建 Azure Cosmos DB 帐户，以及一个包含存储过程、触发器和用户定义的函数的容器。
使用 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": "2024-02-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "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",
      "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" ]
          }
        ]
      },
      "materializedViewDefinition": {
        "definition": "string",
        "sourceCollectionId": "string"
      },
      "partitionKey": {
        "kind": "string",
        "paths": [ "string" ],
        "version": "int"
      },
      "restoreParameters": {
        "restoreSource": "string",
        "restoreTimestampInUtc": "string",
        "restoreWithTtlDisabled": "bool"
      },
      "uniqueKeyPolicy": {
        "uniqueKeys": [
          {
            "paths": [ "string" ]
          }
        ]
      }
    }
  }
}

属性值

databaseAccounts/sqlDatabases/containers

名称	说明	Value
type	资源类型	'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers'
apiVersion	资源 API 版本	“2024-02-15-preview”
name	资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。	字符串 (必需)
location	资源所属的资源组的位置。	字符串
标记	标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。	标记名称和值的字典。 请参阅 模板中的标记
标识	资源的标识。	ManagedServiceIdentity
properties	用于创建和更新 Azure Cosmos DB 容器的属性。	SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... 所需的 ()

ManagedServiceIdentity

名称	说明	Value
type	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“None” “SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
userAssignedIdentities	与资源关联的用户标识列表。 用户标识字典键引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

名称	说明	值
{customized property}		Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

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

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

名称	说明	值
autoscaleSettings	指定自动缩放设置。 注意：需要吞吐量或 autoscaleSettings，但不能同时满足这两项要求。	AutoscaleSettings
throughput	每秒请求单位数。 例如，“throughput”：10000。	int

AutoscaleSettings

名称	说明	值
maxThroughput	表示资源可以纵向扩展到的最大吞吐量。	int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

名称	说明	值
analysisStorageTtl	分析 TTL。	int
clientEncryptionPolicy	容器的客户端加密策略。	ClientEncryptionPolicy
computedProperties	计算属性列表	ComputedProperty[]
conflictResolutionPolicy	容器的冲突解决策略。	ConflictResolutionPolicy
createMode	用于指示资源创建模式的枚举。	'Default' “PointInTimeRestore” “还原”
defaultTtl	默认生存时间	int
id	Cosmos DB SQL 容器的名称	字符串 (必需)
indexingPolicy	索引策略的配置。 默认情况下，对容器中的所有文档路径自动编制索引	IndexingPolicy
materializedViewDefinition	用于定义具体化视图的配置。 必须仅指定用于创建 Materialized View 容器。	MaterializedViewDefinition
partitionKey	用于将数据分区到多个分区的分区键的配置	ContainerPartitionKey
restoreParameters	指示有关还原的信息的参数	ResourceRestoreParameters
uniqueKeyPolicy	用于指定 Azure Cosmos DB 服务集合中文档的唯一性约束的唯一键策略配置。	UniqueKeyPolicy

ClientEncryptionPolicy

名称	说明	值
includedPaths	需要加密的项的路径以及特定于路径的设置。	ClientEncryptionIncludedPath[] (必需的)
policyFormatVersion	客户端加密策略定义的版本。 支持的版本为 1 和 2。 版本 2 支持 ID 和分区密钥路径加密。	int (必需) 约束： 最小值 = 1 最大值 = 2

ClientEncryptionIncludedPath

名称	说明	值
clientEncryptionKeyId	用于加密路径的客户端加密密钥的标识符。	字符串 (必需)
encryptionAlgorithm	将使用的加密算法。 例如 - AEAD_AES_256_CBC_HMAC_SHA256。	字符串 (必需)
encryptionType	要执行的加密类型。 例如 - 确定性、随机化。	字符串 (必需)
path	需要加密的路径。	字符串 (必需)

ComputedProperty

名称	说明	值
name	计算属性的名称，例如 “cp_lowerName”	字符串
query	计算属性的值的查询，例如 -“SELECT VALUE LOWER (c.name) FROM c”	字符串

ConflictResolutionPolicy

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

IndexingPolicy

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

CompositePath

名称	说明	值
顺序	复合路径的排序顺序。	“ascending” “降序”
path	索引行为应用于的路径。 索引路径通常以 root 开头，以通配符 (/path/*)	字符串

ExcludedPath

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

IncludedPath

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

索引

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

SpatialSpec

名称	说明	Value
path	索引行为应用于的路径。 索引路径通常以 root 开头，以通配符 (/path/*)	字符串
types	路径的空间类型列表	包含任意项的字符串数组： “LineString” “MultiPolygon” “Point” “Polygon”

MaterializedViewDefinition

名称	说明	值
定义	定义应该是一个 SQL 查询，用于从源容器中提取数据，以填充到 Materialized View 容器中。	字符串 (必需)
sourceCollectionId	将创建具体化视图的源容器的名称。	字符串 (必需)

ContainerPartitionKey

名称	说明	值
kind	指示用于分区的算法类型。 对于 MultiHash，容器创建支持多个分区键 (最多三个)	“Hash” “MultiHash” “Range”
路径	使用容器内可分区数据的路径列表	string[]
版本	指示分区键定义的版本	int 约束： 最小值 = 1 最大值 = 2

ResourceRestoreParameters

名称	说明	值
restoreSource	必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	字符串
restoreTimestampInUtc	帐户必须还原到的时间 (ISO-8601 格式) 。	字符串
restoreWithTtlDisabled	指定还原成功后，还原的帐户是否禁用生存时间。	bool

UniqueKeyPolicy

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

UniqueKey

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

快速入门模板

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

模板	说明
创建免费层 Azure Cosmos DB 帐户	此模板为 SQL API 创建一个免费层 Azure Cosmos DB 帐户，其中包含具有共享吞吐量和容器的数据库。
为 Core (SQL) API 创建 Azure Cosmos DB 帐户	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含数据库和具有多个其他选项的吞吐量容器。
具有分析存储的 Azure Cosmos DB 帐户 SQL API	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含配置了分析存储的数据库和容器。
使用自动缩放创建 Azure Cosmos DB 帐户 SQL API	此模板为 Core (SQL) API 创建 Azure Cosmos 帐户，其中包含具有自动缩放吞吐量的数据库和容器以及多个其他选项。
创建 Azure Cosmos DB Core (SQL) API 存储过程	此模板为 Core (SQL) API 创建 Azure Cosmos DB 帐户，并使用存储过程、触发器和用户定义的函数创建容器。
使用 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@2024-02-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    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"
        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"
              ]
            }
          ]
        }
        materializedViewDefinition = {
          definition = "string"
          sourceCollectionId = "string"
        }
        partitionKey = {
          kind = "string"
          paths = [
            "string"
          ]
          version = int
        }
        restoreParameters = {
          restoreSource = "string"
          restoreTimestampInUtc = "string"
          restoreWithTtlDisabled = bool
        }
        uniqueKeyPolicy = {
          uniqueKeys = [
            {
              paths = [
                "string"
              ]
            }
          ]
        }
      }
    }
  })
}

属性值

databaseAccounts/sqlDatabases/containers

名称	说明	Value
type	资源类型	“Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2024-02-15-preview”
name	资源名称	字符串 (必需)
location	资源所属的资源组的位置。	字符串
parent_id	此资源的父资源 ID。	类型为：sqlDatabases 的资源的 ID
标记	标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为一个资源提供 15 个标记。 每个标记的键不能超过 128 个字符，值不能超过 256 个字符。 例如，模板类型的默认体验设置为“defaultExperience”：“Cassandra”。 当前的“defaultExperience”值还包括“Table”、“Graph”、“DocumentDB”和“MongoDB”。	标记名称和值的字典。
标识	资源的标识。	ManagedServiceIdentity
properties	用于创建和更新 Azure Cosmos DB 容器的属性。	SqlContainerCreateUpdatePropertiesOrSqlContainerGetP... 所需的 ()

ManagedServiceIdentity

名称	说明	Value
type	用于资源的标识类型。 类型“SystemAssigned，UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将从服务中删除任何标识。	“SystemAssigned” “SystemAssigned，UserAssigned” “UserAssigned”
identity_ids	与资源关联的用户标识列表。 用户标识字典键引用将是 ARM 资源 ID，格式为：“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。	用户标识 ID 的数组。

ManagedServiceIdentityUserAssignedIdentities

名称	说明	值
{customized property}		Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

此对象不包含部署期间要设置的任何属性。 所有属性均为 ReadOnly。

SqlContainerCreateUpdatePropertiesOrSqlContainerGetP...

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

CreateUpdateOptionsOrSqlContainerGetPropertiesOption...

名称	说明	值
autoscaleSettings	指定自动缩放设置。 注意：需要吞吐量或 autoscaleSettings，但不能同时满足这两项要求。	AutoscaleSettings
throughput	每秒请求单位数。 例如，“throughput”：10000。	int

AutoscaleSettings

名称	说明	值
maxThroughput	表示资源可以纵向扩展到的最大吞吐量。	int

SqlContainerResourceOrSqlContainerGetPropertiesResou...

名称	说明	值
analysisStorageTtl	分析 TTL。	int
clientEncryptionPolicy	容器的客户端加密策略。	ClientEncryptionPolicy
computedProperties	计算属性列表	ComputedProperty[]
conflictResolutionPolicy	容器的冲突解决策略。	ConflictResolutionPolicy
createMode	用于指示资源创建模式的枚举。	“Default” “PointInTimeRestore” “还原”
defaultTtl	默认生存时间	int
id	Cosmos DB SQL 容器的名称	字符串 (必需)
indexingPolicy	索引策略的配置。 默认情况下，为容器中的所有文档路径自动编制索引	IndexingPolicy
materializedViewDefinition	用于定义具体化视图的配置。 必须仅指定用于创建具体化视图容器。	MaterializedViewDefinition
partitionKey	用于将数据分区到多个分区的分区键的配置	ContainerPartitionKey
restoreParameters	用于指示有关还原的信息的参数	ResourceRestoreParameters
uniqueKeyPolicy	用于指定 Azure Cosmos DB 服务集合中文档的唯一性约束的唯一键策略配置。	UniqueKeyPolicy

ClientEncryptionPolicy

名称	说明	值
includedPaths	需要加密以及路径特定设置的项的路径。	ClientEncryptionIncludedPath[] (必需的)
policyFormatVersion	客户端加密策略定义的版本。 支持的版本为 1 和 2。 版本 2 支持 ID 和分区键路径加密。	int (必需) 约束： 最小值 = 1 最大值 = 2

ClientEncryptionIncludedPath

名称	说明	值
clientEncryptionKeyId	用于加密路径的客户端加密密钥的标识符。	字符串 (必需)
encryptionAlgorithm	将使用的加密算法。 例如 - AEAD_AES_256_CBC_HMAC_SHA256。	字符串 (必需)
encryptionType	要执行的加密类型。 例如 - 确定性、随机化。	字符串 (必需)
path	需要加密的路径。	字符串 (必需)

ComputedProperty

名称	说明	值
name	计算属性的名称，例如“cp_lowerName”	字符串
query	计算属性的值的查询，例如 -“SELECT VALUE LOWER (c.name) FROM c”	字符串

ConflictResolutionPolicy

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

IndexingPolicy

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

CompositePath

名称	说明	值
顺序	复合路径的排序顺序。	“ascending” “descending”
path	索引行为适用的路径。 索引路径通常以根开头，以通配符 (/path/*)	字符串

ExcludedPath

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

IncludedPath

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

索引

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

SpatialSpec

名称	说明	Value
path	索引行为适用的路径。 索引路径通常以根开头，以通配符 (/path/*)	字符串
types	路径的空间类型列表	包含任何一项的字符串数组： “LineString” “MultiPolygon” “Point” “Polygon”

MaterializedViewDefinition

名称	说明	值
定义	定义应该是一个 SQL 查询，用于从源容器中提取数据，以填充到具体化视图容器中。	字符串 (必需)
sourceCollectionId	将在其中创建具体化视图的源容器的名称。	字符串 (必需)

ContainerPartitionKey

名称	说明	值
kind	指示用于分区的算法类型。 对于 MultiHash，容器创建支持多个分区键 (最多三个)	“Hash” “MultiHash” “Range”
路径	使用可对容器中的数据进行分区的路径列表	string[]
版本	指示分区键定义的版本	int 约束： 最小值 = 1 最大值 = 2

ResourceRestoreParameters

名称	说明	值
restoreSource	必须从中启动还原的可还原数据库帐户的 ID。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName}	字符串
restoreTimestampInUtc	帐户必须还原到的时间 (ISO-8601 格式) 。	字符串
restoreWithTtlDisabled	指定在成功还原后，还原的帐户是否禁用生存时间。	bool

UniqueKeyPolicy

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

UniqueKey

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