Bagikan melalui

Microsoft.DocumentDB cassandraClusters 2023-09-15-preview

  • Artikel

Definisi sumber daya Bicep

Jenis sumber daya cassandraClusters dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.DocumentDB/cassandraClusters, tambahkan Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
  }
  properties: {
    authenticationMethod: 'string'
    backupSchedules: [
      {
        cronExpression: 'string'
        retentionInHours: int
        scheduleName: 'string'
      }
    ]
    cassandraAuditLoggingEnabled: bool
    cassandraVersion: 'string'
    clientCertificates: [
      {
        pem: 'string'
      }
    ]
    clusterNameOverride: 'string'
    clusterType: 'string'
    deallocated: bool
    delegatedManagementSubnetId: 'string'
    extensions: [
      'string'
    ]
    externalGossipCertificates: [
      {
        pem: 'string'
      }
    ]
    externalSeedNodes: [
      {
        ipAddress: 'string'
      }
    ]
    hoursBetweenBackups: int
    initialCassandraAdminPassword: 'string'
    prometheusEndpoint: {
      ipAddress: 'string'
    }
    provisionError: {
      additionalErrorInfo: 'string'
      code: 'string'
      message: 'string'
      target: 'string'
    }
    provisioningState: 'string'
    repairEnabled: bool
    restoreFromBackupId: 'string'
  }
}

Nilai properti

cassandraClusters

Nama Deskripsi Nilai
nama Nama sumber daya string (diperlukan)
lokasi Lokasi grup sumber daya tempat sumber daya berada. string
tag Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB". Kamus nama dan nilai tag. Lihat Tag dalam templat
identitas Identitas untuk sumber daya. ManagedCassandraManagedServiceIdentity
properti Properti kluster Cassandra terkelola. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nama Deskripsi Nilai
jenis Jenis sumber daya. 'Tidak Ada'
'SystemAssigned'

ClusterResourceProperties

Nama Deskripsi Nilai
authenticationMethod Metode autentikasi mana yang harus digunakan Cassandra untuk mengautentikasi klien. 'Tidak ada' menonaktifkan autentikasi, jadi tidak boleh digunakan kecuali dalam keadaan darurat. 'Cassandra' adalah autentikasi berbasis kata sandi default. Defaultnya adalah 'Cassandra'. 'Cassandra'
'Ldap'
'Tidak Ada'
backupSchedules Daftar jadwal pencadangan yang menentukan kapan Anda ingin mencadangkan data Anda. BackupSchedule[]
cassandraAuditLoggingEnabled Apakah pengelogan audit Cassandra diaktifkan bool
cassandraVersion Versi Cassandra mana yang harus digabungkan dengan kluster ini untuk berjalan (misalnya, 3.11). Saat diperbarui, kluster mungkin membutuhkan waktu untuk bermigrasi ke versi baru. string
clientCertificates Daftar sertifikat TLS yang digunakan untuk mengotorisasi klien yang terhubung ke kluster. Semua koneksi dienkripsi TLS baik clientCertificates diatur atau tidak, tetapi jika clientCertificates diatur, kluster Cassandra terkelola akan menolak semua koneksi yang tidak menyandang sertifikat klien TLS yang dapat divalidasi dari satu atau beberapa sertifikat publik di properti ini. Sertifikat[]
clusterNameOverride Jika Anda perlu mengatur properti clusterName di cassandra.yaml ke sesuatu selain nama sumber daya kluster, atur nilai yang akan digunakan pada properti ini. string
clusterType Jenis kluster. Jika diatur ke Produksi, beberapa operasi mungkin tidak diizinkan pada kluster. 'NonProduksi'
'Produksi'
dibatalkan alokasinya Apakah kluster dan pusat data terkait telah dibatalkan alokasinya. bool
delegatedManagementSubnetId Id sumber daya dari subnet yang harus dilampirkan oleh layanan manajemen kluster ini. Subnet harus dapat dirutekan ke semua subnet yang akan didelegasikan ke pusat data. Id sumber daya harus berupa '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' string
extensions Ekstensi yang akan ditambahkan atau diperbarui pada kluster. string[]
externalGossipCertificates Daftar sertifikat TLS yang digunakan untuk mengotorisasi gosip dari pusat data yang tidak dikelola. Sertifikat TLS dari semua simpul di pusat data yang tidak dikelola harus dapat diverifikasi menggunakan salah satu sertifikat yang disediakan dalam properti ini. Sertifikat[]
externalSeedNodes Daftar alamat IP node seed di pusat data yang tidak dikelola. Ini akan ditambahkan ke daftar node seed dari semua node terkelola. SeedNode[]
hoursBetweenBackups (Tidak digunakan lagi) Jumlah jam untuk menunggu antara mengambil cadangan kluster. int
initialCassandraAdminPassword Kata sandi awal untuk klien yang terhubung sebagai admin ke kluster. Harus diubah setelah pembuatan kluster. Mengembalikan null pada GET. Bidang ini hanya berlaku ketika bidang authenticationMethod adalah 'Cassandra'. string

