你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.DocumentDB databaseAccounts/sqlDatabases/containers 2020-06-01-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@2020-06-01-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: {
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'
]
}
]
}
}
}
}
属性值
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 |
| throughput | 每秒请求单位数。 例如，“throughput”：10000。 | int |
AutoscaleSettings
| 名称 | 说明 | 值 |
|---|---|---|
| maxThroughput | 表示资源可以纵向扩展到的最大吞吐量。 | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 名称 | 说明 | 值 |
|---|---|---|
| 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 |
| 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” |
ContainerPartitionKey
| 名称 | 说明 | 值 |
|---|---|---|
| kind | 指示用于分区的算法类型 | “Hash” “Range” |
| 路径 | 使用容器内可分区数据的路径列表 | string[] |
| 版本 | 指示分区键定义的版本 | int 约束： 最小值 = 1 最大值 = 2 |
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": "2020-06-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"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" ]
}
]
}
}
}
}
属性值
databaseAccounts/sqlDatabases/containers
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | 'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers' |
| apiVersion | 资源 API 版本 | '2020-06-01-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 |
| throughput | 每秒请求单位数。 例如，“throughput”：10000。 | int |
AutoscaleSettings
| 名称 | 说明 | 值 |
|---|---|---|
| maxThroughput | 表示资源可纵向扩展的最大吞吐量。 | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 名称 | 说明 | 值 |
|---|---|---|
| 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 |
| compositeIndexes | 复合路径列表列表 | CompositePath[] |
| excludedPaths | 要从索引中排除的路径列表 | ExcludedPath[] |
| includedPaths | 要包含在索引中的路径列表 | IncludedPath[] |
| indexingMode | 指示索引模式。 | “一致” “迟缓” “None” |
| spatialIndexes | 空间细节列表 | SpatialSpec[] |
CompositePath
| 名称 | 说明 | 值 |
|---|---|---|
| 顺序 | 复合路径的排序顺序。 | “升序” “降序” |
| 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” |
ContainerPartitionKey
| 名称 | 说明 | 值 |
|---|---|---|
| kind | 指示用于分区的算法类型 | “Hash” “Range” |
| 路径 | 使用容器内可分区数据的路径列表 | string[] |
| 版本 | 指示分区键定义的版本 | int 约束： 最小值 = 1 最大值 = 2 |
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@2020-06-01-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 = {
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"
]
}
]
}
}
}
})
}
属性值
databaseAccounts/sqlDatabases/containers
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers@2020-06-01-preview” |
| name | 资源名称 | 字符串 (必需) |
| location | 资源所属的资源组的位置。 | 字符串 |
| parent_id | 此资源的父资源的 ID。 | 类型为 的资源的 ID： sqlDatabases |
| 标记 | 标记是描述资源的键值对的列表。 在查看此资源和为此资源分组（跨资源组）时，可以使用这些标记。 最多可以为资源提供 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 |
| throughput | 每秒请求单位数。 例如，“throughput”：10000。 | int |
AutoscaleSettings
| 名称 | 说明 | 值 |
|---|---|---|
| maxThroughput | 表示资源可以纵向扩展到的最大吞吐量。 | int |
SqlContainerResourceOrSqlContainerGetPropertiesResou...
| 名称 | 说明 | 值 |
|---|---|---|
| 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 |
| compositeIndexes | 复合路径列表列表 | CompositePath[] |
| excludedPaths | 要从索引中排除的路径列表 | ExcludedPath[] |
| includedPaths | 要包含在索引中的路径列表 | IncludedPath[] |
| indexingMode | 指示索引模式。 | “一致” “Lazy” "None" |
| spatialIndexes | 空间细节列表 | SpatialSpec[] |
CompositePath
| 名称 | 说明 | 值 |
|---|---|---|
| 顺序 | 复合路径的排序顺序。 | “升序” “降序” |
| 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” |
ContainerPartitionKey
| 名称 | 说明 | 值 |
|---|---|---|
| kind | 指示用于分区的算法类型 | “Hash” “Range” |
| 路径 | 使用容器内可分区数据的路径列表 | string[] |
| 版本 | 指示分区键定义的版本 | int 约束： 最小值 = 1 最大值 = 2 |
UniqueKeyPolicy
| 名称 | 说明 | 值 |
|---|---|---|
| uniqueKeys | 对 Azure Cosmos DB 服务集合中的文档强制实施唯一性约束的唯一键列表。 | UniqueKey[] |
UniqueKey
| 名称 | 说明 | 值 |
|---|---|---|
| 路径 | 对于 Azure Cosmos DB 服务中的每个文档，路径列表必须是唯一的 | string[] |