Microsoft.DocumentDB mongoClusters 2024-07-01

[アーティクル]
12/20/2024

Bicep リソース定義

mongoClusters リソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループの - リソースグループのデプロイコマンド参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/mongoClusters リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-07-01' = {
  location: 'string'
  name: 'string'
  properties: {
    administrator: {
      password: 'string'
      userName: 'string'
    }
    backup: {}
    compute: {
      tier: 'string'
    }
    createMode: 'string'
    highAvailability: {
      targetMode: 'string'
    }
    previewFeatures: [
      'string'
    ]
    publicNetworkAccess: 'string'
    replicaParameters: {
      sourceLocation: 'string'
      sourceResourceId: 'string'
    }
    restoreParameters: {
      pointInTimeUTC: 'string'
      sourceResourceId: 'string'
    }
    serverVersion: 'string'
    sharding: {
      shardCount: int
    }
    storage: {
      sizeGb: int
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

AdministratorProperties

名前	形容	価値
パスワード	管理者パスワード。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
userName	管理者ユーザー名。	糸

BackupProperties

名前	形容	価値

ComputeProperties

名前	形容	価値
層	クラスターに割り当てるコンピューティングレベル。各層は仮想コアとメモリサイズにマップされます。値の例: 'M30'、'M40'。	糸

HighAvailabilityProperties

名前	形容	価値
targetMode	クラスターに対して要求されたターゲット高可用性モード。	'Disabled' 'SameZone' 'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

名前	形容	価値
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：最小長 = 3 最大長 = 3 パターン = `^[a-z0-9]+(-[a-z0-9]+)*` (必須)
プロパティ	このリソースのリソース固有のプロパティ。	MongoClusterProperties の
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください

MongoClusterProperties

名前	形容	価値
管理者	mongo クラスターのローカル管理者プロパティ。	AdministratorProperties
バックアップ	Mongo クラスターのバックアッププロパティ。	BackupProperties
計算する	mongo クラスターのコンピューティングプロパティ。	ComputeProperties
createMode	Mongo クラスターを作成するモード。	'Default' 'GeoReplica' 'PointInTimeRestore' 'Replica'
highAvailability	Mongo クラスターの高可用性プロパティ。	HighAvailabilityProperties の
previewFeatures	プライベートエンドポイント接続の一覧。	次のいずれかを含む文字列配列: 'GeoReplicas'
publicNetworkAccess	この Mongo クラスターに対してパブリックエンドポイントアクセスが許可されているかどうか。	'Disabled' 'Enabled'
replicaParameters	レプリカ Mongo クラスターを作成するためのパラメーター。	MongoClusterReplicaParameters
restoreParameters	ポイントインタイムリストア Mongo クラスターを作成するためのパラメーター。	MongoClusterRestoreParameters
serverVersion	Mongo DB サーバーのバージョン。指定されていない場合は、既定で使用可能な最新バージョンが使用されます。	糸
シャーディング	mongo クラスターのシャーディングプロパティ。	ShardingProperties
貯蔵	mongo クラスターのストレージプロパティ。	StorageProperties

MongoClusterReplicaParameters

名前	形容	価値
sourceLocation	ソースクラスターの場所	string (必須)
sourceResourceId	レプリケーションソースクラスターの ID。	string (必須)

MongoClusterRestoreParameters

名前	形容	価値
pointInTimeUTC	MONGO クラスターを復元する UTC ポイントインタイム	糸
sourceResourceId	復元するソースクラスターを検索するリソース ID	糸

ShardingProperties

名前	形容	価値
shardCount	クラスターにプロビジョニングするシャードの数。	int

StorageProperties

名前	形容	価値
sizeGb	各サーバーに割り当てられているデータディスクのサイズ。	int

TrackedResourceTags

名前	形容	価値

ARM テンプレートリソース定義

mongoClusters リソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループの - リソースグループのデプロイコマンド参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/mongoClusters リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2024-07-01",
  "name": "string",
  "location": "string",
  "properties": {
    "administrator": {
      "password": "string",
      "userName": "string"
    },
    "backup": {
    },
    "compute": {
      "tier": "string"
    },
    "createMode": "string",
    "highAvailability": {
      "targetMode": "string"
    },
    "previewFeatures": [ "string" ],
    "publicNetworkAccess": "string",
    "replicaParameters": {
      "sourceLocation": "string",
      "sourceResourceId": "string"
    },
    "restoreParameters": {
      "pointInTimeUTC": "string",
      "sourceResourceId": "string"
    },
    "serverVersion": "string",
    "sharding": {
      "shardCount": "int"
    },
    "storage": {
      "sizeGb": "int"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

AdministratorProperties

名前	形容	価値
パスワード	管理者パスワード。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
userName	管理者ユーザー名。	糸

BackupProperties

名前	形容	価値

ComputeProperties

名前	形容	価値
層	クラスターに割り当てるコンピューティングレベル。各層は仮想コアとメモリサイズにマップされます。値の例: 'M30'、'M40'。	糸

HighAvailabilityProperties

名前	形容	価値
targetMode	クラスターに対して要求されたターゲット高可用性モード。	'Disabled' 'SameZone' 'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

名前	形容	価値
apiVersion	API のバージョン	'2024-07-01'
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：最小長 = 3 最大長 = 3 パターン = `^[a-z0-9]+(-[a-z0-9]+)*` (必須)
プロパティ	このリソースのリソース固有のプロパティ。	MongoClusterProperties の
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
種類	リソースの種類	'Microsoft.DocumentDB/mongoClusters'

MongoClusterProperties

名前	形容	価値
管理者	mongo クラスターのローカル管理者プロパティ。	AdministratorProperties
バックアップ	Mongo クラスターのバックアッププロパティ。	BackupProperties
計算する	mongo クラスターのコンピューティングプロパティ。	ComputeProperties
createMode	Mongo クラスターを作成するモード。	'Default' 'GeoReplica' 'PointInTimeRestore' 'Replica'
highAvailability	Mongo クラスターの高可用性プロパティ。	HighAvailabilityProperties の
previewFeatures	プライベートエンドポイント接続の一覧。	次のいずれかを含む文字列配列: 'GeoReplicas'
publicNetworkAccess	この Mongo クラスターに対してパブリックエンドポイントアクセスが許可されているかどうか。	'Disabled' 'Enabled'
replicaParameters	レプリカ Mongo クラスターを作成するためのパラメーター。	MongoClusterReplicaParameters
restoreParameters	ポイントインタイムリストア Mongo クラスターを作成するためのパラメーター。	MongoClusterRestoreParameters
serverVersion	Mongo DB サーバーのバージョン。指定されていない場合は、既定で使用可能な最新バージョンが使用されます。	糸
シャーディング	mongo クラスターのシャーディングプロパティ。	ShardingProperties
貯蔵	mongo クラスターのストレージプロパティ。	StorageProperties

MongoClusterReplicaParameters

名前	形容	価値
sourceLocation	ソースクラスターの場所	string (必須)
sourceResourceId	レプリケーションソースクラスターの ID。	string (必須)

MongoClusterRestoreParameters

名前	形容	価値
pointInTimeUTC	MONGO クラスターを復元する UTC ポイントインタイム	糸
sourceResourceId	復元するソースクラスターを検索するリソース ID	糸

ShardingProperties

名前	形容	価値
shardCount	クラスターにプロビジョニングするシャードの数。	int

StorageProperties

名前	形容	価値
sizeGb	各サーバーに割り当てられているデータディスクのサイズ。	int

TrackedResourceTags

名前	形容	価値

Terraform (AzAPI プロバイダー) リソース定義

mongoClusters リソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.DocumentDB/mongoClusters リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2024-07-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administrator = {
        password = "string"
        userName = "string"
      }
      backup = {
      }
      compute = {
        tier = "string"
      }
      createMode = "string"
      highAvailability = {
        targetMode = "string"
      }
      previewFeatures = [
        "string"
      ]
      publicNetworkAccess = "string"
      replicaParameters = {
        sourceLocation = "string"
        sourceResourceId = "string"
      }
      restoreParameters = {
        pointInTimeUTC = "string"
        sourceResourceId = "string"
      }
      serverVersion = "string"
      sharding = {
        shardCount = int
      }
      storage = {
        sizeGb = int
      }
    }
  })
}