Batasan:
Nilai sensitif. Teruskan sebagai parameter aman.
prometheusEndpoint Nama host atau alamat IP tempat titik akhir Prometheus yang berisi data tentang simpul Cassandra terkelola dapat dicapai. SeedNode
provisionError Kesalahan yang terkait dengan provisi sumber daya. CassandraError
provisioningState Status sumber daya pada saat operasi dipanggil. 'Dibatalkan'
'Membuat'
'Menghapus'
'Gagal'
'Berhasil'
'Memperbarui'
repairEnabled Haruskah perbaikan otomatis berjalan pada kluster ini? Jika dihilangkan, ini benar, dan harus tetap benar kecuali Anda menjalankan kluster hibrid di mana Anda sudah melakukan perbaikan Anda sendiri. bool
restoreFromBackupId Untuk membuat kluster kosong, hilangkan bidang ini atau atur ke null. Untuk memulihkan cadangan ke kluster baru, atur bidang ini ke id sumber daya cadangan. string

BackupSchedule

Nama Deskripsi Nilai
cronExpression Ekspresi cron yang menentukan kapan Anda ingin mencadangkan data Anda. string
retentionInHours Periode retensi (jam) cadangan. Jika Anda ingin menyimpan data selamanya, atur retensi ke 0. int
scheduleName Pengidentifikasi unik jadwal pencadangan. string

Sertifikat

Nama Deskripsi Nilai
Pem Kunci publik yang diformat PEM. string

SeedNode

Nama Deskripsi Nilai
ipAddress Alamat IP dari node seed ini. string

CassandraError

Nama Deskripsi Nilai
additionalErrorInfo Informasi tambahan tentang kesalahan. string
kode Kode kesalahan yang terjadi. string
pesan Pesan kesalahan. string
target Sumber daya target kesalahan. string

Definisi sumber daya templat ARM

Jenis sumber daya cassandraClusters dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.DocumentDB/cassandraClusters, tambahkan JSON berikut ke templat Anda.

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "authenticationMethod": "string",
    "backupSchedules": [
      {
        "cronExpression": "string",
        "retentionInHours": "int",
        "scheduleName": "string"
      }
    ],
    "cassandraAuditLoggingEnabled": "bool",
    "cassandraVersion": "string",
    "clientCertificates": [
      {
        "pem": "string"
      }
    ],
    "clusterNameOverride": "string",
    "clusterType": "string",
    "deallocated": "bool",
    "delegatedManagementSubnetId": "string",
    "extensions": [ "string" ],
    "externalGossipCertificates": [
      {
        "pem": "string"
      }
    ],
    "externalSeedNodes": [
      {
        "ipAddress": "string"
      }
    ],
    "hoursBetweenBackups": "int",
    "initialCassandraAdminPassword": "string",
    "prometheusEndpoint": {
      "ipAddress": "string"
    },
    "provisionError": {
      "additionalErrorInfo": "string",
      "code": "string",
      "message": "string",
      "target": "string"
    },
    "provisioningState": "string",
    "repairEnabled": "bool",
    "restoreFromBackupId": "string"
  }
}

Nilai properti

cassandraClusters

