Microsoft.DocumentDB mongoClusters 2024-02-15-preview
Bicep リソース定義
mongoClusters リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/mongoClusters リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-02-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
administratorLogin: 'string'
administratorLoginPassword: 'string'
createMode: 'string'
nodeGroupSpecs: [
{
diskSizeGB: int
enableHa: bool
kind: 'Shard'
nodeCount: int
sku: 'string'
}
]
restoreParameters: {
pointInTimeUTC: 'string'
sourceResourceId: 'string'
}
serverVersion: 'string'
}
}
プロパティ値
mongoClusters
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 | string (必須) |
| location | リソースが保存されている地理的な場所 | string (必須) |
| tags | リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| properties | Mongo クラスターのプロパティ。 | MongoClusterProperties |
MongoClusterProperties
| 名前 | 説明 | 値 |
|---|---|---|
| administratorLogin | Mongo クラスターの管理者のログイン。 | string |
| administratorLoginPassword | 管理者ログインのパスワード。 | string 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。 |
| createMode | Mongo クラスターを作成するモード。 | 'Default' 'PointInTimeRestore' 'Restore' |
| nodeGroupSpecs | クラスター内のノード グループ スペックの一覧。 | NodeGroupSpec[] 制約: 最小長 = 1 |
| restoreParameters | 復元操作に使用されるパラメーター | MongoClusterRestoreParameters |
| serverVersion | Mongo DB サーバーのバージョン。 指定しない場合、既定値は利用可能な最新バージョンです。 | string |
NodeGroupSpec
| 名前 | 説明 | 値 |
|---|---|---|
| diskSizeGB | ノード グループのディスク ストレージ サイズ (GB 単位)。 値の例: 128、256、512、1024。 | INT |
| enableHa | ノード グループで高可用性が有効になっているかどうか。 | [bool] |
| kind | ノード グループにデプロイされたノードの種類。 | 'Shard' |
| nodeCount | ノード グループ内のノードの数。 | INT |
| sku | ノード グループのリソース SKU。 これにより、ノードごとにプロビジョニングされる CPU とメモリのサイズが定義されます。 値の例: 'M30'、'M40'。 | string |
MongoClusterRestoreParameters
| 名前 | 説明 | 値 |
|---|---|---|
| pointInTimeUTC | MONGO クラスターを復元する UTC ポイントインタイム | string |
| sourceResourceId | 復元するソース クラスターを見つけるためのリソース ID | string |
ARM テンプレート リソース定義
mongoClusters リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/mongoClusters リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.DocumentDB/mongoClusters",
"apiVersion": "2024-02-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"administratorLogin": "string",
"administratorLoginPassword": "string",
"createMode": "string",
"nodeGroupSpecs": [
{
"diskSizeGB": "int",
"enableHa": "bool",
"kind": "Shard",
"nodeCount": "int",
"sku": "string"
}
],
"restoreParameters": {
"pointInTimeUTC": "string",
"sourceResourceId": "string"
},
"serverVersion": "string"
}
}
プロパティ値
mongoClusters
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.DocumentDB/mongoClusters' |
| apiVersion | リソース API のバージョン | '2024-02-15-preview' |
| name | リソース名 | string (必須) |
| location | リソースが保存されている地理的な場所 | string (必須) |
| tags | リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| properties | Mongo クラスターのプロパティ。 | MongoClusterProperties |
MongoClusterProperties
| 名前 | 説明 | 値 |
|---|---|---|
| administratorLogin | Mongo クラスターの管理者のログイン。 | string |
| administratorLoginPassword | 管理者ログインのパスワード。 | string 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとしてを渡します。 |
| createMode | Mongo クラスターを作成するモード。 | 'Default' 'PointInTimeRestore' 'Restore' |
| nodeGroupSpecs | クラスター内のノード グループ スペックの一覧。 | NodeGroupSpec[] 制約: 最小長 = 1 |
| restoreParameters | 復元操作に使用されるパラメーター | MongoClusterRestoreParameters |
| serverVersion | Mongo DB サーバーのバージョン。 指定しない場合、既定値は利用可能な最新バージョンです。 | string |
NodeGroupSpec
| 名前 | 説明 | 値 |
|---|---|---|
| diskSizeGB | ノード グループのディスク ストレージ サイズ (GB 単位)。 値の例: 128、256、512、1024。 | INT |
| enableHa | ノード グループで高可用性が有効になっているかどうか。 | [bool] |
| kind | ノード グループにデプロイされたノードの種類。 | 'Shard' |
| nodeCount | ノード グループ内のノードの数。 | INT |
| sku | ノード グループのリソース SKU。 これにより、ノードごとにプロビジョニングされる CPU とメモリのサイズが定義されます。 値の例: 'M30'、'M40'。 | string |
MongoClusterRestoreParameters
| 名前 | 説明 | 値 |
|---|---|---|
| pointInTimeUTC | MONGO クラスターを復元する UTC ポイントインタイム | string |
| sourceResourceId | 復元するソース クラスターを見つけるためのリソース ID | string |
Terraform (AzAPI プロバイダー) リソース定義
mongoClusters リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.DocumentDB/mongoClusters リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters@2024-02-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
administratorLogin = "string"
administratorLoginPassword = "string"
createMode = "string"
nodeGroupSpecs = [
{
diskSizeGB = int
enableHa = bool
kind = "Shard"
nodeCount = int
sku = "string"
}
]
restoreParameters = {
pointInTimeUTC = "string"
sourceResourceId = "string"
}
serverVersion = "string"
}
})
}
プロパティ値
mongoClusters
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.DocumentDB/mongoClusters@2024-02-15-preview" |
| name | リソース名 | string (必須) |
| location | リソースが保存されている地理的な場所 | string (必須) |
| parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
| tags | リソース タグ。 | タグ名と値のディクショナリ。 |
| properties | Mongo クラスターのプロパティ。 | MongoClusterProperties |
MongoClusterProperties
| 名前 | 説明 | 値 |
|---|---|---|
| administratorLogin | Mongo クラスターの管理者のログイン。 | string |
| administratorLoginPassword | 管理者ログインのパスワード。 | string 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして を渡します。 |
| createMode | Mongo クラスターを作成するモード。 | "Default" "PointInTimeRestore" "復元" |
| nodeGroupSpecs | クラスター内のノード グループ スペックの一覧。 | NodeGroupSpec[] 制約: 最小長 = 1 |
| restoreParameters | 復元操作に使用されるパラメーター | MongoClusterRestoreParameters |
| serverVersion | Mongo DB サーバーのバージョン。 指定しない場合、既定値は使用可能な最新バージョンになります。 | string |
NodeGroupSpec
| 名前 | 説明 | 値 |
|---|---|---|
| diskSizeGB | ノード グループのディスク ストレージ サイズ (GB 単位)。 値の例: 128、256、512、1024。 | INT |
| enableHa | ノード グループで高可用性が有効になっているかどうか。 | [bool] |
| kind | ノード グループにデプロイされたノードの種類。 | "シャード" |
| nodeCount | ノード グループ内のノードの数。 | INT |
| sku | ノード グループのリソース SKU。 これにより、ノードごとにプロビジョニングされる CPU とメモリのサイズが定義されます。 値の例: 'M30'、'M40'。 | string |
MongoClusterRestoreParameters
| 名前 | 説明 | 値 |
|---|---|---|
| pointInTimeUTC | MONGO クラスターを復元する UTC ポイントインタイム | string |
| sourceResourceId | 復元するソース クラスターを見つけるためのリソース ID | string |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示