Microsoft.DocumentDB cassandraClusters 2023-11-15
- Najnowsza
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-04-01-preview
- 2021-03-01-preview
Definicja zasobu Bicep
Typ zasobu cassandraClusters można wdrożyć z operacjami docelowymi:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/cassandraClusters, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-11-15' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
type: 'string'
}
properties: {
authenticationMethod: 'string'
cassandraAuditLoggingEnabled: bool
cassandraVersion: 'string'
clientCertificates: [
{
pem: 'string'
}
]
clusterNameOverride: 'string'
deallocated: bool
delegatedManagementSubnetId: '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'
}
}
Wartości właściwości
cassandraClusters
| Nazwa | Opis | Wartość |
|---|---|---|
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| identity | Tożsamość zasobu. | ManagedCassandraManagedServiceIdentity |
| properties | Właściwości zarządzanego klastra Cassandra. | ClusterResourceProperties |
ManagedCassandraManagedServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu. | "Brak" "SystemAssigned" |
ClusterResourceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Authenticationmethod | Której metody uwierzytelniania system Cassandra powinien używać do uwierzytelniania klientów. Opcja "Brak" wyłącza uwierzytelnianie, dlatego nie należy jej używać z wyjątkiem sytuacji awaryjnych. "Cassandra" to domyślne uwierzytelnianie oparte na hasłach. Wartość domyślna to "Cassandra". | "Cassandra" "Ldap" "Brak" |
| cassandraAuditLoggingEnabled | Czy rejestrowanie inspekcji cassandra jest włączone | bool |
| cassandraVersion | Która wersja systemu Cassandra powinna być zbieżna z działaniem tego klastra (np. 3.11). Po zaktualizowaniu klaster może zająć trochę czasu na migrację do nowej wersji. | ciąg |
| Clientcertificates | Lista certyfikatów TLS używanych do autoryzowania klientów łączących się z klastrem. Wszystkie połączenia są szyfrowane przy użyciu protokołu TLS niezależnie od tego, czy właściwość clientCertificates jest ustawiona, ale jeśli parametr clientCertificates jest ustawiony, zarządzany klaster Cassandra odrzuci wszystkie połączenia, które nie mają certyfikatu klienta TLS, który można zweryfikować z co najmniej jednego certyfikatu publicznego w tej właściwości. | Certyfikat[] |
| clusterNameOverride | Jeśli musisz ustawić właściwość clusterName w pliku cassandra.yaml na wartość inną niż nazwa zasobu klastra, ustaw wartość do użycia w tej właściwości. | ciąg |
| Dealokowane | Czy przydział klastra i skojarzonych centrów danych został cofnięty. | bool |
| delegatedManagementSubnetId | Identyfikator zasobu podsieci, do którego powinna być dołączona usługa zarządzania tego klastra. Podsieć musi być routingowa do wszystkich podsieci, które zostaną delegowane do centrów danych. Identyfikator zasobu musi mieć postać "/subscriptions/{subscriptions/{subscription id}/resourceGroups/{resource Group}/providers/Microsoft.Network/virtualNetworks/{virtual Network}/subnets/{subnet}" | ciąg |
| externalGossipCertificates | Lista certyfikatów TLS używanych do autoryzowania plotek z niezarządzanych centrów danych. Certyfikaty TLS wszystkich węzłów w niezarządzanych centrach danych muszą być weryfikowalne przy użyciu jednego z certyfikatów podanych w tej właściwości. | Certyfikat[] |
| externalSeedNodes | Lista adresów IP węzłów inicjacyjnych w niezarządzanych centrach danych. Zostaną one dodane do list węzłów podrzędnych wszystkich węzłów zarządzanych. | SeedNode[] |
| hoursBetweenBackups | (Przestarzałe) Liczba godzin oczekiwania między wykonaniem kopii zapasowej klastra. | int |
| initialCassandraAdminPassword | Początkowe hasło dla klientów łączących się jako administrator z klastrem. Należy zmienić po utworzeniu klastra. Zwraca wartość null dla polecenia GET. To pole ma zastosowanie tylko wtedy, gdy pole authenticationMethod ma wartość "Cassandra". | ciąg Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| prometheusEndpoint | Nazwa hosta lub adres IP, w którym można uzyskać dostęp do punktu końcowego Prometheus zawierającego dane dotyczące zarządzanych węzłów Cassandra. | SeedNode |
| provisionError | Błąd związany z aprowizowaniem zasobów. | CassandraError |
| provisioningState | Stan zasobu w momencie wywołania operacji. | "Anulowano" "Tworzenie" "Usuwanie" "Niepowodzenie" "Powodzenie" "Aktualizowanie" |
| repairEnabled | Czy automatyczne naprawy powinny być uruchamiane w tym klastrze? Jeśli pominięto, jest to prawdą i powinno pozostać prawdziwe, chyba że korzystasz z klastra hybrydowego, w którym już wykonujesz własne naprawy. | bool |
| restoreFromBackupId | Aby utworzyć pusty klaster, pomiń to pole lub ustaw go na wartość null. Aby przywrócić kopię zapasową do nowego klastra, ustaw to pole na identyfikator zasobu kopii zapasowej. | ciąg |
Certyfikat
| Nazwa | Opis | Wartość |
|---|---|---|
| Pem | Klucz publiczny w formacie PEM. | ciąg |
SeedNode
| Nazwa | Opis | Wartość |
|---|---|---|
| Ipaddress | Adres IP tego węzła inicjowania. | ciąg |
CassandraError
| Nazwa | Opis | Wartość |
|---|---|---|
| additionalErrorInfo | Dodatkowe informacje o błędzie. | ciąg |
| kod | Kod błędu, który wystąpił. | ciąg |
| message | Komunikat o błędzie. | ciąg |
| Docelowego | Zasób docelowy błędu. | ciąg |
Definicja zasobu szablonu usługi ARM
Typ zasobu cassandraClusters można wdrożyć przy użyciu operacji docelowych:
- Grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/cassandraClusters, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.DocumentDB/cassandraClusters",
"apiVersion": "2023-11-15",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"type": "string"
},
"properties": {
"authenticationMethod": "string",
"cassandraAuditLoggingEnabled": "bool",
"cassandraVersion": "string",
"clientCertificates": [
{
"pem": "string"
}
],
"clusterNameOverride": "string",
"deallocated": "bool",
"delegatedManagementSubnetId": "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"
}
}
Wartości właściwości
cassandraClusters
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.DocumentDB/cassandraClusters" |
| apiVersion | Wersja interfejsu API zasobów | '2023-11-15' |
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. Zobacz Tagi w szablonach |
| identity | Tożsamość zasobu. | ManagedCassandraManagedServiceIdentity |
| properties | Właściwości zarządzanego klastra Cassandra. | ClusterResourceProperties |
ManagedCassandraManagedServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu. | "Brak" "SystemAssigned" |
ClusterResourceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Authenticationmethod | Której metody uwierzytelniania system Cassandra powinien używać do uwierzytelniania klientów. Opcja "Brak" wyłącza uwierzytelnianie, dlatego nie należy jej używać z wyjątkiem sytuacji awaryjnych. "Cassandra" to domyślne uwierzytelnianie oparte na hasłach. Wartość domyślna to "Cassandra". | "Cassandra" "Ldap" "Brak" |
| cassandraAuditLoggingEnabled | Czy rejestrowanie inspekcji cassandra jest włączone | bool |
| cassandraVersion | Która wersja systemu Cassandra powinna być zbieżna z działaniem tego klastra (np. 3.11). Po zaktualizowaniu klaster może zająć trochę czasu na migrację do nowej wersji. | ciąg |
| Clientcertificates | Lista certyfikatów TLS używanych do autoryzowania klientów łączących się z klastrem. Wszystkie połączenia są szyfrowane przy użyciu protokołu TLS niezależnie od tego, czy właściwość clientCertificates jest ustawiona, ale jeśli parametr clientCertificates jest ustawiony, zarządzany klaster Cassandra odrzuci wszystkie połączenia, które nie mają certyfikatu klienta TLS, który można zweryfikować z co najmniej jednego certyfikatu publicznego w tej właściwości. | Certyfikat[] |
| clusterNameOverride | Jeśli musisz ustawić właściwość clusterName w pliku cassandra.yaml na wartość inną niż nazwa zasobu klastra, ustaw wartość do użycia w tej właściwości. | ciąg |
| Dealokowane | Czy przydział klastra i skojarzonych centrów danych został cofnięty. | bool |
| delegatedManagementSubnetId | Identyfikator zasobu podsieci, do którego powinna być dołączona usługa zarządzania tego klastra. Podsieć musi być routingowa do wszystkich podsieci, które będą delegowane do centrów danych. Identyfikator zasobu musi mieć postać "/subscriptions/{subscriptions}/resourceGroups/{resource Group}/providers/Microsoft.Network/virtualNetworks/{virtualNetworks/{virtual network}/subnets/{subnet}" | ciąg |
| externalGossipCertificates | Lista certyfikatów TLS używanych do autoryzowania plotek z niezarządzanych centrów danych. Certyfikaty TLS wszystkich węzłów w niezarządzanych centrach danych muszą być weryfikowalne przy użyciu jednego z certyfikatów podanych w tej właściwości. | Certyfikat[] |
| externalSeedNodes | Lista adresów IP węzłów inicjacyjnych w niezarządzanych centrach danych. Zostaną one dodane do list węzłów inicjowania wszystkich węzłów zarządzanych. | SeedNode[] |
| hoursBetweenBackups | (Przestarzałe) Liczba godzin oczekiwania między wykonaniem kopii zapasowej klastra. | int |
| initialCassandraAdminPassword | Początkowe hasło dla klientów łączących się jako administrator z klastrem. Należy zmienić po utworzeniu klastra. Zwraca wartość null dla polecenia GET. To pole ma zastosowanie tylko wtedy, gdy pole authenticationMethod ma wartość "Cassandra". | ciąg Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| prometheusEndpoint | Nazwa hosta lub adres IP, w którym można uzyskać dostęp do punktu końcowego Rozwiązania Prometheus zawierającego dane dotyczące zarządzanych węzłów Cassandra. | SeedNode |
| provisionError | Błąd związany z aprowizowaniem zasobów. | CassandraError |
| provisioningState | Stan zasobu w momencie wywołania operacji. | "Anulowano" "Tworzenie" "Usuwanie" "Niepowodzenie" "Powodzenie" "Aktualizowanie" |
| repairEnabled | Czy w tym klastrze powinny być uruchamiane automatyczne naprawy? W przypadku pominięcia jest to prawda i powinno pozostać prawdziwe, chyba że korzystasz z klastra hybrydowego, w którym już wykonujesz własne naprawy. | bool |
| restoreFromBackupId | Aby utworzyć pusty klaster, pomiń to pole lub ustaw je na wartość null. Aby przywrócić kopię zapasową do nowego klastra, ustaw to pole na identyfikator zasobu kopii zapasowej. | ciąg |
Certyfikat
| Nazwa | Opis | Wartość |
|---|---|---|
| Pem | Klucz publiczny sformatowany przez PEM. | ciąg |
SeedNode
| Nazwa | Opis | Wartość |
|---|---|---|
| Ipaddress | Adres IP tego węzła inicjowania. | ciąg |
CassandraError
| Nazwa | Opis | Wartość |
|---|---|---|
| additionalErrorInfo | Dodatkowe informacje o błędzie. | ciąg |
| kod | Kod błędu, który wystąpił. | ciąg |
| message | Komunikat o błędzie. | ciąg |
| Docelowego | Zasób docelowy błędu. | ciąg |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu cassandraClusters można wdrożyć z operacjami docelowymi:
- Grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.
Format zasobu
Aby utworzyć zasób Microsoft.DocumentDB/cassandraClusters, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/cassandraClusters@2023-11-15"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
authenticationMethod = "string"
cassandraAuditLoggingEnabled = bool
cassandraVersion = "string"
clientCertificates = [
{
pem = "string"
}
]
clusterNameOverride = "string"
deallocated = bool
delegatedManagementSubnetId = "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"
}
})
}
Wartości właściwości
cassandraClusters
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu | "Microsoft.DocumentDB/cassandraClusters@2023-11-15" |
| name | Nazwa zasobu | ciąg (wymagany) |
| location | Lokalizacja grupy zasobów, do której należy zasób. | ciąg |
| parent_id | Aby przeprowadzić wdrożenie w grupie zasobów, użyj identyfikatora tej grupy zasobów. | ciąg (wymagany) |
| tags | Tagi to lista par klucz-wartość, które opisują zasób. Te tagi mogą służyć do wyświetlania i grupowania tego zasobu (między grupami zasobów). Dla zasobu można podać maksymalnie 15 tagów. Każdy tag musi mieć klucz nie większy niż 128 znaków i wartość nie większą niż 256 znaków. Na przykład domyślne środowisko dla typu szablonu jest ustawiane z wartością "defaultExperience": "Cassandra". Bieżące wartości "defaultExperience" obejmują również wartości "Table", "Graph", "DocumentDB" i "MongoDB". | Słownik nazw tagów i wartości. |
| identity | Tożsamość zasobu. | ManagedCassandraManagedServiceIdentity |
| properties | Właściwości zarządzanego klastra Cassandra. | ClusterResourceProperties |
ManagedCassandraManagedServiceIdentity
| Nazwa | Opis | Wartość |
|---|---|---|
| typ | Typ zasobu. | "SystemAssigned" |
ClusterResourceProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| Authenticationmethod | Której metody uwierzytelniania system Cassandra powinien używać do uwierzytelniania klientów. Opcja "Brak" wyłącza uwierzytelnianie, dlatego nie należy jej używać z wyjątkiem sytuacji awaryjnych. "Cassandra" to domyślne uwierzytelnianie oparte na hasłach. Wartość domyślna to "Cassandra". | "Cassandra" "Ldap" "Brak" |
| cassandraAuditLoggingEnabled | Czy rejestrowanie inspekcji cassandra jest włączone | bool |
| cassandraVersion | Która wersja systemu Cassandra powinna być zbieżna z działaniem tego klastra (np. 3.11). Po zaktualizowaniu klaster może zająć trochę czasu na migrację do nowej wersji. | ciąg |
| Clientcertificates | Lista certyfikatów TLS używanych do autoryzowania klientów łączących się z klastrem. Wszystkie połączenia są szyfrowane przy użyciu protokołu TLS niezależnie od tego, czy właściwość clientCertificates jest ustawiona, ale jeśli parametr clientCertificates jest ustawiony, zarządzany klaster Cassandra odrzuci wszystkie połączenia, które nie mają certyfikatu klienta TLS, który można zweryfikować z co najmniej jednego certyfikatu publicznego w tej właściwości. | Certyfikat[] |
| clusterNameOverride | Jeśli musisz ustawić właściwość clusterName w pliku cassandra.yaml na wartość inną niż nazwa zasobu klastra, ustaw wartość do użycia w tej właściwości. | ciąg |
| Dealokowane | Czy przydział klastra i skojarzonych centrów danych został cofnięty. | bool |
| delegatedManagementSubnetId | Identyfikator zasobu podsieci, do którego powinna być dołączona usługa zarządzania tego klastra. Podsieć musi być routingowa do wszystkich podsieci, które zostaną delegowane do centrów danych. Identyfikator zasobu musi mieć postać "/subscriptions/{subscriptions/{subscription id}/resourceGroups/{resource Group}/providers/Microsoft.Network/virtualNetworks/{virtual Network}/subnets/{subnet}" | ciąg |
| externalGossipCertificates | Lista certyfikatów TLS używanych do autoryzowania plotek z niezarządzanych centrów danych. Certyfikaty TLS wszystkich węzłów w niezarządzanych centrach danych muszą być weryfikowalne przy użyciu jednego z certyfikatów podanych w tej właściwości. | Certyfikat[] |
| externalSeedNodes | Lista adresów IP węzłów inicjacyjnych w niezarządzanych centrach danych. Zostaną one dodane do list węzłów podrzędnych wszystkich węzłów zarządzanych. | SeedNode[] |
| hoursBetweenBackups | (Przestarzałe) Liczba godzin oczekiwania między wykonaniem kopii zapasowej klastra. | int |
| initialCassandraAdminPassword | Początkowe hasło dla klientów łączących się jako administrator z klastrem. Należy zmienić po utworzeniu klastra. Zwraca wartość null dla polecenia GET. To pole ma zastosowanie tylko wtedy, gdy pole authenticationMethod ma wartość "Cassandra". | ciąg Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| prometheusEndpoint | Nazwa hosta lub adres IP, w którym można uzyskać dostęp do punktu końcowego Prometheus zawierającego dane dotyczące zarządzanych węzłów Cassandra. | SeedNode |
| provisionError | Błąd związany z aprowizowaniem zasobów. | CassandraError |
| provisioningState | Stan zasobu w momencie wywołania operacji. | "Anulowano" "Tworzenie" "Usuwanie" "Niepowodzenie" "Powodzenie" "Aktualizowanie" |
| repairEnabled | Czy automatyczne naprawy powinny być uruchamiane w tym klastrze? Jeśli pominięto, jest to prawdą i powinno pozostać prawdziwe, chyba że korzystasz z klastra hybrydowego, w którym już wykonujesz własne naprawy. | bool |
| restoreFromBackupId | Aby utworzyć pusty klaster, pomiń to pole lub ustaw go na wartość null. Aby przywrócić kopię zapasową do nowego klastra, ustaw to pole na identyfikator zasobu kopii zapasowej. | ciąg |
Certyfikat
| Nazwa | Opis | Wartość |
|---|---|---|
| Pem | Klucz publiczny w formacie PEM. | ciąg |
SeedNode
| Nazwa | Opis | Wartość |
|---|---|---|
| Ipaddress | Adres IP tego węzła inicjowania. | ciąg |
CassandraError
| Nazwa | Opis | Wartość |
|---|---|---|
| additionalErrorInfo | Dodatkowe informacje o błędzie. | ciąg |
| kod | Kod błędu, który wystąpił. | ciąg |
| message | Komunikat o błędzie. | ciąg |
| Docelowego | Zasób docelowy błędu. | ciąg |