Nama Deskripsi Nilai
jenis Jenis sumber daya 'Microsoft.DocumentDB/cassandraClusters'
apiVersion Versi api sumber daya '2023-09-15-preview'
nama Nama sumber daya string (diperlukan)
lokasi Lokasi grup sumber daya tempat sumber daya berada. string
tag Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam menampilkan dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB". Kamus nama dan nilai tag. Lihat Tag dalam templat
identitas Identitas untuk sumber daya. ManagedCassandraManagedServiceIdentity
properti Properti kluster Cassandra terkelola. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nama Deskripsi Nilai
jenis Jenis sumber daya. 'Tidak Ada'
'SystemAssigned'

ClusterResourceProperties

Nama Deskripsi Nilai
authenticationMethod Metode autentikasi mana yang harus digunakan Cassandra untuk mengautentikasi klien. 'None' menonaktifkan autentikasi, jadi tidak boleh digunakan kecuali dalam keadaan darurat. 'Cassandra' adalah autentikasi berbasis kata sandi default. Defaultnya adalah 'Cassandra'. 'Cassandra'
'Ldap'
'Tidak Ada'
backupSchedules Daftar jadwal pencadangan yang menentukan kapan Anda ingin mencadangkan data Anda. BackupSchedule[]
cassandraAuditLoggingEnabled Apakah pengelogan audit Cassandra diaktifkan bool
cassandraVersion Versi Cassandra mana yang harus dikonversi kluster ini untuk berjalan (misalnya, 3.11). Ketika diperbarui, kluster mungkin membutuhkan waktu untuk bermigrasi ke versi baru. string
clientCertificates Daftar sertifikat TLS yang digunakan untuk mengotorisasi klien yang terhubung ke kluster. Semua koneksi dienkripsi TLS apakah clientCertificates diatur atau tidak, tetapi jika clientCertificates diatur, kluster Cassandra terkelola akan menolak semua koneksi yang tidak membawa sertifikat klien TLS yang dapat divalidasi dari satu atau beberapa sertifikat publik di properti ini. Sertifikat[]
clusterNameOverride Jika Anda perlu mengatur properti clusterName di cassandra.yaml ke sesuatu selain nama sumber daya kluster, atur nilai yang akan digunakan pada properti ini. string
clusterType Jenis kluster. Jika diatur ke Produksi, beberapa operasi mungkin tidak diizinkan pada kluster. 'NonProduksi'
'Produksi'
dibatalkan alokasinya Apakah kluster dan pusat data terkait telah dibatalkan alokasinya. bool
delegatedManagementSubnetId Id sumber daya dari subnet yang harus dilampirkan oleh layanan manajemen kluster ini. Subnet harus dapat dirutekan ke semua subnet yang akan didelegasikan ke pusat data. Id sumber daya harus berupa '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' string
extensions Ekstensi yang akan ditambahkan atau diperbarui pada kluster. string[]
externalGossipCertificates Daftar sertifikat TLS yang digunakan untuk mengotorisasi gosip dari pusat data yang tidak dikelola. Sertifikat TLS dari semua simpul di pusat data yang tidak dikelola harus dapat diverifikasi menggunakan salah satu sertifikat yang disediakan dalam properti ini. Sertifikat[]
externalSeedNodes Daftar alamat IP node seed di pusat data yang tidak dikelola. Ini akan ditambahkan ke daftar node seed dari semua node terkelola. SeedNode[]
hoursBetweenBackups (Tidak digunakan lagi) Jumlah jam untuk menunggu antara mengambil cadangan kluster. int
initialCassandraAdminPassword Kata sandi awal untuk klien yang terhubung sebagai admin ke kluster. Harus diubah setelah pembuatan kluster. Mengembalikan null pada GET. Bidang ini hanya berlaku ketika bidang authenticationMethod adalah 'Cassandra'. string

Batasan:
Nilai sensitif. Teruskan sebagai parameter aman.
prometheusEndpoint Nama host atau alamat IP tempat titik akhir Prometheus yang berisi data tentang simpul Cassandra terkelola dapat dicapai. SeedNode
provisionError Kesalahan yang terkait dengan provisi sumber daya. CassandraError
provisioningState Status sumber daya pada saat operasi dipanggil. 'Dibatalkan'
'Membuat'
'Menghapus'
'Gagal'
'Berhasil'
'Memperbarui'
repairEnabled Haruskah perbaikan otomatis berjalan pada kluster ini? Jika dihilangkan, ini benar, dan harus tetap benar kecuali Anda menjalankan kluster hibrid di mana Anda sudah melakukan perbaikan Anda sendiri. bool
restoreFromBackupId Untuk membuat kluster kosong, hilangkan bidang ini atau atur ke null. Untuk memulihkan cadangan ke kluster baru, atur bidang ini ke id sumber daya cadangan. string

