Microsoft.DocumentDB cassandraClusters 2021-03-01-preview
- Terbaru
- 2024-05-15
- Pratinjau 05-05-2024
- Pratinjau 2024-02-15
- 2023-11-15
- Pratinjau 11-15 2023
- 2023-09-15
- Pratinjau 2023-09-15
- 2023-04-15
- 2023-03-15
- Pratinjau 2023-03-15
- Pratinjau 01-03-2023
- 2022-11-15
- Pratinjau 11-15 2022
- 2022-08-15
- 15-08-2022-pratinjau
- 2022-05-15
- 2022-05-15-pratinjau
- Pratinjau 2022-02-15
- Pratinjau 11-15 2021
- 2021-10-15
- Pratinjau 10-15 2021
- Pratinjau 01-07-2021
- Pratinjau 01-04-2021
- Pratinjau 01-03-2021
Definisi sumber daya Bicep
Jenis sumber daya cassandraClusters dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran 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 Bicep berikut ke templat Anda.
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2021-03-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
properties: {
authenticationMethod: 'string'
cassandraVersion: 'string'
clientCertificates: [
{
pem: 'string'
}
]
clusterNameOverride: 'string'
delegatedManagementSubnetId: 'string'
externalGossipCertificates: [
{
pem: 'string'
}
]
externalSeedNodes: [
{
ipAddress: 'string'
}
]
hoursBetweenBackups: int
initialCassandraAdminPassword: 'string'
prometheusEndpoint: {
ipAddress: '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. | ManagedServiceIdentity |
| properti | Properti kluster Cassandra terkelola. | ClusterResourceProperties |
ManagedServiceIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan. | 'Tidak Ada' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nama | Deskripsi | Nilai |
|---|---|---|
| {customized property} | Komponen1Jq1T4ISchemasManagedserviceidentityProper... |
Komponen1Jq1T4ISchemasManagedserviceidentityProper...
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
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' 'Tidak Ada' |
| 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 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 |
| 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 |
| 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 | Jumlah jam untuk menunggu antara mengambil cadangan kluster. Untuk menonaktifkan pencadangan, atur properti ini ke 0. | 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 |
| 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 |
Sertifikat
| Nama | Deskripsi | Nilai |
|---|---|---|
| Pem | Kunci publik yang diformat PEM. | string |
SeedNode
| Nama | Deskripsi | Nilai |
|---|---|---|
| ipAddress | Alamat IP dari node seed ini. | string |
Definisi sumber daya templat ARM
Jenis sumber daya cassandraClusters dapat disebarkan dengan operasi yang menargetkan:
- Grup sumber daya - Lihat perintah penyebaran grup sumber daya
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": "2021-03-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {}
}
},
"properties": {
"authenticationMethod": "string",
"cassandraVersion": "string",
"clientCertificates": [
{
"pem": "string"
}
],
"clusterNameOverride": "string",
"delegatedManagementSubnetId": "string",
"externalGossipCertificates": [
{
"pem": "string"
}
],
"externalSeedNodes": [
{
"ipAddress": "string"
}
],
"hoursBetweenBackups": "int",
"initialCassandraAdminPassword": "string",
"prometheusEndpoint": {
"ipAddress": "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 | '2021-03-01-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. | ManagedServiceIdentity |
| properti | Properti kluster Cassandra terkelola. | ClusterResourceProperties |
ManagedServiceIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan. | 'Tidak Ada' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
| userAssignedIdentities | Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | ManagedServiceIdentityUserAssignedIdentities |
ManagedServiceIdentityUserAssignedIdentities
| Nama | Deskripsi | Nilai |
|---|---|---|
| {customized property} | Komponen1Jq1T4ISchemasManagedserviceidentityProper... |
Komponen1Jq1T4ISchemasManagedserviceidentityProper...
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
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' 'Tidak Ada' |
| 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 |
| 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 |
| 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 | Jumlah jam untuk menunggu antara mengambil cadangan kluster. Untuk menonaktifkan cadangan, atur properti ini ke 0. | 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 |
| 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 |
Sertifikat
| Nama | Deskripsi | Nilai |
|---|---|---|
| Pem | Kunci publik yang diformat PEM. | string |
SeedNode
| Nama | Deskripsi | Nilai |
|---|---|---|
| ipAddress | Alamat IP dari node seed ini. | 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 mengubah log.
Format sumber daya
Untuk membuat sumber daya Microsoft.DocumentDB/cassandraClusters, tambahkan Terraform berikut ke templat Anda.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/cassandraClusters@2021-03-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
authenticationMethod = "string"
cassandraVersion = "string"
clientCertificates = [
{
pem = "string"
}
]
clusterNameOverride = "string"
delegatedManagementSubnetId = "string"
externalGossipCertificates = [
{
pem = "string"
}
]
externalSeedNodes = [
{
ipAddress = "string"
}
]
hoursBetweenBackups = int
initialCassandraAdminPassword = "string"
prometheusEndpoint = {
ipAddress = "string"
}
provisioningState = "string"
repairEnabled = bool
restoreFromBackupId = "string"
}
})
}
Nilai properti
cassandraClusters
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis sumber daya | "Microsoft.DocumentDB/cassandraClusters@2021-03-01-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 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. |
| identitas | Identitas untuk sumber daya. | ManagedServiceIdentity |
| properti | Properti kluster Cassandra terkelola. | ClusterResourceProperties |
ManagedServiceIdentity
| Nama | Deskripsi | Nilai |
|---|---|---|
| jenis | Jenis identitas yang digunakan untuk sumber daya. Jenis 'SystemAssigned,UserAssigned' mencakup identitas yang dibuat secara implisit dan sekumpulan identitas yang ditetapkan pengguna. Jenis 'Tidak Ada' akan menghapus identitas apa pun dari layanan. | "SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" |
| identity_ids | Daftar identitas pengguna yang terkait dengan sumber daya. Referensi kunci kamus identitas pengguna akan menjadi id sumber daya ARM dalam formulir: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. | Array ID identitas pengguna. |
ManagedServiceIdentityUserAssignedIdentities
| Nama | Deskripsi | Nilai |
|---|---|---|
| {properti yang disesuaikan} | Komponen1Jq1T4ISchemasManagedserviceidentityProper... |
Komponen1Jq1T4ISchemasManagedserviceidentityProper...
Objek ini tidak berisi properti apa pun untuk diatur selama penyebaran. Semua properti adalah ReadOnly.
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" "Tidak Ada" |
| 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 |
| 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 |
| 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 | Jumlah jam untuk menunggu antara mengambil cadangan kluster. Untuk menonaktifkan pencadangan, atur properti ini ke 0. | 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 |
| 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 |
Sertifikat
| Nama | Deskripsi | Nilai |
|---|---|---|
| Pem | Kunci publik yang diformat PEM. | string |
SeedNode
| Nama | Deskripsi | Nilai |
|---|---|---|
| ipAddress | Alamat IP dari node seed ini. | string |