Microsoft.DocumentDB 資料庫Accounts/apis/databases/collections 2016-03-19

• 最新
• 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-19' = {
  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...

名稱	描述	值
選項	要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。	CreateUpdateOptions (必要)
資源	MongoDB 集合的標準 JSON 格式	MongoDBCollectionResource (必要)

CreateUpdateOptions

名稱	描述	值
{自定義屬性}		字串

MongoDBCollectionResource

名稱	描述	值
id	Cosmos DB MongoDB 集合的名稱	需要字串 ()
索引	索引鍵清單	MongoIndex[]
shardKey	要套用要求之分區索引鍵的索引鍵/值組。	ShardKeys

MongoIndex

名稱	描述	值
索引鍵	Cosmos DB MongoDB 集合索引鍵	MongoIndexKeys
選項	Cosmos DB MongoDB 集合索引鍵選項	MongoIndexOptions

MongoIndexKeys

名稱	描述	值
金鑰	Azure Cosmos DB 服務中每個 MongoDB 集合的密鑰清單	string[]

MongoIndexOptions

名稱	描述	值
expireAfterSeconds	在秒後到期	int
unique	是唯一或不是唯一的	bool

ShardKeys

名稱	描述	值
{自定義屬性}		字串

ARM 範本資源定義

databaseAccounts/apis/databases/collections 資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.DocumentDB/databaseAccounts/apis/databases/collections 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/collections",
  "apiVersion": "2016-03-19",
  "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

名稱	描述	值
類型	資源類型	'Microsoft.DocumentDB/databaseAccounts/apis/databases/collections'
apiVersion	資源 API 版本	'2016-03-19'
NAME	資源名稱 請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。	字串 (必要)
properties	用來建立及更新 Azure Cosmos DB MongoDB 集合的屬性。	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... 必要 ()

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

名稱	描述	值
選項	要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。	CreateUpdateOptions (必要)
資源	MongoDB 集合的標準 JSON 格式	需要 MongoDBCollectionResource ()

CreateUpdateOptions

名稱	描述	值
{自定義屬性}		字串

MongoDBCollectionResource

名稱	描述	值
id	Cosmos DB MongoDB 集合的名稱	字串 (必要)
索引	索引鍵清單	MongoIndex[]
shardKey	要套用要求之分區索引鍵的索引鍵/值組。	ShardKeys

MongoIndex

名稱	描述	值
索引鍵	Cosmos DB MongoDB 集合索引鍵	MongoIndexKeys
選項	Cosmos DB MongoDB 集合索引鍵選項	MongoIndexOptions

MongoIndexKeys

名稱	描述	值
金鑰	Azure Cosmos DB 服務中每個 MongoDB 集合的密鑰清單	string[]

MongoIndexOptions

名稱	描述	值
expireAfterSeconds	在秒後到期	int
unique	是唯一或不是唯一的	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@2016-03-19"
  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

名稱	描述	值
類型	資源類型	“Microsoft.DocumentDB/databaseAccounts/apis/databases/collections@2016-03-19”
NAME	資源名稱	字串 (必要)
parent_id	此資源之父系的資源標識碼。	類型資源的標識碼： 資料庫
properties	用來建立及更新 Azure Cosmos DB MongoDB 集合的屬性。	MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... 必要 ()

MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...

名稱	描述	值
選項	要套用要求之選項的索引鍵/值組。 這會對應至與要求一起傳送的標頭。	CreateUpdateOptions (必要)
資源	MongoDB 集合的標準 JSON 格式	需要 MongoDBCollectionResource ()

CreateUpdateOptions

名稱	描述	值
{自定義屬性}		字串

MongoDBCollectionResource

名稱	描述	值
id	Cosmos DB MongoDB 集合的名稱	字串 (必要)
索引	索引鍵清單	MongoIndex[]
shardKey	要套用要求之分區索引鍵的索引鍵/值組。	ShardKeys

MongoIndex

名稱	描述	值
索引鍵	Cosmos DB MongoDB 集合索引鍵	MongoIndexKeys
選項	Cosmos DB MongoDB 集合索引鍵選項	MongoIndexOptions

MongoIndexKeys

名稱	描述	值
金鑰	Azure Cosmos DB 服務中每個 MongoDB 集合的密鑰清單	string[]

MongoIndexOptions

名稱	描述	值
expireAfterSeconds	在秒後到期	int
unique	是唯一或不是唯一的	bool

ShardKeys

名稱	描述	值
{自定義屬性}		字串