BackupSchedule

Nama Deskripsi Nilai
cronExpression Ekspresi cron yang menentukan kapan Anda ingin mencadangkan data Anda. string
retentionInHours Periode retensi (jam) cadangan. Jika Anda ingin menyimpan data selamanya, atur retensi ke 0. int
scheduleName Pengidentifikasi unik jadwal pencadangan. string

Sertifikat

Nama Deskripsi Nilai
Pem Kunci umum yang diformat PEM. string

SeedNode

Nama Deskripsi Nilai
ipAddress Alamat IP node seed ini. string

CassandraError

Nama Deskripsi Nilai
additionalErrorInfo Informasi tambahan tentang kesalahan. string
kode Kode kesalahan yang terjadi. string
pesan Pesan kesalahan. string
target Sumber daya target kesalahan. string

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya cassandraClusters dapat disebarkan dengan operasi yang menargetkan:

  • Grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.DocumentDB/cassandraClusters, tambahkan Terraform berikut ke templat Anda.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      backupSchedules = [
        {
          cronExpression = "string"
          retentionInHours = int
          scheduleName = "string"
        }
      ]
      cassandraAuditLoggingEnabled = bool
      cassandraVersion = "string"
      clientCertificates = [
        {
          pem = "string"
        }
      ]
      clusterNameOverride = "string"
      clusterType = "string"
      deallocated = bool
      delegatedManagementSubnetId = "string"
      extensions = [
        "string"
      ]
      externalGossipCertificates = [
        {
          pem = "string"
        }
      ]
      externalSeedNodes = [
        {
          ipAddress = "string"
        }
      ]
      hoursBetweenBackups = int
      initialCassandraAdminPassword = "string"
      prometheusEndpoint = {
        ipAddress = "string"
      }
      provisionError = {
        additionalErrorInfo = "string"
        code = "string"
        message = "string"
        target = "string"
      }
      provisioningState = "string"
      repairEnabled = bool
      restoreFromBackupId = "string"
    }
  })
}

Nilai properti

cassandraClusters

Nama Deskripsi Nilai
jenis Jenis sumber daya "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"
nama Nama sumber daya string (diperlukan)
lokasi Lokasi grup sumber daya tempat sumber daya berada. string
parent_id Untuk menyebarkan ke grup sumber daya, gunakan ID grup sumber daya tersebut. string (diperlukan)
tag Tag adalah daftar pasangan kunci-nilai yang menjelaskan sumber daya. Tag ini dapat digunakan dalam melihat dan mengelompokkan sumber daya ini (di seluruh grup sumber daya). Maksimal 15 tag dapat disediakan untuk sumber daya. Setiap tag harus memiliki kunci yang tidak lebih besar dari 128 karakter dan nilai tidak lebih besar dari 256 karakter. Misalnya, pengalaman default untuk jenis templat diatur dengan "defaultExperience": "Cassandra". Nilai "defaultExperience" saat ini juga mencakup "Table", "Graph", "DocumentDB", dan "MongoDB". Kamus nama dan nilai tag.
identity Identitas untuk sumber daya. ManagedCassandraManagedServiceIdentity
properti Properti kluster Cassandra terkelola. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nama Deskripsi Nilai
jenis Jenis sumber daya. "SystemAssigned"

ClusterResourceProperties

