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

Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2020-06-01-preview

• 最新
• 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/mongodbDatabases/collections 资源类型：

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

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-06-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      analyticalStorageTtl: int
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字	描述	价值

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

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

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

名字	描述	价值
分析StorageTtl	分析 TTL。	int
id	Cosmos DB MongoDB 集合的名称	string （必需）
指标	索引键列表	MongoIndex[]
shardKey	要为请求应用的分片键的键值对。	ShardKeys

MongoIndex

名字	描述	价值
钥匙	Cosmos DB MongoDB 集合索引键	MongoIndexKeys
选项	Cosmos DB MongoDB 集合索引键选项	MongoIndexOptions

MongoIndexKeys

名字	描述	价值
钥匙	Azure Cosmos DB 服务中每个 MongoDB 集合的密钥列表	string[]

MongoIndexOptions

名字	描述	价值
expireAfterSeconds	秒后过期	int
独特	唯一或不唯一	bool

ShardKeys

名字	描述	价值

标签

名字	描述	价值

快速入门示例

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

Bicep 文件	描述
为 MongoDB API 创建 Azure Cosmos 帐户	此模板使用具有两个集合的共享吞吐量和专用吞吐量，在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。
为 MongoDB API 自动缩放创建 Azure Cosmos 帐户	此模板使用共享和专用自动缩放吞吐量在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。

ARM 模板资源定义

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

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

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

资源格式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
  "apiVersion": "2020-06-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "analyticalStorageTtl": "int",
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字	描述	价值

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

名字	描述	价值
apiVersion	API 版本	'2020-06-01-preview'
身份	资源的标识。	ManagedServiceIdentity
位置	资源所属的资源组的位置。	字符串
名字	资源名称	string （必需）
性能	用于创建和更新 Azure Cosmos DB MongoDB 集合的属性。	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties（必需）
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections”

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

名字	描述	价值
分析StorageTtl	分析 TTL。	int
id	Cosmos DB MongoDB 集合的名称	string （必需）
指标	索引键列表	MongoIndex[]
shardKey	要为请求应用的分片键的键值对。	ShardKeys

MongoIndex

名字	描述	价值
钥匙	Cosmos DB MongoDB 集合索引键	MongoIndexKeys
选项	Cosmos DB MongoDB 集合索引键选项	MongoIndexOptions

MongoIndexKeys

名字	描述	价值
钥匙	Azure Cosmos DB 服务中每个 MongoDB 集合的密钥列表	string[]

MongoIndexOptions

名字	描述	价值
expireAfterSeconds	秒后过期	int
独特	唯一或不唯一	bool

ShardKeys

名字	描述	价值

标签

名字	描述	价值

快速入门模板

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

模板	描述
为 MongoDB API 创建 Azure Cosmos 帐户	此模板使用具有两个集合的共享吞吐量和专用吞吐量，在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。
为 MongoDB API 自动缩放创建 Azure Cosmos 帐户	此模板使用共享和专用自动缩放吞吐量在两个区域中为 MongoDB API 4.2 创建 Azure Cosmos DB 帐户。

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

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

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-06-01-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        analyticalStorageTtl = int
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

属性值

AutoscaleSettings

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

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

名字	描述	价值

CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions

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

ManagedServiceIdentity

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

ManagedServiceIdentityUserAssignedIdentities

名字	描述	价值

Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections

名字	描述	价值
身份	资源的标识。	ManagedServiceIdentity
位置	资源所属的资源组的位置。	字符串
名字	资源名称	string （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：databaseAccounts/mongodbDatabases
性能	用于创建和更新 Azure Cosmos DB MongoDB 集合的属性。	MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties（必需）
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-06-01-preview”

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties

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

MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource

名字	描述	价值
分析StorageTtl	分析 TTL。	int
id	Cosmos DB MongoDB 集合的名称	string （必需）
指标	索引键列表	MongoIndex[]
shardKey	要为请求应用的分片键的键值对。	ShardKeys

MongoIndex

名字	描述	价值
钥匙	Cosmos DB MongoDB 集合索引键	MongoIndexKeys
选项	Cosmos DB MongoDB 集合索引键选项	MongoIndexOptions

MongoIndexKeys

名字	描述	价值
钥匙	Azure Cosmos DB 服务中每个 MongoDB 集合的密钥列表	string[]

MongoIndexOptions

名字	描述	价值
expireAfterSeconds	秒后过期	int
独特	唯一或不唯一	bool

ShardKeys

名字	描述	价值

标签

名字	描述	价值