Microsoft.DocumentDB 資料庫Accounts/mongodbDatabases
Bicep 資源定義
databaseAccounts/mongodbDatabases 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
若要建立 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-05-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
createMode: 'string'
id: 'string'
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
}
}
}
}
屬性值
databaseAccounts/mongodbDatabases
| 名稱 |
描述 |
值 |
| NAME |
資源名稱
瞭解如何在 Bicep 中設定子資源的名稱和類型。 |
需要字串 () |
| location |
資源所屬之資源群組的位置。 |
字串 |
| tags |
標記是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標記。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗會設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 |
標記名稱和值的字典。 請參閱 範本中的標籤 |
| 父系 (parent) |
在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增此屬性。
如需詳細資訊，請參閱 父資源外部的子資源。 |
類型資源的符號名稱： databaseAccounts |
| properties |
用來建立和更新 Azure Cosmos DB MongoDB 資料庫的屬性。 |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... 必要 () |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| 名稱 |
描述 |
值 |
| autoscaleSettings |
指定自動調整設定。 注意：需要輸送量或 autoscaleSettings，但不需要兩者。 |
AutoscaleSettings |
| 輸送量 |
每秒要求單位數。 例如，「輸送量」：10000。 |
int |
AutoscaleSettings
| 名稱 |
描述 |
值 |
| maxThroughput |
代表最大輸送量，資源可以相應增加。 |
int |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| 名稱 |
描述 |
值 |
| createMode |
表示資源建立模式的列舉。 |
'Default'
'Restore' |
| id |
Cosmos DB MongoDB 資料庫的名稱 |
字串 (必要) |
| restoreParameters |
用來指出還原相關信息的參數 |
ResourceRestoreParameters |
ResourceRestoreParameters
| 名稱 |
描述 |
值 |
| restoreSource |
必須起始還原之可還原之資料庫帳戶的標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
字串 |
| restoreTimestampInUtc |
帳戶必須還原的時間 (ISO-8601 格式) 。 |
字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
ARM 範本資源定義
databaseAccounts/mongodbDatabases 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
若要建立 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases 資源，請將下列 JSON 新增至您的範本。
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases",
"apiVersion": "2024-05-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"createMode": "string",
"id": "string",
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string"
}
}
}
}
屬性值
databaseAccounts/mongodbDatabases
| 名稱 |
描述 |
值 |
| 類型 |
資源類型 |
'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases' |
| apiVersion |
資源 API 版本 |
'2024-05-15' |
| NAME |
資源名稱
請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。 |
字串 (必要) |
| location |
資源所屬資源群組的位置。 |
字串 |
| tags |
標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 |
標記名稱和值的字典。 請參閱 範本中的標記 |
| properties |
建立及更新 Azure Cosmos DB MongoDB 資料庫的屬性。 |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... 必要 () |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| 名稱 |
描述 |
值 |
| autoscaleSettings |
指定自動調整設定。 注意：需要輸送量或 autoscaleSettings，但不需要兩者。 |
AutoscaleSettings |
| 輸送量 |
每秒要求單位數。 例如，「輸送量」：10000。 |
int |
AutoscaleSettings
| 名稱 |
描述 |
值 |
| maxThroughput |
代表最大輸送量，資源可以相應增加。 |
int |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| 名稱 |
描述 |
值 |
| createMode |
表示資源建立模式的列舉。 |
'Default'
'Restore' |
| id |
Cosmos DB MongoDB 資料庫的名稱 |
字串 (必要) |
| restoreParameters |
用來指出還原相關信息的參數 |
ResourceRestoreParameters |
ResourceRestoreParameters
| 名稱 |
描述 |
值 |
| restoreSource |
必須起始還原之可還原之資料庫帳戶的標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
字串 |
| restoreTimestampInUtc |
帳戶必須還原的時間 (ISO-8601 格式) 。 |
字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
databaseAccounts/mongodbDatabases 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
若要建立 Microsoft.DocumentDB/databaseAccounts/mongodbDatabases 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-05-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
createMode = "string"
id = "string"
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
}
}
}
})
}
屬性值
databaseAccounts/mongodbDatabases
| 名稱 |
描述 |
值 |
| 類型 |
資源類型 |
“Microsoft.DocumentDB/databaseAccounts/mongodbDatabases@2024-05-15” |
| NAME |
資源名稱 |
字串 (必要) |
| location |
資源所屬資源群組的位置。 |
字串 |
| parent_id |
此資源之父系的資源標識碼。 |
類型資源的標識碼： databaseAccounts |
| tags |
標籤是描述資源的索引鍵/值組清單。 這些標記可用來在資源群組間檢視資源，以及對資源分組。 資源最多可提供15個標籤。 每個標記的金鑰都不得多於 128 個字元，值則不得多於 256 個字元。 例如，範本類型的默認體驗設定為 「defaultExperience」：“Cassandra” 目前的 「defaultExperience」 值也包括 「Table」、“Graph”、“DocumentDB” 和 “MongoDB”。 |
標記名稱和值的字典。 |
| properties |
建立及更新 Azure Cosmos DB MongoDB 資料庫的屬性。 |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba... 必要 () |
MongoDBDatabaseCreateUpdatePropertiesOrMongoDBDataba...
CreateUpdateOptionsOrMongoDBDatabaseGetPropertiesOpt...
| 名稱 |
描述 |
值 |
| autoscaleSettings |
指定自動調整設定。 注意：需要輸送量或 autoscaleSettings，但不需要兩者。 |
AutoscaleSettings |
| 輸送量 |
每秒要求單位數。 例如，「輸送量」：10000。 |
int |
AutoscaleSettings
| 名稱 |
描述 |
值 |
| maxThroughput |
代表最大輸送量，資源可以相應增加。 |
int |
MongoDBDatabaseResourceOrMongoDBDatabaseGetPropertie...
| 名稱 |
描述 |
值 |
| createMode |
表示資源建立模式的列舉。 |
“Default”
“Restore” |
| id |
Cosmos DB MongoDB 資料庫的名稱 |
字串 (必要) |
| restoreParameters |
用來指出還原相關信息的參數 |
ResourceRestoreParameters |
ResourceRestoreParameters
| 名稱 |
描述 |
值 |
| restoreSource |
必須起始還原之可還原之資料庫帳戶的標識碼。 例如：/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
字串 |
| restoreTimestampInUtc |
帳戶必須還原的時間 (ISO-8601 格式) 。 |
字串 |
