Microsoft.DocumentDB mongoClusters 2024-02-15-preview
Bicep リソース定義
mongoClusters リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DocumentDB/mongoClusters リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-02-15-preview' = {
location: 'string'
name: 'string'
properties: {
administratorLogin: 'string'
administratorLoginPassword: 'string'
createMode: 'string'
nodeGroupSpecs: [
{
diskSizeGB: int
enableHa: bool
kind: 'string'
nodeCount: int
sku: 'string'
}
]
restoreParameters: {
pointInTimeUTC: 'string'
sourceResourceId: 'string'
}
serverVersion: 'string'
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
Microsoft.DocumentDB/mongoClusters
名前 | 形容 | 価値 |
---|---|---|
場所 | リソースが存在する地理的な場所 | string (必須) |
名前 | リソース名 | 糸 制約: 最小長 = 3 最大長 = 3 パターン = ^[a-z0-9]+(-[a-z0-9]+)* (必須) |
プロパティ | mongo クラスターのプロパティ。 | MongoClusterProperties の |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
MongoClusterProperties
名前 | 形容 | 価値 |
---|---|---|
administratorLogin | mongo クラスターの管理者のログイン。 | 糸 |
administratorLoginPassword | 管理者ログインのパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
createMode | Mongo クラスターを作成するモード。 | 'Default' 'PointInTimeRestore' 'Restore' |
nodeGroupSpecs | クラスター内のノード グループ スペックの一覧。 | NodeGroupSpec[] |
restoreParameters | 復元操作に使用されるパラメーター | MongoClusterRestoreParameters |
serverVersion | Mongo DB サーバーのバージョン。 指定されていない場合は、既定で使用可能な最新バージョンが使用されます。 | 糸 |
MongoClusterRestoreParameters
名前 | 形容 | 価値 |
---|---|---|
pointInTimeUTC | MONGO クラスターを復元する UTC ポイント イン タイム | 糸 |
sourceResourceId | 復元するソース クラスターを検索するリソース ID | 糸 |
NodeGroupSpec
名前 | 形容 | 価値 |
---|---|---|
diskSizeGB | ノード グループのディスク ストレージ サイズ (GB)。 値の例: 128、256、512、1024。 | int |
enableHa | ノード グループで高可用性が有効になっているかどうか。 | bool |
種類 | ノード グループにデプロイされたノードの種類。 | 'Shard' |
nodeCount | ノード グループ内のノードの数。 | int |
sku | ノード グループのリソース SKU。 これにより、ノードごとにプロビジョニングされる CPU とメモリのサイズが定義されます。 値の例: 'M30'、'M40'。 | 糸 |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
ARM テンプレート リソース定義
mongoClusters リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DocumentDB/mongoClusters リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.DocumentDB/mongoClusters",
"apiVersion": "2024-02-15-preview",
"name": "string",
"location": "string",
"properties": {
"administratorLogin": "string",
"administratorLoginPassword": "string",
"createMode": "string",
"nodeGroupSpecs": [
{
"diskSizeGB": "int",
"enableHa": "bool",
"kind": "string",
"nodeCount": "int",
"sku": "string"
}
],
"restoreParameters": {
"pointInTimeUTC": "string",
"sourceResourceId": "string"
},
"serverVersion": "string"
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
Microsoft.DocumentDB/mongoClusters
名前 | 形容 | 価値 |
---|---|---|
apiVersion | API のバージョン | '2024-02-15-preview' |
場所 | リソースが存在する地理的な場所 | string (必須) |
名前 | リソース名 | 糸 制約: 最小長 = 3 最大長 = 3 パターン = ^[a-z0-9]+(-[a-z0-9]+)* (必須) |
プロパティ | mongo クラスターのプロパティ。 | MongoClusterProperties の |
タグ | リソース タグ | タグ名と値のディクショナリ。 テンプレート の |
種類 | リソースの種類 | 'Microsoft.DocumentDB/mongoClusters' |
MongoClusterProperties
名前 | 形容 | 価値 |
---|---|---|
administratorLogin | mongo クラスターの管理者のログイン。 | 糸 |
administratorLoginPassword | 管理者ログインのパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
createMode | Mongo クラスターを作成するモード。 | 'Default' 'PointInTimeRestore' 'Restore' |
nodeGroupSpecs | クラスター内のノード グループ スペックの一覧。 | NodeGroupSpec[] |
restoreParameters | 復元操作に使用されるパラメーター | MongoClusterRestoreParameters |
serverVersion | Mongo DB サーバーのバージョン。 指定されていない場合は、既定で使用可能な最新バージョンが使用されます。 | 糸 |
MongoClusterRestoreParameters
名前 | 形容 | 価値 |
---|---|---|
pointInTimeUTC | MONGO クラスターを復元する UTC ポイント イン タイム | 糸 |
sourceResourceId | 復元するソース クラスターを検索するリソース ID | 糸 |
NodeGroupSpec
名前 | 形容 | 価値 |
---|---|---|
diskSizeGB | ノード グループのディスク ストレージ サイズ (GB)。 値の例: 128、256、512、1024。 | int |
enableHa | ノード グループで高可用性が有効になっているかどうか。 | bool |
種類 | ノード グループにデプロイされたノードの種類。 | 'Shard' |
nodeCount | ノード グループ内のノードの数。 | int |
sku | ノード グループのリソース SKU。 これにより、ノードごとにプロビジョニングされる CPU とメモリのサイズが定義されます。 値の例: 'M30'、'M40'。 | 糸 |
TrackedResourceTags
名前 | 形容 | 価値 |
---|
Terraform (AzAPI プロバイダー) リソース定義
mongoClusters リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.DocumentDB/mongoClusters リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/mongoClusters@2024-02-15-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
administratorLogin = "string"
administratorLoginPassword = "string"
createMode = "string"
nodeGroupSpecs = [
{
diskSizeGB = int
enableHa = bool
kind = "string"
nodeCount = int
sku = "string"
}
]
restoreParameters = {
pointInTimeUTC = "string"
sourceResourceId = "string"
}
serverVersion = "string"
}
})
}
プロパティ値
Microsoft.DocumentDB/mongoClusters
名前 | 形容 | 価値 |
---|---|---|
場所 | リソースが存在する地理的な場所 | string (必須) |
名前 | リソース名 | 糸 制約: 最小長 = 3 最大長 = 3 パターン = ^[a-z0-9]+(-[a-z0-9]+)* (必須) |
プロパティ | mongo クラスターのプロパティ。 | MongoClusterProperties の |
タグ | リソース タグ | タグ名と値のディクショナリ。 |
種類 | リソースの種類 | "Microsoft.DocumentDB/mongoClusters@2024-02-15-preview" |
MongoClusterProperties
名前 | 形容 | 価値 |
---|---|---|
administratorLogin | mongo クラスターの管理者のログイン。 | 糸 |
administratorLoginPassword | 管理者ログインのパスワード。 | 糸 制約: 機密性の高い値。 セキュリティで保護されたパラメーターとして渡します。 |
createMode | Mongo クラスターを作成するモード。 | 'Default' 'PointInTimeRestore' 'Restore' |
nodeGroupSpecs | クラスター内のノード グループ スペックの一覧。 | NodeGroupSpec[] |
restoreParameters | 復元操作に使用されるパラメーター | MongoClusterRestoreParameters |
serverVersion | Mongo DB サーバーのバージョン。 指定されていない場合は、既定で使用可能な最新バージョンが使用されます。 | 糸 |
MongoClusterRestoreParameters
名前 | 形容 | 価値 |
---|---|---|
pointInTimeUTC | MONGO クラスターを復元する UTC ポイント イン タイム | 糸 |
sourceResourceId | 復元するソース クラスターを検索するリソース ID | 糸 |
NodeGroupSpec
名前 | 形容 | 価値 |
---|---|---|
diskSizeGB | ノード グループのディスク ストレージ サイズ (GB)。 値の例: 128、256、512、1024。 | int |
enableHa | ノード グループで高可用性が有効になっているかどうか。 | bool |
種類 | ノード グループにデプロイされたノードの種類。 | 'Shard' |
nodeCount | ノード グループ内のノードの数。 | int |
sku | ノード グループのリソース SKU。 これにより、ノードごとにプロビジョニングされる CPU とメモリのサイズが定義されます。 値の例: 'M30'、'M40'。 | 糸 |
TrackedResourceTags
名前 | 形容 | 価値 |
---|