Microsoft.DocumentDB databaseAccounts/mongodbDatabases/collections 2023-11-15
- [アーティクル]
-
-
Bicep リソース定義
databaseAccounts/mongodbDatabases/collections リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
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'
}
shardKey: {
{customized property}: 'string'
}
}
}
}
プロパティ値
databaseAccounts/mongodbDatabases/collections
| 名前 |
説明 |
値 |
| name |
リソース名
Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| location |
リソースが属しているリソース グループの場所。 |
string |
| tags |
タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 |
タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| parent |
Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。
詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
型のリソースのシンボル名: mongodbDatabases |
| properties |
Azure Cosmos DB MongoDB コレクションを作成および更新するためのプロパティ。 |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (必須) |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
| 名前 |
説明 |
値 |
| autoscaleSettings |
自動スケーリングの設定を指定します。 注: スループットまたは自動scaleSettings は必須ですが、両方は必要ありません。 |
AutoscaleSettings |
| throughput |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
INT |
AutoscaleSettings
| 名前 |
説明 |
値 |
| maxThroughput |
リソースがスケールアップできる最大スループットを表します。 |
INT |
MongoDBCollectionResourceOrMongoDBCollectionGetPrope...
| 名前 |
説明 |
値 |
| analyticalStorageTtl |
分析 TTL。 |
INT |
| createMode |
リソースの作成モードを示す列挙型。 |
'Default'
'Restore' |
| id |
Cosmos DB MongoDB コレクションの名前 |
string (必須) |
| インデックス |
インデックス キーの一覧 |
MongoIndex[] |
| restoreParameters |
復元に関する情報を示すパラメーター |
ResourceRestoreParameters |
| shardKey |
要求に適用されるシャード キーのキーと値のペア。 |
ShardKeys |
MongoIndex
MongoIndexKeys
| 名前 |
説明 |
値 |
| キー |
Azure Cosmos DB サービス内の各 MongoDB コレクションのキーの一覧 |
string[] |
MongoIndexOptions
| 名前 |
説明 |
値 |
| expireAfterSeconds |
秒後に有効期限が切れる |
INT |
| unique |
一意かどうか |
[bool] |
ResourceRestoreParameters
| 名前 |
説明 |
値 |
| restoreSource |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
string |
| restoreTimestampInUtc |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
string |
ShardKeys
| 名前 |
説明 |
値 |
| {カスタマイズされたプロパティ} |
|
string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
ARM テンプレート リソース定義
databaseAccounts/mongodbDatabases/collections リソースの種類は、次をターゲットとする操作と共にデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections リソースを作成するには、テンプレートに次の JSON を追加します。
{
"type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections",
"apiVersion": "2023-11-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"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"
},
"shardKey": {
"{customized property}": "string"
}
}
}
}
プロパティ値
databaseAccounts/mongodbDatabases/collections
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
'Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections' |
| apiVersion |
リソース API のバージョン |
'2023-11-15' |
| name |
リソース名
JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
| location |
リソースが属しているリソース グループの場所。 |
string |
| tags |
タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 |
タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| properties |
Azure Cosmos DB MongoDB コレクションを作成および更新するためのプロパティ。 |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (必須) |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
| 名前 |
説明 |
値 |
| autoscaleSettings |
自動スケーリングの設定を指定します。 注: スループットまたは自動scaleSettings は必須ですが、両方は必要ありません。 |
AutoscaleSettings |
| throughput |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
INT |
AutoscaleSettings
| 名前 |
説明 |
値 |
| maxThroughput |
リソースをスケールアップできる最大スループットを表します。 |
INT |
MongoDBCollectionResourceOrMongoDBCollectionGetPrope...
| 名前 |
説明 |
値 |
| analyticalStorageTtl |
分析 TTL。 |
INT |
| createMode |
リソースの作成モードを示す列挙型。 |
'Default'
'Restore' |
| id |
Cosmos DB MongoDB コレクションの名前 |
string (必須) |
| インデックス |
インデックス キーの一覧 |
MongoIndex[] |
| restoreParameters |
復元に関する情報を示すパラメーター |
ResourceRestoreParameters |
| shardKey |
要求に適用するシャード キーのキーと値のペア。 |
ShardKeys |
MongoIndex
MongoIndexKeys
| 名前 |
説明 |
値 |
| キー |
Azure Cosmos DB サービス内の各 MongoDB コレクションのキーの一覧 |
string[] |
MongoIndexOptions
| 名前 |
説明 |
値 |
| expireAfterSeconds |
秒後に有効期限が切れる |
INT |
| unique |
一意かどうか |
[bool] |
ResourceRestoreParameters
| 名前 |
説明 |
値 |
| restoreSource |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
string |
| restoreTimestampInUtc |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
string |
ShardKeys
| 名前 |
説明 |
値 |
| {カスタマイズされたプロパティ} |
|
string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
databaseAccounts/mongodbDatabases/collections リソースの種類は、次をターゲットとする操作と共にデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
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"
}
shardKey = {
{customized property} = "string"
}
}
}
})
}
プロパティ値
databaseAccounts/mongodbDatabases/collections
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
"Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/collections@2023-11-15" |
| name |
リソース名 |
string (必須) |
| location |
リソースが属しているリソース グループの場所。 |
string |
| parent_id |
このリソースの親であるリソースの ID。 |
種類のリソースの ID: mongodbDatabases |
| tags |
タグは、リソースを記述するキーと値のペアの一覧です。 これらのタグはリソース グループをまたがってこのリソースを表示およびグループ化する際に使用できます。 リソースには最大 15 個のタグを指定できます。 各タグには 128 文字以内のキーと、256 文字以内の値が必要です。 たとえば、テンプレートの種類の既定のエクスペリエンスは、"defaultExperience": "Cassandra" に設定されます。 現在の "defaultExperience" 値には、"Table"、"Graph"、"DocumentDB"、"MongoDB" も含まれます。 |
タグの名前と値のディクショナリ。 |
| properties |
Azure Cosmos DB MongoDB コレクションを作成および更新するためのプロパティ。 |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl... (必須) |
MongoDBCollectionCreateUpdatePropertiesOrMongoDBColl...
CreateUpdateOptionsOrMongoDBCollectionGetPropertiesO...
| 名前 |
説明 |
値 |
| autoscaleSettings |
自動スケーリング設定を指定します。 注: スループットまたは autoscaleSettings が必要ですが、両方は必要ありません。 |
AutoscaleSettings |
| throughput |
1 秒あたりの要求ユニット数。 たとえば、"throughput": 10000 です。 |
INT |
AutoscaleSettings
| 名前 |
説明 |
値 |
| maxThroughput |
リソースがスケールアップできる最大スループットを表します。 |
INT |
MongoDBCollectionResourceOrMongoDBCollectionGetPrope...
| 名前 |
説明 |
値 |
| analyticalStorageTtl |
分析 TTL。 |
INT |
| createMode |
リソースの作成モードを示す列挙型。 |
"Default"
"復元" |
| id |
Cosmos DB MongoDB コレクションの名前 |
string (必須) |
| インデックス |
インデックス キーの一覧 |
MongoIndex[] |
| restoreParameters |
復元に関する情報を示すパラメーター |
ResourceRestoreParameters |
| shardKey |
要求に適用するシャード キーのキーと値のペア。 |
ShardKeys |
MongoIndex
MongoIndexKeys
| 名前 |
説明 |
値 |
| キー |
Azure Cosmos DB サービス内の各 MongoDB コレクションのキーの一覧 |
string[] |
MongoIndexOptions
| 名前 |
説明 |
値 |
| expireAfterSeconds |
秒後に有効期限が切れる |
INT |
| unique |
一意かどうか |
[bool] |
ResourceRestoreParameters
| 名前 |
説明 |
値 |
| restoreSource |
復元を開始する必要がある復元可能なデータベース アカウントの ID。 例: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} |
string |
| restoreTimestampInUtc |
アカウントを復元する必要がある時間 (ISO-8601 形式)。 |
string |
ShardKeys
| 名前 |
説明 |
値 |
| {カスタマイズされたプロパティ} |
|
string |
