Microsoft.DocumentDB 資料庫Accounts/mongodbDatabases/collections 2020-03-01
- 最新
- 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-03-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
options: {
throughput: 'string'
}
resource: {
id: 'string'
indexes: [
{
key: {
keys: [
'string'
]
}
options: {
expireAfterSeconds: int
unique: bool
}
}
]
shardKey: {
{customized property}: 'string'
}
}
}
tags: {
{customized property}: 'string'
}
}
屬性值
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
名字 | 描述 | 價值 |
---|---|---|
輸送量 | 每秒要求單位數。 例如,“throughput”: “10000”。 | 字串 |
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
名字 | 描述 | 價值 |
---|---|---|
位置 | 資源所屬資源群組的位置。 | 字串 |
名字 | 資源名稱 | 字串 (必要) |
父母 | 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。 如需詳細資訊,請參閱 父資源外部的子資源。 |
類型資源的符號名稱:databaseAccounts/mongodbDatabases |
性能 | 用來建立及更新 Azure Cosmos DB MongoDB 集合的屬性。 | MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (必要) |
標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
名字 | 描述 | 價值 |
---|---|---|
選項 | 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 | CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions (必要) |
資源 | MongoDB 集合的標準 JSON 格式 | MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (必要) |
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
名字 | 描述 | 價值 |
---|---|---|
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 |
獨特 | 是唯一或不是唯一的 | 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-03-01",
"name": "string",
"location": "string",
"properties": {
"options": {
"throughput": "string"
},
"resource": {
"id": "string",
"indexes": [
{
"key": {
"keys": [ "string" ]
},
"options": {
"expireAfterSeconds": "int",
"unique": "bool"
}
}
],
"shardKey": {
"{customized property}": "string"
}
}
},
"tags": {
"{customized property}": "string"
}
}
屬性值
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
名字 | 描述 | 價值 |
---|---|---|
輸送量 | 每秒要求單位數。 例如,“throughput”: “10000”。 | 字串 |
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
名字 | 描述 | 價值 |
---|---|---|
apiVersion | API 版本 | '2020-03-01' |
位置 | 資源所屬資源群組的位置。 | 字串 |
名字 | 資源名稱 | 字串 (必要) |
性能 | 用來建立及更新 Azure Cosmos DB MongoDB 集合的屬性。 | MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (必要) |
標籤 | 資源標籤 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
類型 | 資源類型 | 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections' |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
名字 | 描述 | 價值 |
---|---|---|
選項 | 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 | CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions (必要) |
資源 | MongoDB 集合的標準 JSON 格式 | MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (必要) |
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
名字 | 描述 | 價值 |
---|---|---|
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 |
獨特 | 是唯一或不是唯一的 | 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-03-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
options = {
throughput = "string"
}
resource = {
id = "string"
indexes = [
{
key = {
keys = [
"string"
]
}
options = {
expireAfterSeconds = int
unique = bool
}
}
]
shardKey = {
{customized property} = "string"
}
}
}
})
}
屬性值
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
名字 | 描述 | 價值 |
---|---|---|
輸送量 | 每秒要求單位數。 例如,“throughput”: “10000”。 | 字串 |
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
名字 | 描述 | 價值 |
---|---|---|
位置 | 資源所屬資源群組的位置。 | 字串 |
名字 | 資源名稱 | 字串 (必要) |
parent_id | 此資源為父系之資源的標識碼。 | 類型資源的標識碼:databaseAccounts/mongodbDatabases |
性能 | 用來建立及更新 Azure Cosmos DB MongoDB 集合的屬性。 | MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties (必要) |
標籤 | 資源標籤 | 標記名稱和值的字典。 |
類型 | 資源類型 | “Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2020-03-01” |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
名字 | 描述 | 價值 |
---|---|---|
選項 | 要套用要求之選項的索引鍵/值組。 這會對應至隨要求傳送的標頭。 | CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions (必要) |
資源 | MongoDB 集合的標準 JSON 格式 | MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource (必要) |
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
名字 | 描述 | 價值 |
---|---|---|
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 |
獨特 | 是唯一或不是唯一的 | bool |
ShardKeys
名字 | 描述 | 價值 |
---|
標籤
名字 | 描述 | 價值 |
---|