Nama Deskripsi Nilai
authenticationMethod Metode autentikasi mana yang harus digunakan Cassandra untuk mengautentikasi klien. 'Tidak ada' menonaktifkan autentikasi, jadi tidak boleh digunakan kecuali dalam keadaan darurat. 'Cassandra' adalah autentikasi berbasis kata sandi default. Defaultnya adalah 'Cassandra'. "Cassandra"
"Ldap"
"Tidak Ada"
backupSchedules Daftar jadwal pencadangan yang menentukan kapan Anda ingin mencadangkan data Anda. BackupSchedule[]
cassandraAuditLoggingEnabled Apakah pengelogan audit Cassandra diaktifkan bool
cassandraVersion Versi Cassandra mana yang harus digabungkan dengan kluster ini untuk berjalan (misalnya, 3.11). Saat diperbarui, kluster mungkin membutuhkan waktu untuk bermigrasi ke versi baru. string
clientCertificates Daftar sertifikat TLS yang digunakan untuk mengotorisasi klien yang terhubung ke kluster. Semua koneksi dienkripsi TLS baik clientCertificates diatur atau tidak, tetapi jika clientCertificates diatur, kluster Cassandra terkelola akan menolak semua koneksi yang tidak menyandang sertifikat klien TLS yang dapat divalidasi dari satu atau beberapa sertifikat publik di properti ini. Sertifikat[]
clusterNameOverride Jika Anda perlu mengatur properti clusterName di cassandra.yaml ke sesuatu selain nama sumber daya kluster, atur nilai yang akan digunakan pada properti ini. string
clusterType Jenis kluster. Jika diatur ke Produksi, beberapa operasi mungkin tidak diizinkan pada kluster. "NonProduksi"
“Produksi”
batal dialokasikan Apakah kluster dan pusat data terkait telah dibatalkan alokasinya. bool
delegatedManagementSubnetId Id sumber daya subnet yang harus dilampirkan oleh layanan manajemen kluster ini. Subnet harus dapat dirutekan ke semua subnet yang akan didelegasikan ke pusat data. Id sumber daya harus berupa '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' string
extensions Ekstensi yang akan ditambahkan atau diperbarui pada kluster. string[]
externalGossipCertificates Daftar sertifikat TLS yang digunakan untuk mengotorisasi gosip dari pusat data yang tidak dikelola. Sertifikat TLS dari semua simpul di pusat data yang tidak dikelola harus dapat diverifikasi menggunakan salah satu sertifikat yang disediakan di properti ini. Sertifikat[]
externalSeedNodes Daftar alamat IP node benih di pusat data yang tidak dikelola. Ini akan ditambahkan ke daftar node seed dari semua node terkelola. SeedNode[]
hoursBetweenBackups (Tidak digunakan lagi) Jumlah jam untuk menunggu antara mengambil cadangan kluster. int
initialCassandraAdminPassword Kata sandi awal untuk klien yang terhubung sebagai admin ke kluster. Harus diubah setelah pembuatan kluster. Mengembalikan null pada GET. Bidang ini hanya berlaku ketika bidang authenticationMethod adalah 'Cassandra'. string

Batasan:
Nilai sensitif. Teruskan sebagai parameter aman.
prometheusEndpoint Nama host atau alamat IP tempat titik akhir Prometheus yang berisi data tentang simpul Cassandra terkelola dapat dicapai. SeedNode
provisionError Kesalahan yang terkait dengan provisi sumber daya. CassandraError
provisioningState Status sumber daya pada saat operasi dipanggil. "Dibatalkan"
"Membuat"
"Menghapus"
"Gagal"
"Berhasil"
"Memperbarui"
repairEnabled Haruskah perbaikan otomatis berjalan pada kluster ini? Jika dihilangkan, ini benar, dan harus tetap benar kecuali Anda menjalankan kluster hibrid di mana Anda sudah melakukan perbaikan Anda sendiri. bool
restoreFromBackupId Untuk membuat kluster kosong, hilangkan bidang ini atau atur ke null. Untuk memulihkan cadangan ke kluster baru, atur bidang ini ke id sumber daya cadangan. string

BackupSchedule

Nama Deskripsi Nilai
cronExpression Ekspresi cron yang menentukan kapan Anda ingin mencadangkan data Anda. string
retentionInHours Periode retensi (jam) cadangan. Jika Anda ingin menyimpan data selamanya, atur retensi ke 0. int
scheduleName Pengidentifikasi unik jadwal pencadangan. string

Sertifikat

Nama Deskripsi Nilai
Pem Kunci publik yang diformat PEM. string

SeedNode

Nama Deskripsi Nilai
ipAddress Alamat IP dari node seed ini. string

CassandraError

Nama Deskripsi Nilai
additionalErrorInfo Informasi tambahan tentang kesalahan. string
kode Kode kesalahan yang terjadi. string
pesan Pesan kesalahan. string
target Sumber daya target kesalahan. string