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

Microsoft.DocumentDB databaseAccounts/apis/databases/collections

• 最新
• 2016-03-31
• 2016-03-19
• 2015-11-06
• 2015-04-08
• 2015-04-01

Bicep 资源定义

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

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

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

资源格式

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    options: {
      {customized property}: 'string'
    }
    resource: {
      id: 'string'
      indexes: [
        {
          key: {
            keys: [
              'string'
            ]
          }
          options: {
            expireAfterSeconds: int
            unique: bool
          }
        }
      ]
      shardKey: {
        {customized property}: 'string'
      }
    }
  }
}

属性值

databaseAccounts/apis/databases/collections

名称	说明	值
name	资源名称 了解如何在 Bicep 中为子资源设置名称和类型。	字符串 (必需)
父级 (parent)	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。	类型为“数据库”的资源的符号名称
properties	用于创建和更新 Azure Cosmos DB MongoDB 集合的属性。	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... 所需的 ()

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

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

MongoDBCollectionResource

名称	说明	Value
id	Cosmos DB MongoDB 集合的名称	字符串 (必需)
索引	索引键列表	MongoIndex[]
shardKey	要为请求应用的分片键的键值对。	ShardKeys

MongoIndex

名称	说明	值
键	Cosmos DB MongoDB 集合索引键	MongoIndexKeys
options	Cosmos DB MongoDB 集合索引键选项	MongoIndexOptions

MongoIndexKeys

名称	说明	值
密钥	Azure Cosmos DB 服务中每个 MongoDB 集合的密钥列表	string[]

MongoIndexOptions

名称	说明	值
expireAfterSeconds	秒后过期	int
unique	是否唯一	bool

ShardKeys

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

ARM 模板资源定义

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

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

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

资源格式

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections",
  "apiVersion": "2016-03-31",
  "name": "string",
  "properties": {
    "options": {
      "{customized property}": "string"
    },
    "resource": {
      "id": "string",
      "indexes": [
        {
          "key": {
            "keys": [ "string" ]
          },
          "options": {
            "expireAfterSeconds": "int",
            "unique": "bool"
          }
        }
      ],
      "shardKey": {
        "{customized property}": "string"
      }
    }
  }
}

属性值

databaseAccounts/apis/databases/collections

名称	说明	Value
type	资源类型	“Microsoft.DocumentDB/databaseAccounts/apis/databases/collections”
apiVersion	资源 API 版本	'2016-03-31'
name	资源名称 了解如何在 JSON ARM 模板中为子资源设置名称和类型。	字符串 (必需)
properties	用于创建和更新 Azure Cosmos DB MongoDB 集合的属性。	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... 所需的 ()

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

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

MongoDBCollectionResource

名称	说明	Value
id	Cosmos DB MongoDB 集合的名称	字符串 (必需)
索引	索引键列表	MongoIndex[]
shardKey	要为请求应用的分片键的键值对。	ShardKeys

MongoIndex

名称	说明	值
键	Cosmos DB MongoDB 集合索引键	MongoIndexKeys
options	Cosmos DB MongoDB 集合索引键选项	MongoIndexOptions

MongoIndexKeys

名称	说明	值
密钥	Azure Cosmos DB 服务中每个 MongoDB 集合的密钥列表	string[]

MongoIndexOptions

名称	说明	值
expireAfterSeconds	秒后过期	int
unique	是否唯一	bool

ShardKeys

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

Terraform (AzAPI 提供程序) 资源定义

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

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

属性值

databaseAccounts/apis/databases/collections

名称	说明	Value
type	资源类型	“Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-31”
name	资源名称	字符串 (必需)
parent_id	此资源的父资源的 ID。	类型为 的资源的 ID： 数据库
properties	用于创建和更新 Azure Cosmos DB MongoDB 集合的属性。	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... 所需的 ()

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

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

CreateUpdateOptions

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

MongoDBCollectionResource

名称	说明	Value
id	Cosmos DB MongoDB 集合的名称	字符串 (必需)
索引	索引键列表	MongoIndex[]
shardKey	要应用于请求的分片键的键值对。	ShardKeys

MongoIndex

名称	说明	值
键	Cosmos DB MongoDB 集合索引键	MongoIndexKeys
options	Cosmos DB MongoDB 集合索引键选项	MongoIndexOptions

MongoIndexKeys

名称	说明	值
密钥	Azure Cosmos DB 服务中每个 MongoDB 集合的密钥列表	string[]

MongoIndexOptions

名称	说明	值
expireAfterSeconds	数秒后过期	int
unique	是否唯一	bool

ShardKeys

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