Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2024-08-15
- [アーティクル]
-
-
Bicep リソース定義
databaseAccounts/mongodbDatabases/collections リソースの種類は、次をターゲットとする操作でデプロイできます。
-
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-08-15' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
options: {
autoscaleSettings: {
maxThroughput: int
}
throughput: int
}
resource: {
analyticalStorageTtl: int
createMode: 'string'
id: 'string'
indexes: [
{
key: {
keys: [
'string'
]
}
options: {
expireAfterSeconds: int
unique: bool
}
}
]
restoreParameters: {
restoreSource: 'string'
restoreTimestampInUtc: 'string'
restoreWithTtlDisabled: bool
}
shardKey: {
{customized property}: 'string'
}
}
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
AutoscaleSettings
| 名前 |
形容 |
価値 |
| maxThroughput |
リソースをスケールアップできる最大スループットを表します。 |
int |
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| 名前 |
形容 |
価値 |
| autoscaleSettings |
自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 |
AutoscaleSettings |
| スループット |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
int |
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| 名前 |
形容 |
価値 |
| analyticalStorageTtl |
分析 TTL。 |
int |
| createMode |
リソースの作成モードを示す列挙型。 |
'Default'
'Restore' |
| 身分証明書 |
Cosmos DB MongoDB コレクションの名前 |
string (必須) |
| 索引 |
インデックス キーの一覧 |
MongoIndex[] |
| restoreParameters |
復元に関する情報を示すパラメーター |
ResourceRestoreParameters |
| shardKey |
要求に適用されるシャード キーのキーと値のペア。 |
ShardKeys |
MongoIndex
MongoIndexKeys
| 名前 |
形容 |
価値 |
| キー |
Azure Cosmos DB サービス内の各 MongoDB コレクションのキーの一覧 |
string[] |
MongoIndexOptions
| 名前 |
形容 |
価値 |
| expireAfterSeconds |
秒後に有効期限が切れる |
int |
| ユニーク |
一意かどうか |
bool |
ResourceRestoreParameters
| 名前 |
形容 |
価値 |
| restoreSource |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
糸 |
| restoreTimestampInUtc |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
糸 |
| restoreWithTtlDisabled |
復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 |
bool |
ShardKeys
クイック スタートのサンプル
次のクイック スタート サンプルでは、このリソースの種類をデプロイします。
| Bicep ファイル |
形容 |
|
MongoDB API 用の Azure Cosmos アカウントを作成する |
このテンプレートでは、2 つのコレクションで共有スループットと専用スループットを使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。 |
|
MongoDB API 自動スケール 用の Azure Cosmos アカウントを作成する |
このテンプレートでは、共有スループットと専用自動スケーリング スループットの両方を使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。 |
ARM テンプレート リソース定義
databaseAccounts/mongodbDatabases/collections リソースの種類は、次をターゲットとする操作でデプロイできます。
-
リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
"apiVersion": "2024-08-15",
"name": "string",
"location": "string",
"properties": {
"options": {
"autoscaleSettings": {
"maxThroughput": "int"
},
"throughput": "int"
},
"resource": {
"analyticalStorageTtl": "int",
"createMode": "string",
"id": "string",
"indexes": [
{
"key": {
"keys": [ "string" ]
},
"options": {
"expireAfterSeconds": "int",
"unique": "bool"
}
}
],
"restoreParameters": {
"restoreSource": "string",
"restoreTimestampInUtc": "string",
"restoreWithTtlDisabled": "bool"
},
"shardKey": {
"{customized property}": "string"
}
}
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
AutoscaleSettings
| 名前 |
形容 |
価値 |
| maxThroughput |
リソースをスケールアップできる最大スループットを表します。 |
int |
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| 名前 |
形容 |
価値 |
| autoscaleSettings |
自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 |
AutoscaleSettings |
| スループット |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
int |
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| 名前 |
形容 |
価値 |
| analyticalStorageTtl |
分析 TTL。 |
int |
| createMode |
リソースの作成モードを示す列挙型。 |
'Default'
'Restore' |
| 身分証明書 |
Cosmos DB MongoDB コレクションの名前 |
string (必須) |
| 索引 |
インデックス キーの一覧 |
MongoIndex[] |
| restoreParameters |
復元に関する情報を示すパラメーター |
ResourceRestoreParameters |
| shardKey |
要求に適用されるシャード キーのキーと値のペア。 |
ShardKeys |
MongoIndex
MongoIndexKeys
| 名前 |
形容 |
価値 |
| キー |
Azure Cosmos DB サービス内の各 MongoDB コレクションのキーの一覧 |
string[] |
MongoIndexOptions
| 名前 |
形容 |
価値 |
| expireAfterSeconds |
秒後に有効期限が切れる |
int |
| ユニーク |
一意かどうか |
bool |
ResourceRestoreParameters
| 名前 |
形容 |
価値 |
| restoreSource |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
糸 |
| restoreTimestampInUtc |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
糸 |
| restoreWithTtlDisabled |
復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 |
bool |
ShardKeys
クイック スタート テンプレート
次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。
| テンプレート |
形容 |
MongoDB API 用の Azure Cosmos アカウントを作成する
Azure にデプロイする |
このテンプレートでは、2 つのコレクションで共有スループットと専用スループットを使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。 |
MongoDB API 自動スケール 用の Azure Cosmos アカウントを作成する
Azure にデプロイする |
このテンプレートでは、共有スループットと専用自動スケーリング スループットの両方を使用して、MongoDB API 4.2 用の Azure Cosmos DB アカウントを 2 つのリージョンに作成します。 |
databaseAccounts/mongodbDatabases/collections リソースの種類は、次をターゲットとする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2024-08-15"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
options = {
autoscaleSettings = {
maxThroughput = int
}
throughput = int
}
resource = {
analyticalStorageTtl = int
createMode = "string"
id = "string"
indexes = [
{
key = {
keys = [
"string"
]
}
options = {
expireAfterSeconds = int
unique = bool
}
}
]
restoreParameters = {
restoreSource = "string"
restoreTimestampInUtc = "string"
restoreWithTtlDisabled = bool
}
shardKey = {
{customized property} = "string"
}
}
}
})
}
プロパティ値
AutoscaleSettings
| 名前 |
形容 |
価値 |
| maxThroughput |
リソースをスケールアップできる最大スループットを表します。 |
int |
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesOptions
| 名前 |
形容 |
価値 |
| autoscaleSettings |
自動スケール設定を指定します。 注: スループットまたは自動scaleSettingsは必須ですが、両方は必要ありません。 |
AutoscaleSettings |
| スループット |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
int |
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections
MongoDBCollectionCreateUpdatePropertiesOrMongoDBCollectionGetProperties
MongoDBCollectionResourceOrMongoDBCollectionGetPropertiesResource
| 名前 |
形容 |
価値 |
| analyticalStorageTtl |
分析 TTL。 |
int |
| createMode |
リソースの作成モードを示す列挙型。 |
'Default'
'Restore' |
| 身分証明書 |
Cosmos DB MongoDB コレクションの名前 |
string (必須) |
| 索引 |
インデックス キーの一覧 |
MongoIndex[] |
| restoreParameters |
復元に関する情報を示すパラメーター |
ResourceRestoreParameters |
| shardKey |
要求に適用されるシャード キーのキーと値のペア。 |
ShardKeys |
MongoIndex
MongoIndexKeys
| 名前 |
形容 |
価値 |
| キー |
Azure Cosmos DB サービス内の各 MongoDB コレクションのキーの一覧 |
string[] |
MongoIndexOptions
| 名前 |
形容 |
価値 |
| expireAfterSeconds |
秒後に有効期限が切れる |
int |
| ユニーク |
一意かどうか |
bool |
ResourceRestoreParameters
| 名前 |
形容 |
価値 |
| restoreSource |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
糸 |
| restoreTimestampInUtc |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
糸 |
| restoreWithTtlDisabled |
復元が成功した時点で、復元されたアカウントに Time-To-Live を無効にするかどうかを指定します。 |
bool |
ShardKeys