プロパティ値

AdministratorProperties

名前	形容	価値
パスワード	管理者パスワード。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
userName	管理者ユーザー名。	糸

BackupProperties

名前	形容	価値

ComputeProperties

名前	形容	価値
層	クラスターに割り当てるコンピューティングレベル。各層は仮想コアとメモリサイズにマップされます。値の例: 'M30'、'M40'。	糸

HighAvailabilityProperties

名前	形容	価値
targetMode	クラスターに対して要求されたターゲット高可用性モード。	'Disabled' 'SameZone' 'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

名前	形容	価値
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：最小長 = 3 最大長 = 3 パターン = `^[a-z0-9]+(-[a-z0-9]+)*` (必須)
プロパティ	このリソースのリソース固有のプロパティ。	MongoClusterProperties の
タグ	リソースタグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.DocumentDB/mongoClusters@2024-07-01"

MongoClusterProperties

名前	形容	価値
管理者	mongo クラスターのローカル管理者プロパティ。	AdministratorProperties
バックアップ	Mongo クラスターのバックアッププロパティ。	BackupProperties
計算する	mongo クラスターのコンピューティングプロパティ。	ComputeProperties
createMode	Mongo クラスターを作成するモード。	'Default' 'GeoReplica' 'PointInTimeRestore' 'Replica'
highAvailability	Mongo クラスターの高可用性プロパティ。	HighAvailabilityProperties の
previewFeatures	プライベートエンドポイント接続の一覧。	次のいずれかを含む文字列配列: 'GeoReplicas'
publicNetworkAccess	この Mongo クラスターに対してパブリックエンドポイントアクセスが許可されているかどうか。	'Disabled' 'Enabled'
replicaParameters	レプリカ Mongo クラスターを作成するためのパラメーター。	MongoClusterReplicaParameters
restoreParameters	ポイントインタイムリストア Mongo クラスターを作成するためのパラメーター。	MongoClusterRestoreParameters
serverVersion	Mongo DB サーバーのバージョン。指定されていない場合は、既定で使用可能な最新バージョンが使用されます。	糸
シャーディング	mongo クラスターのシャーディングプロパティ。	ShardingProperties
貯蔵	mongo クラスターのストレージプロパティ。	StorageProperties

