通过

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

Microsoft.DocumentDB databaseAccounts/apis/databases/collections 2015-04-08

  • 项目

Bicep 资源定义

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

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

资源格式

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

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

属性值

CreateUpdateOptions

名字 描述 价值

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

名字 描述 价值
名字 资源名称 string （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：databaseAccounts/apis/databases
性能 用于创建和更新 Azure Cosmos DB MongoDB 集合的属性。 MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties（必需）

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

名字 描述 价值
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

名字 描述 价值

ARM 模板资源定义

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

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

资源格式

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

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

属性值

CreateUpdateOptions

名字 描述 价值

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

名字 描述 价值
apiVersion API 版本 '2015-04-08'
名字 资源名称 string （必需）
性能 用于创建和更新 Azure Cosmos DB MongoDB 集合的属性。 MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties（必需）
类型 资源类型 “Microsoft.DocumentDB/databaseAccounts/apis/databases/collections”

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

名字 描述 价值
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

名字 描述 价值

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@2015-04-08"
  name = "string"
  body = jsonencode({
    properties = {
      options = {
        {customized property} = "string"
      }
      resource = {
        id = "string"
        indexes = [
          {
            key = {
              keys = [
                "string"
              ]
            }
            options = {
              expireAfterSeconds = int
              unique = bool
            }
          }
        ]
        shardKey = {
          {customized property} = "string"
        }
      }
    }
  })
}

属性值

CreateUpdateOptions

名字 描述 价值

Microsoft.DocumentDB/databaseAccounts/apis/databases/collections

名字 描述 价值
名字 资源名称 string （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：databaseAccounts/apis/databases
性能 用于创建和更新 Azure Cosmos DB MongoDB 集合的属性。 MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties（必需）
类型 资源类型 “Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2015-04-08”

MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionProperties

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

MongoDBCollectionResource

名字 描述 价值
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

名字 描述 价值