共用方式為


Microsoft.DocumentDB mongoClusters

Bicep 資源定義

mongoClusters 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.DocumentDB/mongoClusters 資源,請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.DocumentDB/mongoClusters@2024-10-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    administrator: {
      password: 'string'
      userName: 'string'
    }
    backup: {}
    compute: {
      tier: 'string'
    }
    createMode: 'string'
    dataApi: {
      mode: '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』。 字串

DataApiProperties

名字 描述 價值
模式 指出是否為叢集啟用 Mongo 資料 API 的模式。 'Disabled'
'Enabled'

HighAvailabilityProperties

名字 描述 價值
targetMode 為叢集要求的目標高可用性模式。 'Disabled'
'SameZone'
'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

名字 描述 價值
位置 資源所在的地理位置 字串 (必要)
名字 資源名稱 字串

約束:
最小長度 = 3
最大長度 = 3
模式 = ^[a-z0-9]+(-[a-z0-9]+)* (必要)
性能 此資源的資源特定屬性。 MongoClusterProperties
標籤 資源標籤 標記名稱和值的字典。 請參閱範本中的 標籤

MongoClusterProperties

名字 描述 價值
管理員 mongo 叢集的本機系統管理員屬性。 AdministratorProperties
備份 mongo 叢集的備份屬性。 BackupProperties
計算 mongo 叢集的計算屬性。 ComputeProperties
createMode 建立 Mongo 叢集的模式。 'Default'
'GeoReplica'
'PointInTimeRestore'
'Replica'
dataApi Mongo 叢集的數據 API 屬性。 DataApiProperties
highAvailability mongo 叢集的高可用性屬性。 HighAvailabilityProperties
previewFeatures 私人端點連線的清單。 包含任何的字串數組:
'GeoReplicas'
publicNetworkAccess 此 Mongo 叢集是否允許公用端點存取。 'Disabled'
'Enabled'
replicaParameters 要建立複本 mongo 叢集的參數。 MongoClusterReplicaParameters
restoreParameters 用來建立時間點還原 mongo 叢集的參數。 MongoClusterRestoreParameters
serverVersion Mongo DB 伺服器版本。 如果未指定,則預設為最新的可用版本。 字串
分片 mongo 叢集的分區化屬性。 分區化屬性
存儲 mongo 叢集的記憶體屬性。 StorageProperties

MongoClusterReplicaParameters

名字 描述 價值
sourceLocation 來源叢集的位置 字串 (必要)
sourceResourceId 復寫來源叢集的標識碼。 字串 (必要)

MongoClusterRestoreParameters

名字 描述 價值
pointInTimeUTC 還原 mongo 叢集的 UTC 時間點 字串
sourceResourceId 要還原的來源叢集的資源標識符 字串

ShardingProperties

名字 描述 價值
shardCount 要布建在叢集上的分區數目。 int

StorageProperties

名字 描述 價值
sizeGb 指派給每部伺服器的數據磁碟大小。 int

TrackedResourceTags

名字 描述 價值

ARM 樣本資源定義

mongoClusters 資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.DocumentDB/mongoClusters 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.DocumentDB/mongoClusters",
  "apiVersion": "2024-10-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "administrator": {
      "password": "string",
      "userName": "string"
    },
    "backup": {
    },
    "compute": {
      "tier": "string"
    },
    "createMode": "string",
    "dataApi": {
      "mode": "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』。 字串

DataApiProperties

名字 描述 價值
模式 指出是否為叢集啟用 Mongo 資料 API 的模式。 'Disabled'
'Enabled'

HighAvailabilityProperties

名字 描述 價值
targetMode 為叢集要求的目標高可用性模式。 'Disabled'
'SameZone'
'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

名字 描述 價值
apiVersion API 版本 '2024-10-01-preview'
位置 資源所在的地理位置 字串 (必要)
名字 資源名稱 字串

約束:
最小長度 = 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'
dataApi Mongo 叢集的數據 API 屬性。 DataApiProperties
highAvailability mongo 叢集的高可用性屬性。 HighAvailabilityProperties
previewFeatures 私人端點連線的清單。 包含任何的字串數組:
'GeoReplicas'
publicNetworkAccess 此 Mongo 叢集是否允許公用端點存取。 'Disabled'
'Enabled'
replicaParameters 要建立複本 mongo 叢集的參數。 MongoClusterReplicaParameters
restoreParameters 用來建立時間點還原 mongo 叢集的參數。 MongoClusterRestoreParameters
serverVersion Mongo DB 伺服器版本。 如果未指定,則預設為最新的可用版本。 字串
分片 mongo 叢集的分區化屬性。 分區化屬性
存儲 mongo 叢集的記憶體屬性。 StorageProperties

MongoClusterReplicaParameters

名字 描述 價值
sourceLocation 來源叢集的位置 字串 (必要)
sourceResourceId 復寫來源叢集的標識碼。 字串 (必要)

MongoClusterRestoreParameters

名字 描述 價值
pointInTimeUTC 還原 mongo 叢集的 UTC 時間點 字串
sourceResourceId 要還原的來源叢集的資源標識符 字串

ShardingProperties

名字 描述 價值
shardCount 要布建在叢集上的分區數目。 int

StorageProperties

名字 描述 價值
sizeGb 指派給每部伺服器的數據磁碟大小。 int

TrackedResourceTags

名字 描述 價值

Terraform (AzAPI 提供者) 資源定義

mongoClusters 資源類型可以使用目標作業來部署:

  • 資源群組

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔

資源格式

若要建立 Microsoft.DocumentDB/mongoClusters 資源,請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/mongoClusters@2024-10-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administrator = {
        password = "string"
        userName = "string"
      }
      backup = {
      }
      compute = {
        tier = "string"
      }
      createMode = "string"
      dataApi = {
        mode = "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』。 字串

DataApiProperties

名字 描述 價值
模式 指出是否為叢集啟用 Mongo 資料 API 的模式。 'Disabled'
'Enabled'

HighAvailabilityProperties

名字 描述 價值
targetMode 為叢集要求的目標高可用性模式。 'Disabled'
'SameZone'
'ZoneRedundantPreferred'

Microsoft.DocumentDB/mongoClusters

名字 描述 價值
位置 資源所在的地理位置 字串 (必要)
名字 資源名稱 字串

約束:
最小長度 = 3
最大長度 = 3
模式 = ^[a-z0-9]+(-[a-z0-9]+)* (必要)
性能 此資源的資源特定屬性。 MongoClusterProperties
標籤 資源標籤 標記名稱和值的字典。
類型 資源類型 “Microsoft.DocumentDB/mongoClusters@2024-10-01-preview”

MongoClusterProperties

名字 描述 價值
管理員 mongo 叢集的本機系統管理員屬性。 AdministratorProperties
備份 mongo 叢集的備份屬性。 BackupProperties
計算 mongo 叢集的計算屬性。 ComputeProperties
createMode 建立 Mongo 叢集的模式。 'Default'
'GeoReplica'
'PointInTimeRestore'
'Replica'
dataApi Mongo 叢集的數據 API 屬性。 DataApiProperties
highAvailability mongo 叢集的高可用性屬性。 HighAvailabilityProperties
previewFeatures 私人端點連線的清單。 包含任何的字串數組:
'GeoReplicas'
publicNetworkAccess 此 Mongo 叢集是否允許公用端點存取。 'Disabled'
'Enabled'
replicaParameters 要建立複本 mongo 叢集的參數。 MongoClusterReplicaParameters
restoreParameters 用來建立時間點還原 mongo 叢集的參數。 MongoClusterRestoreParameters
serverVersion Mongo DB 伺服器版本。 如果未指定,則預設為最新的可用版本。 字串
分片 mongo 叢集的分區化屬性。 分區化屬性
存儲 mongo 叢集的記憶體屬性。 StorageProperties

MongoClusterReplicaParameters

名字 描述 價值
sourceLocation 來源叢集的位置 字串 (必要)
sourceResourceId 復寫來源叢集的標識碼。 字串 (必要)

MongoClusterRestoreParameters

名字 描述 價值
pointInTimeUTC 還原 mongo 叢集的 UTC 時間點 字串
sourceResourceId 要還原的來源叢集的資源標識符 字串

ShardingProperties

名字 描述 價值
shardCount 要布建在叢集上的分區數目。 int

StorageProperties

名字 描述 價值
sizeGb 指派給每部伺服器的數據磁碟大小。 int

TrackedResourceTags

名字 描述 價值