MongoClusterReplicaParameters

名前	形容	価値
sourceLocation	ソースクラスターの場所	string (必須)
sourceResourceId	レプリケーションソースクラスターの ID。	string (必須)

MongoClusterRestoreParameters

名前	形容	価値
pointInTimeUTC	MONGO クラスターを復元する UTC ポイントインタイム	糸
sourceResourceId	復元するソースクラスターを検索するリソース ID	糸

ShardingProperties

名前	形容	価値
shardCount	クラスターにプロビジョニングするシャードの数。	int

StorageProperties

名前	形容	価値
sizeGb	各サーバーに割り当てられているデータディスクのサイズ。	int

TrackedResourceTags

名前	形容	価値

次の方法で共有

Microsoft.DocumentDB mongoClusters 2024-07-01

Bicep リソース定義

リソースの形式

プロパティ値

AdministratorProperties

BackupProperties

ComputeProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

ARM テンプレート リソース定義

リソースの形式

プロパティ値

AdministratorProperties

BackupProperties

ComputeProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

Terraform (AzAPI プロバイダー) リソース定義

リソースの形式

プロパティ値

AdministratorProperties

BackupProperties

ComputeProperties

HighAvailabilityProperties

Microsoft.DocumentDB/mongoClusters

MongoClusterProperties

MongoClusterReplicaParameters

MongoClusterRestoreParameters

ShardingProperties

StorageProperties

TrackedResourceTags

フィードバック

その他のリソース

ARM テンプレートリソース定義